Re: [RFC] Proposal to relax warnings of htmldocs

[Carlos Bilbao]

On 8/16/23 10:57, Matthew Wilcox wrote:
> On Wed, Aug 16, 2023 at 10:21:07AM -0500, Carlos Bilbao wrote:
> > On 8/16/23 10:15, Matthew Wilcox wrote:
> > > I wasn't proposing making W=1 builds the default; I was proposing
> > > running kernel-doc -none at all levels.
> >
> > More strict warning level, right? My concern is the same.
>
> The problem you're seeing with kernel-doc warning about undocumented
> fields / parameters is due to people not running kernel-doc -none.
> So I'm proposing this:
>
> diff --git a/scripts/Makefile.build b/scripts/Makefile.build
> index 82e3fb19fdaf..52f57c0c5227 100644
> --- a/scripts/Makefile.build
> +++ b/scripts/Makefile.build
> @@ -100,11 +100,9 @@ else ifeq ($(KBUILD_CHECKSRC),2)
>           cmd_force_checksrc = $(CHECK) $(CHECKFLAGS) $(c_flags) $<
>   endif
>
> -ifneq ($(KBUILD_EXTRA_WARN),)
> -  cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $(KDOCFLAGS) \
> +cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $(KDOCFLAGS) \
>           $(if $(findstring 2, $(KBUILD_EXTRA_WARN)), -Wall) \
>           $<
> -endif
>
>   # Compile C sources (.c)
>   # ---------------------------------------------------------------------------
>
> Now everybody runs kernel-doc -none on every build and you don't get to
> see that problem any more.

Understood, that should do it. I will also try to fix some of the legacy
warnings. Are you interested in submitting this patch? If so:

Reviewed-By: Carlos Bilbao <carlos.bilbao@xxxxxxx>

Thanks,
Carlos