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 <e@freeshell.de>

diff --git a/doc/build/documentation.rst b/doc/build/documentation.rst
index 098c96a4c4ff9e77274e1083ef283687f45bd15e..b55a46666431da7547b11b8c0286fea37bb040d9 100644 (file)
--- 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
 ------------------