Re: [PATCH] Check all .c files for bad kernel-doc comments

From: Matthew Wilcox
Date: Mon Nov 20 2017 - 13:41:23 EST


On Mon, Oct 30, 2017 at 12:40:20PM +0900, Masahiro Yamada wrote:
> 2017-10-28 4:41 GMT+09:00 Matthew Wilcox <willy@xxxxxxxxxxxxx>:
> > From: Matthew Wilcox <mawilcox@xxxxxxxxxxxxx>
> >
> > 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. Add it to the rule to build .o files from .c
> > files, so it will check all .c files that have been modified.
> >
> > Adds about 1300 warnings to my build, but will hopefully discourage
> > people from introducing more kerneldoc mistakes.
>
> Basically, I think this is good,
> but it is controversial to sprinkle warnings by default.
>
> Maybe,
>
> ifeq ($(KBUILD_ENABLE_EXTRA_GCC_CHECKS),)
> cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $< ;
> endif

Thanks! v2 below. Jon, could you apply?

---- 8< ----