kbuild: introduce $(kecho) convenience echo

There is a bunch of places in the build system where we do 'echo' to show some nice status lines. This means we still get output when running in silent mode. So declare a new KECHO variable that only does 'echo' when we are in a suitable verbose build mode. Signed-off-by: Mike Frysinger <vapier@gentoo.org> [sam: added Documentation] Signed-off-by: Sam Ravnborg <sam@ravnborg.org>

kbuild: introduce $(kecho) convenience echo
There is a bunch of places in the build system where we do 'echo' to show some nice status lines. This means we still get output when running in silent mode. So declare a new KECHO variable that only does 'echo' when we are in a suitable verbose build mode. Signed-off-by: Mike Frysinger <vapier@gentoo.org> [sam: added Documentation] Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Mike Frysinger · Sam Ravnborg
1 parent d03fab43c5
Showing 2 changed files with 21 additions and 0 deletions Side-by-side Diff
Documentation/kbuild/makefiles.txt
scripts/Kbuild.include
@@ -383,6 +383,20 @@
 	to prerequisites are referenced with $(src) (because they are not
 	generated files).
  
+    $(kecho)
+	echoing information to user in a rule is often a good practice
+	but when execution "make -s" one does not expect to see any output
+	except for warnings/errors.
+	To support this kbuild define $(kecho) which will echo out the
+	text following $(kecho) to stdout except if "make -s" is used.
+
+	Example:
+		#arch/blackfin/boot/Makefile
+		$(obj)/vmImage: $(obj)/vmlinux.gz
+			$(call if_changed,uimage)
+			@$(kecho) 'Kernel: $@ is ready'
+
+
 --- 3.11 $(CC) support functions
  
 	The kernel may be built with several different versions of
@@ -25,6 +25,13 @@
 escsq = $(subst $(squote),'\$(squote)',$1)
  
 ###
+# Easy method for doing a status message
+       kecho := :
+ quiet_kecho := echo
+silent_kecho := :
+kecho := $($(quiet)kecho)
+
+###
 # filechk is used to check if the content of a generated file is updated.
 # Sample usage:
 # define filechk_sample
...	...	@@ -383,6 +383,20 @@
383	383	to prerequisites are referenced with $(src) (because they are not
384	384	generated files).
385	385
	386	+ $(kecho)
	387	+ echoing information to user in a rule is often a good practice
	388	+ but when execution "make -s" one does not expect to see any output
	389	+ except for warnings/errors.
	390	+ To support this kbuild define $(kecho) which will echo out the
	391	+ text following $(kecho) to stdout except if "make -s" is used.
	392	+
	393	+ Example:
	394	+ #arch/blackfin/boot/Makefile
	395	+ $(obj)/vmImage: $(obj)/vmlinux.gz
	396	+ $(call if_changed,uimage)
	397	+ @$(kecho) 'Kernel: $@ is ready'
	398	+
	399	+
386	400	--- 3.11 $(CC) support functions
387	401
388	402	The kernel may be built with several different versions of
...	...	@@ -25,6 +25,13 @@
25	25	escsq = $(subst $(squote),'\$(squote)',$1)
26	26
27	27	###
	28	+# Easy method for doing a status message
	29	+ kecho := :
	30	+ quiet_kecho := echo
	31	+silent_kecho := :
	32	+kecho := $($(quiet)kecho)
	33	+
	34	+###
28	35	# filechk is used to check if the content of a generated file is updated.
29	36	# Sample usage:
30	37	# define filechk_sample