Add optional check for bad kernel-doc comments

Browse source

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>

...

This commit is contained in:

Matthew Wilcox 2017-11-20 10:40:40 -08:00 • committed by Jonathan Corbet

parent e7e61fc0ba

commit 3a025e1d1c

2 changed files with 29 additions and 1 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

5

scripts/Makefile.build

View file

25

scripts/kernel-doc

View file