kbuild: Updated/moved around comments in top-level Makefile

Makefile

@@ -112,22 +112,8 @@ endif
 
 export KBUILD_MODULES KBUILD_BUILTIN KBUILD_VERBOSE KBUILD_CHECKSRC
 
-# Beautify output
-# ---------------------------------------------------------------------------
-#
-# Normally, we echo the whole command before executing it. By making
-# that echo $($(quiet)$(cmd)), we now have the possibility to set
-# $(quiet) to choose other forms of output instead, e.g.
-#
-#         quiet_cmd_cc_o_c = Compiling $(RELDIR)/$@
-#         cmd_cc_o_c       = $(CC) $(c_flags) -c -o $@ $<
-#
-# If $(quiet) is empty, the whole command will be printed.
-# If it is set to "quiet_", only the short version will be printed. 
-# If it is set to "silent_", nothing wil be printed at all, since
-# the variable $(silent_cmd_cc_o_c) doesn't exist.
-
 # To put more focus on warnings, less verbose as default
+# Use 'make V=1' to see the full commands
 
 ifdef V
   ifeq ("$(origin V)", "command line")
@@ -138,6 +124,9 @@ ifndef KBUILD_VERBOSE
   KBUILD_VERBOSE = 0 
 endif
 
+# Call sparse as part of compilation of C files
+# Use 'make C=1' to enable sparse checking
+
 ifdef C
   ifeq ("$(origin C)", "command line")
     KBUILD_CHECKSRC = $(C)
@@ -147,6 +136,7 @@ ifndef KBUILD_CHECKSRC
   KBUILD_CHECKSRC = 0
 endif
 
+# Do not print 'Entering directory ...'
 
 MAKEFLAGS += --no-print-directory
 
@@ -155,8 +145,28 @@ MAKEFLAGS += --no-print-directory
 
 #MAKEFLAGS += -rR
 
-#	If the user wants quiet mode, echo short versions of the commands 
-#	only
+# Beautify output
+# ---------------------------------------------------------------------------
+#
+# Normally, we echo the whole command before executing it. By making
+# that echo $($(quiet)$(cmd)), we now have the possibility to set
+# $(quiet) to choose other forms of output instead, e.g.
+#
+#         quiet_cmd_cc_o_c = Compiling $(RELDIR)/$@
+#         cmd_cc_o_c       = $(CC) $(c_flags) -c -o $@ $<
+#
+# If $(quiet) is empty, the whole command will be printed.
+# If it is set to "quiet_", only the short version will be printed. 
+# If it is set to "silent_", nothing wil be printed at all, since
+# the variable $(silent_cmd_cc_o_c) doesn't exist.
+#
+# A simple variant is to prefix commands with $(Q) - that's usefull
+# for commands that shall be hidden in non-verbose mode.
+#
+#	$(Q)ln $@ :<
+#
+# If KBUILD_VERBOSE equals 0 then the above command will be hidden.
+# If KBUILD_VERBOSE equals 1 then the above command is displayed.
 
 ifeq ($(KBUILD_VERBOSE),1)
   quiet =
@@ -166,8 +176,8 @@ else
   Q = @
 endif
 
-#	If the user is running make -s (silent mode), suppress echoing of
-#	commands
+# If the user is running make -s (silent mode), suppress echoing of
+# commands
 
 ifneq ($(findstring s,$(MAKEFLAGS)),)
   quiet=silent_
@@ -175,7 +185,7 @@ endif
 
 export quiet Q KBUILD_VERBOSE
 
-#	Paths to obj / src tree
+# Paths to obj / src tree
 
 src	:= .
 obj	:= .
@@ -184,7 +194,7 @@ objtree := .
 
 export srctree objtree
 
-# 	Make variables (CC, etc...)
+# Make variables (CC, etc...)
 
 AS		= $(CROSS_COMPILE)as
 LD		= $(CROSS_COMPILE)ld