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>
This commit is contained in:
E Shattow
2025-09-18 18:37:56 -07:00
committed by Heinrich Schuchardt
parent 0e4fad5f41
commit 77493c488b

View File

@@ -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
------------------