From: E Shattow <e@freeshell.de>
To: Tom Rini <trini@konsulko.com>
Cc: u-boot@lists.denx.de, E Shattow <e@freeshell.de>
Subject: [PATCH] doc: build: documentation: add description of KDOC_WERROR
Date: Thu, 18 Sep 2025 18:37:56 -0700 [thread overview]
Message-ID: <20250919013804.1562261-1-e@freeshell.de> (raw)
Describe KDOC_WERROR and recommend when building documentation for a patch
submission.
Signed-off-by: E Shattow <e@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
reply other threads:[~2025-09-19 1:40 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250919013804.1562261-1-e@freeshell.de \
--to=e@freeshell.de \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox