[PATCH] doc: build: documentation: add description of KDOC_WERROR

E Shattow e at freeshell.de
Fri Sep 19 03:37:56 CEST 2025


Describe KDOC_WERROR and recommend when building documentation for a patch
submission.

Signed-off-by: E Shattow <e at freeshell.de>
---
 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.50.0



More information about the U-Boot mailing list