[coreboot-gerrit] New patch to review for coreboot: Makefiles: Add / Update help for makefile targets

[Martin Roth (martinroth@google.com)]

Martin Roth (martinroth at google.com) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/12458

-gerrit

commit 5337c852b1138a39bc5760730f39eac81b7110ed
Author: Martin Roth <martinroth at google.com>
Date:   Wed Nov 18 13:09:23 2015 -0700

    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 at google.com>
---
 Makefile              | 15 +++++++++++++++
 Makefile.inc          | 11 +++++++++++
 util/kconfig/Makefile | 16 +++++++++-------
 3 files changed, 35 insertions(+), 7 deletions(-)

diff --git a/Makefile b/Makefile
index 107f3c8..00e0349 100644
--- a/Makefile
+++ b/Makefile
@@ -91,6 +91,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
diff --git a/Makefile.inc b/Makefile.inc
index b85a2cb..0f1e367 100644
--- a/Makefile.inc
+++ b/Makefile.inc
@@ -442,6 +442,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 at 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
+
 crossgcc: crossgcc-i386 crossgcc-x64 crossgcc-arm crossgcc-aarch64 crossgcc-mips crossgcc-riscv
 
 .PHONY: crossgcc-i386 crossgcc-x64 crossgcc-arm crossgcc-aarch64 crossgcc-mips crossgcc-riscv
diff --git a/util/kconfig/Makefile b/util/kconfig/Makefile
index 243f763..a468125 100644
--- a/util/kconfig/Makefile
+++ b/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  '  localyesconfig  - Update current config converting local mods to core'
+	#@echo  '  localmodconfig  - Update current config disabling modules not loaded'
+	#@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  '  allyesconfig	  - New config where all options are accepted with yes'
-	@echo  '  allmodconfig	  - New config selecting modules when possible'
-	@echo  '  randconfig	  - New config with random answer to all options'
+	#@echo  '  allnoconfig	  - New config where all options are answered with no'
+	#@echo  '  allyesconfig	  - New config where all options are accepted with yes'
+	#@echo  '  allmodconfig	  - New config selecting modules when possible'
+	#@echo  '  randconfig	  - New config with random answer to all options'
+	@echo
 
 # lxdialog stuff
 check-lxdialog  := $(srck)/lxdialog/check-lxdialog.sh