Rework the help system. For now, this is mostly a no-op (it only re-organise the help entries), but later, that may come in handy when we want ct-ng to be installable).
author"Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Sun Jun 17 16:24:23 2007 +0000 (2007-06-17)
changeset 17659676cfb4ada
parent 175 043e44606e28
child 177 60e62e0a90e2
Rework the help system. For now, this is mostly a no-op (it only re-organise the help entries), but later, that may come in handy when we want ct-ng to be installable).
Makefile
kconfig/Makefile
samples/Makefile
tools/Makefile
     1.1 --- a/Makefile	Sun Jun 17 15:46:13 2007 +0000
     1.2 +++ b/Makefile	Sun Jun 17 16:24:23 2007 +0000
     1.3 @@ -17,32 +17,54 @@
     1.4  
     1.5  HOST_CC = gcc -funsigned-char
     1.6  
     1.7 -help::
     1.8 +# Help system
     1.9 +help:: help-head help-config help-samples help-build help-distrib help-env help-tail
    1.10 +
    1.11 +help-head::
    1.12  	@echo  'Available make targets:'
    1.13 +
    1.14 +help-config::
    1.15  	@echo
    1.16 +	@echo  'Configuration targets:'
    1.17 +
    1.18 +help-samples::
    1.19 +	@echo
    1.20 +	@echo  'Preconfigured targets:'
    1.21 +
    1.22 +help-build::
    1.23 +	@echo
    1.24 +	@echo  'Build targets:'
    1.25 +
    1.26 +help-distrib::
    1.27 +	@echo
    1.28 +	@echo  'Distribution targets:'
    1.29 +
    1.30 +help-env::
    1.31 +	@echo
    1.32 +	@echo  'Environement variables (see docs/overview.txt):'
    1.33 +
    1.34 +help-tail::
    1.35 +	@echo
    1.36 +	@echo  'Execute "make" or "make all" to build all targets marked with [*]'
    1.37 +
    1.38 +# End help system
    1.39 +
    1.40 +help-build::
    1.41 +	@echo  '* build          - Build the toolchain'
    1.42 +	@echo  '  clean          - Remove generated files'
    1.43 +	@echo  '  distclean      - Remove generated files, configuration and build directories'
    1.44  
    1.45  include $(CT_TOP_DIR)/kconfig/Makefile
    1.46  include $(CT_TOP_DIR)/samples/Makefile
    1.47 -
    1.48 -help::
    1.49 -	@echo  'Build targets:'
    1.50 -	@echo  '* build          - Build the toolchain'
    1.51 -	@echo  '  regtest        - Regtest-build all samples'
    1.52 -	@echo  '  clean          - Remove generated files'
    1.53 -	@echo  '  distclean      - Remove generated files, configuration and build directories'
    1.54 -
    1.55  include $(CT_TOP_DIR)/tools/Makefile
    1.56  include $(CT_TOP_DIR)/Makefile.steps
    1.57  
    1.58 -help::
    1.59 -	@echo  'Distribution targets:'
    1.60 +help-distrib::
    1.61  	@echo  '  tarball        - Build a tarball of the configured toolchain'
    1.62 -	@echo  ''
    1.63 -	@echo  'Environement variables (see docs/overview.txt):'
    1.64 +
    1.65 +help-env::
    1.66  	@echo  '  STOP           - Stop the build just after this step'
    1.67  	@echo  '  RESTART        - Restart the build just before this step'
    1.68 -	@echo  ''
    1.69 -	@echo  'Execute "make" or "make all" to build all targets marked with [*]'
    1.70  
    1.71  .config:
    1.72  	@echo "You must run either one of \"make config\" or \"make menuconfig\" first"
     2.1 --- a/kconfig/Makefile	Sun Jun 17 15:46:13 2007 +0000
     2.2 +++ b/kconfig/Makefile	Sun Jun 17 16:24:23 2007 +0000
     2.3 @@ -58,14 +58,10 @@
     2.4  	@yes "" |$< -s $(KCONFIG_TOP) >/dev/null
     2.5  
     2.6  # Help text used by make help
     2.7 -help::
     2.8 -	@echo  'General purpose configuration targets:'
     2.9 +help-config::
    2.10  	@echo  '  config         - Update current config using a line-oriented program'
    2.11  	@echo  '  menuconfig     - Update current config using a menu based program'
    2.12  	@echo  '  oldconfig      - Update current config using a provided .config as base'
    2.13 -	@# saveconfig is listed here for homogeneity, but implemented in samples/Makefile
    2.14 -	@echo  '  saveconfig     - Save current config as a preconfigured target'
    2.15 -	@echo  ''
    2.16  
    2.17  # Cheesy build
    2.18  
     3.1 --- a/samples/Makefile	Sun Jun 17 15:46:13 2007 +0000
     3.2 +++ b/samples/Makefile	Sun Jun 17 16:24:23 2007 +0000
     3.3 @@ -3,10 +3,14 @@
     3.4  # Build the list of available samples
     3.5  CT_SAMPLES = $(patsubst $(CT_TOP_DIR)/samples/%/crosstool.config,%,$(wildcard $(CT_TOP_DIR)/samples/*/crosstool.config))
     3.6  
     3.7 -help::
     3.8 -	@echo  'Preconfigured targets:'
     3.9 +help-config::
    3.10 +	@echo  '  saveconfig     - Save current config as a preconfigured target'
    3.11 +
    3.12 +help-samples::
    3.13  	@$(CT_TOP_DIR)/scripts/showSamples.sh $(CT_SAMPLES)
    3.14 -	@echo  ''
    3.15 +
    3.16 +help-build::
    3.17 +	@echo  '  regtest        - Regtest-build all samples'
    3.18  
    3.19  # How we do build one sample
    3.20  .PHONY: $(CT_SAMPLES)
     4.1 --- a/tools/Makefile	Sun Jun 17 15:46:13 2007 +0000
     4.2 +++ b/tools/Makefile	Sun Jun 17 16:24:23 2007 +0000
     4.3 @@ -7,6 +7,5 @@
     4.4  	@wget "$(CONFIG_SUB_SRC)" -O "$(CONFIG_SUB_DEST)"
     4.5  	@wget "$(CONFIG_GUESS_SRC)" -O "$(CONFIG_GUESS_DEST)"
     4.6  
     4.7 -help::
     4.8 +help-distrib::
     4.9  	@echo  '  updatetools    - Update the config tools'
    4.10 -	@echo  ''