diff options
| author | Matthew Wilcox <willy@infradead.org> | 2017-11-20 10:40:40 -0800 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-11-20 12:09:11 -0700 |
| commit | 3a025e1d1c2ea42fa497c9c6b21c284e0f69e28b (patch) | |
| tree | 82ed4e7dfbd05c14aa0e108e0c3d173504903c86 /scripts/Makefile.build | |
| parent | e7e61fc0ba7b92153e17f1f707d2b7b3d52c0588 (diff) | |
Add optional check for bad kernel-doc comments
Implement a '-none' output mode for kernel-doc which will only output
warning messages, and suppresses the warning message about there being
no kernel-doc in the file.
If the build has requested additional warnings, automatically check all
.c files. This patch does not check .h files. Enabling the warning
by default would add about 1300 warnings, so it's default off for now.
People who care can use this to check they didn't break the docs and
maybe we'll get all the warnings fixed and be able to enable this check
by default in the future.
Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/Makefile.build')
| -rw-r--r-- | scripts/Makefile.build | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/scripts/Makefile.build b/scripts/Makefile.build index 2e3a10e79ca9..aceac0ba0745 100644 --- a/scripts/Makefile.build +++ b/scripts/Makefile.build @@ -108,6 +108,10 @@ ifneq ($(KBUILD_CHECKSRC),0) endif endif +ifneq ($(KBUILD_ENABLE_EXTRA_GCC_CHECKS),) + cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $< ; +endif + # Do section mismatch analysis for each module/built-in.o ifdef CONFIG_DEBUG_SECTION_MISMATCH cmd_secanalysis = ; scripts/mod/modpost $@ @@ -289,6 +293,7 @@ define rule_cc_o_c $(call echo-cmd,checksrc) $(cmd_checksrc) \ $(call cmd_and_fixdep,cc_o_c) \ $(cmd_modversions_c) \ + $(cmd_checkdoc) \ $(call echo-cmd,objtool) $(cmd_objtool) \ $(call echo-cmd,record_mcount) $(cmd_record_mcount) endef |