[PATCH master 4/8] Documentation: devicetree: fix Sphinx warnings

Ahmad Fatoum a.fatoum at pengutronix.de
Wed Mar 19 22:16:37 PDT 2025


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 at pengutronix.de>
---
v1 -> v2:
  - no change
---
 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




More information about the barebox mailing list