Makefiles: Add / Update help for makefile targets

Currently running 'make help' just gives help for the kconfig targets.

This adds help for common coreboot and toolchain targets.  It stops
printing some of the less common kconfig targets, but still leaves
them in the makefile as documentation.

Change-Id: I2a00fcbc06f05dc4029a91f3dff830c19e4d1329
Signed-off-by: Martin Roth <martinroth@google.com>
Reviewed-on: https://review.coreboot.org/12458
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>

Makefile

@@ -93,6 +93,21 @@ DOXYGEN_OUTPUT_DIR := doxygen
 
 all: real-all
 
+help::
+	@echo  '*** coreboot platform ***'
+	@echo  '  Use "make [target] V=1" for extra build debug information'
+	@echo  '  all                   - Build coreboot'
+	@echo  '  clean                 - Remove coreboot build artifacts'
+	@echo  '  distclean             - Remove build artifacts and config files'
+	@echo  '  doxygen               - Build doxygen documentation for coreboot'
+	@echo  '  what-jenkins-does     - Run platform build tests (Use CPUS=# for more cores)'
+	@echo  '  printall              - print makefile info for debugging'
+	@echo  '  lint / lint-stable    - run coreboot lint tools (all / minimal)'
+	@echo  '  gitconfig             - set up git to subnit patches to coreboot'
+	@echo  '  ctags / ctags-project - make ctags file for all of coreboot or current board'
+	@echo  '  cscope / cscope-project - make cscope.out file for coreboot or current board'
+	@echo
+
 # This include must come _before_ the pattern rules below!
 # Order _does_ matter for pattern rules.
 include $(srck)/Makefile

Makefile.inc

@@ -446,6 +446,17 @@ gitconfig:
 	git config remote.origin.push HEAD:refs/for/master
 	(git config --global user.name >/dev/null && git config --global user.email >/dev/null) || (printf 'Please configure your name and email in git:\n\n git config --global user.name "Your Name Comes Here"\n git config --global user.email your.email@example.com\n'; exit 1)
 
+help::
+	@echo  '*** Toolchain ***'
+	@echo  '  crossgcc        - Build coreboot cross-compilers for all platforms'
+	@echo  '  crosstools      - Build coreboot cross-compiler and GDB for all platforms'
+	@echo  '  crossgcc-clean  - Remove all built coreboot cross-compilers'
+	@echo  '  crossgcc-ARCH   - Build cross-compiler for specific architecture'
+	@echo  '  crosstools-ARCH - Build cross-compiler with GDB for specific architecture'
+	@echo  '  ARCH can be "i386", "x64", "arm", "aarch64", "mips", or "riscv"'
+	@echo  '  Use "make [target] CPUS=#" to build toolchain using multiple cores'
+	@echo
+
 # For the toolchain builds, use CPUS=x to use multiple processors to build
 # use BUILDGCC_OPTIONS= to set any crossgcc command line options
 # Example: BUILDGCC_OPTIONS='-t' will keep temporary files after build

util/kconfig/Makefile

@@ -104,22 +104,24 @@ olddefconfig: $(objk)/conf
 	$< --defconfig=configs/$@ $(Kconfig)
 
 # Help text used by make help
-help:
+help::
+	@echo  '*** Kconfig Help ***'
 	@echo  '  config	  - Update current config utilising a line-oriented program'
 	@echo  '  nconfig         - Update current config utilising a ncurses menu based program'
 	@echo  '  menuconfig	  - Update current config utilising a menu based program'
 	@echo  '  xconfig	  - Update current config utilising a QT based front-end'
 	@echo  '  gconfig	  - Update current config utilising a GTK based front-end'
 	@echo  '  oldconfig	  - Update current config utilising a provided .config as base'
-	@echo  '  localmodconfig  - Update current config disabling modules not loaded'
+	#@echo  '  localmodconfig  - Update current config disabling modules not loaded'
-	@echo  '  localyesconfig  - Update current config converting local mods to core'
+	#@echo  '  localyesconfig  - Update current config converting local mods to core'
 	@echo  '  silentoldconfig - Same as oldconfig, but quietly, additionally update deps'
 	@echo  '  defconfig	  - New config with default answer to all options'
 	@echo  '  savedefconfig   - Save current config as ./defconfig (minimal config)'
-	@echo  '  allnoconfig	  - New config where all options are answered with no'
+	#@echo  '  allnoconfig	  - New config where all options are answered with no'
-	@echo  '  allyesconfig	  - New config where all options are accepted with yes'
+	#@echo  '  allyesconfig	  - New config where all options are accepted with yes'
-	@echo  '  allmodconfig	  - New config selecting modules when possible'
+	#@echo  '  allmodconfig	  - New config selecting modules when possible'
-	@echo  '  randconfig	  - New config with random answer to all options'
+	#@echo  '  randconfig	  - New config with random answer to all options'
+	@echo
 
 # lxdialog stuff
 check-lxdialog  := $(srck)/lxdialog/check-lxdialog.sh