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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20200731111659.3cfe5d23@lwn.net>
Date:   Fri, 31 Jul 2020 11:16:59 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Pierre-Louis Bossart <pierre-louis.bossart@...ux.intel.com>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Randy Dunlap <rdunlap@...radead.org>
Subject: Re: [PATCH v2] scripts/kernel-doc: optionally treat warnings as
 errors

On Tue, 28 Jul 2020 11:20:40 -0500
Pierre-Louis Bossart <pierre-louis.bossart@...ux.intel.com> 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@...radead.org>
> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@...ux.intel.com>

Applied, thanks.

jon