diff options
| author | E Shattow <e@freeshell.de> | 2025-09-18 18:37:56 -0700 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2025-09-27 09:18:48 +0200 |
| commit | 77493c488bafafe7b347f38cc3df7ad395f810e1 (patch) | |
| tree | 5e77586a5f03023d484953708ed8b918ded6ca33 | |
| parent | 0e4fad5f419eb55b0e141c8c229e520724c5b378 (diff) | |
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>
| -rw-r--r-- | doc/build/documentation.rst | 3 |
1 files changed, 3 insertions, 0 deletions
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 ------------------ |