Re: [PATCH v2] scripts/kernel-doc: optionally treat warnings as errors

[Jonathan Corbet]

On Tue, 28 Jul 2020 11:20:40 -0500
Pierre-Louis Bossart <pierre-louis.bossart@xxxxxxxxxxxxxxx> wrote:

> he kbuild bot recently added the W=1 option, which triggered
> documentation cleanups to squelch hundreds of kernel-doc warnings.
> 
> To make sure new kernel contributions don't add regressions to
> kernel-doc descriptors, this patch suggests an option to treat
> warnings as errors in CI/automated tests.
> 
> A -Werror command-line option is added to the kernel-doc script. When
> this option is set, the script will return the number of warnings
> found. The caller can then treat this positive return value as an
> error and stop the build.
> 
> Using this command line option is however not straightforward when the
> kernel-doc script is called from other scripts. To align with typical
> kernel compilation or documentation generation, the Werror option is
> also set by checking the KCFLAGS environment variable, or if
> KDOC_WERROR is defined, as in the following examples:
> 
> KCFLAGS="-Wall -Werror" make W=1 sound/
> KCFLAGS="-Wall -Werror" make W=1 drivers/soundwire/
> KDOC_WERROR=1 make htmldocs
> 
> Note that in the last example the documentation build does not stop,
> only an additional log is provided.
> 
> Credits to Randy Dunlap for suggesting the use of environment variables.
> 
> Suggested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@xxxxxxxxxxxxxxx>

Applied, thanks.

jon