summaryrefslogtreecommitdiff
path: root/Documentation/kbuild/kbuild.rst
diff options
context:
space:
mode:
authorJohannes Berg <johannes.berg@intel.com>2023-06-09 11:46:41 +0300
committerMasahiro Yamada <masahiroy@kernel.org>2023-06-10 10:39:02 +0300
commit56b0f453db74207633019f83758b4c11c66b75d0 (patch)
tree4fcd1efc4a45afdd59aeda5ca3b3fe4afa6ab1cd /Documentation/kbuild/kbuild.rst
parent3a3f1e573a105328a2cca45a7cfbebabbf5e3192 (diff)
downloadlinux-56b0f453db74207633019f83758b4c11c66b75d0.tar.xz
kernel-doc: don't let V=1 change outcome
The kernel-doc script currently reports a number of issues only in "verbose" mode, but that's initialized from V=1 (via KBUILD_VERBOSE), so if you use KDOC_WERROR=1 then adding V=1 might actually break the build. This is rather unexpected. Change kernel-doc to not change its behaviour wrt. errors (or warnings) when verbose mode is enabled, but rather add separate warning flags (and -Wall) for it. Allow enabling those flags via environment/make variables in the kernel's build system for easier user use, but to not have to parse them in the script itself. Signed-off-by: Johannes Berg <johannes.berg@intel.com> Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Diffstat (limited to 'Documentation/kbuild/kbuild.rst')
-rw-r--r--Documentation/kbuild/kbuild.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/kbuild/kbuild.rst b/Documentation/kbuild/kbuild.rst
index 2a22ddb1b848..bd906407e307 100644
--- a/Documentation/kbuild/kbuild.rst
+++ b/Documentation/kbuild/kbuild.rst
@@ -150,6 +150,12 @@ the UTS_MACHINE variable, and on some architectures also the kernel config.
The value of KBUILD_DEBARCH is assumed (not checked) to be a valid Debian
architecture.
+KDOCFLAGS
+---------
+Specify extra (warning/error) flags for kernel-doc checks during the build,
+see scripts/kernel-doc for which flags are supported. Note that this doesn't
+(currently) apply to documentation builds.
+
ARCH
----
Set ARCH to the architecture to be built.