doc: build: documentation: add description of KDOC_WERROR

E Shattow · xypron · commit 77493c488baf · 2025-09-27T09:18:48.000+02:00
Describe KDOC_WERROR and recommend when building documentation for a patch
submission.

Signed-off-by: E Shattow &lt;e@freeshell.de&gt;
diff --git 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
 ------------------
 
