]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: dt: convert ABI.txt to ReST format
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 15 Apr 2020 14:45:24 +0000 (16:45 +0200)
committerRob Herring <robh@kernel.org>
Mon, 4 May 2020 22:09:52 +0000 (17:09 -0500)
This file only requires a properly-formatted title to be
recognized as a ReST file.

As there will be more files under bindings/ that will be
included at the documentation body, add a new index.rst
file there.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Documentation/arm/microchip.rst
Documentation/devicetree/bindings/ABI.rst [moved from Documentation/devicetree/bindings/ABI.txt with 94% similarity]
Documentation/devicetree/bindings/arm/amlogic.yaml
Documentation/devicetree/bindings/arm/syna.txt
Documentation/devicetree/bindings/index.rst [new file with mode: 0644]
Documentation/devicetree/index.rst

index 05e5f2dfb814bfc4f9afc10898469e5e0316c241..9c013299fd3bffa165ae058f4cb716f55928c162 100644 (file)
@@ -192,7 +192,7 @@ Device Tree files and Device Tree bindings that apply to AT91 SoCs and boards ar
 considered as "Unstable". To be completely clear, any at91 binding can change at
 any time. So, be sure to use a Device Tree Binary and a Kernel Image generated from
 the same source tree.
-Please refer to the Documentation/devicetree/bindings/ABI.txt file for a
+Please refer to the Documentation/devicetree/bindings/ABI.rst file for a
 definition of a "Stable" binding/ABI.
 This statement will be removed by AT91 MAINTAINERS when appropriate.
 
similarity index 94%
rename from Documentation/devicetree/bindings/ABI.txt
rename to Documentation/devicetree/bindings/ABI.rst
index d25f8d3796806eee10a38e33187807489eea25b0..a885713cf184b0b55f5ce0fba73a832de88ca28d 100644 (file)
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
 
-  Devicetree (DT) ABI
+===================
+Devicetree (DT) ABI
+===================
 
 I. Regarding stable bindings/ABI, we quote from the 2013 ARM mini-summit
    summary document:
index f74aba48cec1ba4493f88ac37e620804b8d55d89..a21ce4ad63f68c799468104f6a59716e23b95439 100644 (file)
@@ -17,7 +17,7 @@ description: |+
   any time. Be sure to use a device tree binary and a kernel image
   generated from the same source tree.
 
-  Please refer to Documentation/devicetree/bindings/ABI.txt for a definition of a
+  Please refer to Documentation/devicetree/bindings/ABI.rst for a definition of a
   stable binding/ABI.
 
 properties:
index 2face46a5f64de58e7464f3c93591807bd0f3396..d8b48f2edf1b79fe0a766d479be5654a8604bbd2 100644 (file)
@@ -13,7 +13,7 @@ considered "unstable". Any Marvell Berlin device tree binding may change at any
 time. Be sure to use a device tree binary and a kernel image generated from the
 same source tree.
 
-Please refer to Documentation/devicetree/bindings/ABI.txt for a definition of a
+Please refer to Documentation/devicetree/bindings/ABI.rst for a definition of a
 stable binding/ABI.
 
 ---------------------------------------------------------------
diff --git a/Documentation/devicetree/bindings/index.rst b/Documentation/devicetree/bindings/index.rst
new file mode 100644 (file)
index 0000000..98ebdab
--- /dev/null
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===========
+Device Tree
+===========
+
+.. toctree::
+   :maxdepth: 1
+
+   ABI
index 1c36bc19969b0ef4b4640de5257bc02f32502e86..54026763916d41938bf35a67afb28b7ffa077257 100644 (file)
@@ -13,3 +13,5 @@ Open Firmware and Device Tree
    dynamic-resolution-notes
    of_unittest
    overlay-notes
+
+   bindings/index