mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Ahmad Fatoum <a.fatoum@pengutronix.de>
To: barebox@lists.infradead.org
Cc: Ahmad Fatoum <a.fatoum@pengutronix.de>
Subject: [PATCH master 3/3] Documentation: devicetree: fix Sphinx warnings
Date: Wed, 19 Mar 2025 17:08:03 +0100	[thread overview]
Message-ID: <20250319160803.2079550-3-a.fatoum@pengutronix.de> (raw)
In-Reply-To: <20250319160803.2079550-1-a.fatoum@pengutronix.de>

Building the barebox documentation results in an number of warnings
predominantly in the autogenerated docs from command help text.

Outside of that, there is warnings only in the DT bindings:

  bindings/barebox/virtual-reg.rst:25:
  WARNING: Inline emphasis start-string without end-string.

  bindings/barebox/virtual-reg.rst:28:
  WARNING: Definition list ends without a blank line; unexpected unindent.

  bindings/barebox/virtual-reg.rst:29:
  WARNING: Block quote ends without a blank line; unexpected unindent.

  bindings/clocks/xlnx,ps7-clkc.rst:
  WARNING: document isn't included in any toctree

Fix the devicetree binding warnings.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/devicetree/bindings/barebox/virtual-reg.rst | 2 +-
 Documentation/devicetree/index.rst                        | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/barebox/virtual-reg.rst b/Documentation/devicetree/bindings/barebox/virtual-reg.rst
index 7d576d0cef6f..a69d23144755 100644
--- a/Documentation/devicetree/bindings/barebox/virtual-reg.rst
+++ b/Documentation/devicetree/bindings/barebox/virtual-reg.rst
@@ -13,7 +13,7 @@ by subtracting ``virtual-reg`` from the first address in ``reg``.
 
 This is normally used to map I/O memory away from the zero page, so it
 can be used again to trap null pointer dereferences, while allowing
-full access to the device memory::
+full access to the device memory.
 
 .. code-block:: none
 
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index cd9270da1d21..2ca8b72be1ac 100644
--- a/Documentation/devicetree/index.rst
+++ b/Documentation/devicetree/index.rst
@@ -143,6 +143,7 @@ Contents:
    :maxdepth: 1
 
    bindings/barebox/*
+   bindings/clocks/*
    bindings/firmware/*
    bindings/leds/*
    bindings/misc/*
-- 
2.39.5




      parent reply	other threads:[~2025-03-19 16:08 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-19 16:08 [PATCH master 1/3] firmware: disable MISSING_FIRMWARE_ERROR for COMPILE_TEST builds Ahmad Fatoum
2025-03-19 16:08 ` [PATCH master 2/3] sandbox: do not enable SANDBOX_LINUX_I386 in allyesconfig Ahmad Fatoum
2025-03-19 16:08 ` Ahmad Fatoum [this message]

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=20250319160803.2079550-3-a.fatoum@pengutronix.de \
    --to=a.fatoum@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /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