From 77493c488bafafe7b347f38cc3df7ad395f810e1 Mon Sep 17 00:00:00 2001 From: E Shattow Date: Thu, 18 Sep 2025 18:37:56 -0700 Subject: [PATCH] doc: build: documentation: add description of KDOC_WERROR Describe KDOC_WERROR and recommend when building documentation for a patch submission. Signed-off-by: E Shattow --- doc/build/documentation.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/build/documentation.rst b/doc/build/documentation.rst index 098c96a4c4f..b55a4666643 100644 --- a/doc/build/documentation.rst +++ b/doc/build/documentation.rst @@ -16,6 +16,9 @@ the following dependencies are needed to build the documentation: * texinfo (if building the `Infodoc documentation`_) +When submitting patches for documentation always build with KDOC_WERROR=1 to +treat warnings as errors. + HTML documentation ------------------ -- 2.47.3