From 3734dcd730936b58cdb0d99190199d1d8cceda7e Mon Sep 17 00:00:00 2001 From: Allan Blanchard <allan.blanchard@cea.fr> Date: Tue, 26 Jul 2022 16:22:17 +0200 Subject: [PATCH] [build] add Makefile help --- Makefile | 25 ++++++++++++++++++++++--- doc/Makefile | 11 ++++++++++- ivette/Makefile | 8 ++++++++ share/Makefile.installation | 8 ++++++++ 4 files changed, 48 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 6701dccd4cb..bff43dc1804 100644 --- a/Makefile +++ b/Makefile @@ -26,6 +26,10 @@ MAKECONFIG_DIR=share include share/Makefile.common +############################################################################## +# DUNE OPTIONS +################################ + DUNE_BUILD_OPTS?= RELEASE?=no @@ -39,15 +43,21 @@ endif DUNE_DISPLAY?=progress DUNE_BUILD_OPTS+=--display $(DUNE_DISPLAY) +############################################################################## # PTESTS SRC +################################ + FRAMAC_PTESTS_SRC:=tools/ptests +############################################################################## # HDRCK SRC +################################ + FRAMAC_HDRCK_SRC:=tools/hdrck -################### -# Frama-C Version # -################### +############################################################################## +# Frama-C +################################ .PHONY: all @@ -60,6 +70,15 @@ clean:: purge-tests # to be done before a "dune" command dune clean --root $(FRAMAC_HDRCK_SRC) rm -rf _build .merlin +############################################################################## +# HELP +################################ + +help:: + @echo "Build configuration variables" + @echo " - RELEASE: compile in release mode if set to 'yes'" + @echo " - DUNE_DISPLAY: parameter transmitted to dune --display option" + ############################################################################## # INSTALL/UNINSTALL ################################ diff --git a/doc/Makefile b/doc/Makefile index f9db594cac7..584d88aec76 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -32,7 +32,6 @@ FRAMAC_DOCDIR ?= $(DOCDIR)/frama-c .PHONY: .force - ################### # Frama-C Version # ################### @@ -200,3 +199,13 @@ acsl/acsl-implementation.pdf: | acsl/acsl.pdf $(EACSL_DOC)/refman/e-acsl-implementation.pdf: | $(EACSL_DOC)/refman/e-acsl.pdf endif + +############################################################################## +# HELP +################################ + +help:: + @echo "Documentation installation configuration variable" + @echo " - PREFIX: documentation will be in PREFIX/share/doc/frama-c" + @echo " - DOCDIR: (overrides previous variable) documentation will be in DOCDIR/frama-c" + @echo " - FRAMAC_DOCDIR: (overrides previous variable) documentation will be in FRAMAC_DOCDIR" diff --git a/ivette/Makefile b/ivette/Makefile index 05418ec12ed..afa38a1d866 100644 --- a/ivette/Makefile +++ b/ivette/Makefile @@ -60,6 +60,14 @@ tsc: dome-pkg dome-templ yarn run typecheck yarn run lint --fix --cache --cache-location .eslint-cache +# -------------------------------------------------------------------------- +# --- Help +# -------------------------------------------------------------------------- + +help:: + @echo "Ivette installation configuration variables" + @echo " - PREFIX: used to customize installation path" + # -------------------------------------------------------------------------- # --- Ivette Package Loader # -------------------------------------------------------------------------- diff --git a/share/Makefile.installation b/share/Makefile.installation index 4e89956359c..544db518ed7 100644 --- a/share/Makefile.installation +++ b/share/Makefile.installation @@ -24,6 +24,14 @@ # INSTALLATION # ################ +################################ +## Help + +help:: + @echo "Installation configuration variables" + @echo " - INSTALLDIR: used to customize installation path" + @echo " - MANDIR: used to customize man files installation path" + ################################ ## Default variables -- GitLab