public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
* [PATCH] doc: build: documentation: add description of KDOC_WERROR
@ 2025-09-19  1:37 E Shattow
  0 siblings, 0 replies; only message in thread
From: E Shattow @ 2025-09-19  1:37 UTC (permalink / raw)
  To: Tom Rini; +Cc: u-boot, E Shattow

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


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2025-09-19  1:40 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-19  1:37 [PATCH] doc: build: documentation: add description of KDOC_WERROR E Shattow

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox