Commit 1c7bafe7206d928eaccbcbd08d868733e0fb7054

Authored by Robert P. J. Day
Committed by Sam Ravnborg
1 parent e41217129c

kbuild: clarify "make C=" build option

Clarify the use of "make C=" in the top-level Makefile, and fix a
typo in the Documentation file.

Signed-off-by: Sam Ravnborg <sam@ravnborg.org>

Showing 2 changed files with 13 additions and 7 deletions Side-by-side Diff

Documentation/sparse.txt
... ... @@ -69,11 +69,11 @@
69 69 be recompiled or not. The latter is a fast way to check the whole tree if you
70 70 have already built it.
71 71  
72   -The optional make variable CF can be used to pass arguments to sparse. The
73   -build system passes -Wbitwise to sparse automatically. To perform endianness
74   -checks, you may define __CHECK_ENDIAN__:
  72 +The optional make variable CHECKFLAGS can be used to pass arguments to sparse.
  73 +The build system passes -Wbitwise to sparse automatically. To perform
  74 +endianness checks, you may define __CHECK_ENDIAN__:
75 75  
76   - make C=2 CF="-D__CHECK_ENDIAN__"
  76 + make C=2 CHECKFLAGS="-D__CHECK_ENDIAN__"
77 77  
78 78 These checks are disabled by default as they generate a host of warnings.
... ... @@ -41,9 +41,15 @@
41 41 KBUILD_VERBOSE = 0
42 42 endif
43 43  
44   -# Call checker as part of compilation of C files
45   -# Use 'make C=1' to enable checking (sparse, by default)
46   -# Override with 'make C=1 CHECK=checker_executable CHECKFLAGS=....'
  44 +# Call a source code checker (by default, "sparse") as part of the
  45 +# C compilation.
  46 +#
  47 +# Use 'make C=1' to enable checking of only re-compiled files.
  48 +# Use 'make C=2' to enable checking of *all* source files, regardless
  49 +# of whether they are re-compiled or not.
  50 +#
  51 +# See the file "Documentation/sparse.txt" for more details, including
  52 +# where to get the "sparse" utility.
47 53  
48 54 ifdef C
49 55 ifeq ("$(origin C)", "command line")