scripts/kernel-doc: Override -Werror from KCFLAGS with KDOC_WERROR
authorLaurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Fri, 30 Jul 2021 22:54:01 +0000 (01:54 +0300)
committerJonathan Corbet <corbet@lwn.net>
Thu, 12 Aug 2021 14:58:13 +0000 (08:58 -0600)
commitbed4ed3057e495dc91ac4049770319f23c579b32
tree9e4f2bc7e7957e86e6a430c259f5c9f8a0146d04
parent4f3791c3fe277446191f4d0857bd04baf5e6d9bd
scripts/kernel-doc: Override -Werror from KCFLAGS with KDOC_WERROR

Since commit 2c12c8103d8f ("scripts/kernel-doc: optionally treat
warnings as errors"), the kernel-doc script will treat warnings as
errors when one of the following conditions is true:

- The KDOC_WERROR environment variable is non-zero
- The KCFLAGS environment variable contains -Werror
- The -Werror parameter is passed to kernel-doc

Checking KCFLAGS for -Werror allows piggy-backing on the C compiler
error handling. However, unlike the C compiler, kernel-doc has no
provision for -Wno-error. This makes compiling the kernel with -Werror
(to catch regressions) and W=1 (to enable more checks) always fail,
without the same possibility as offered by the C compiler to treating
some selected warnings as warnings despite the global -Werror setting.

To fix this, evaluate KDOC_WERROR after KCFLAGS, which allows disabling
the warnings-as-errors behaviour of kernel-doc selectively by setting
KDOC_WERROR=0.

Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Link: https://lore.kernel.org/r/20210730225401.4401-1-laurent.pinchart+renesas@ideasonboard.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc