[PATCH] Documentation: device tree bindings.
Robert P. J. Day
rpjday at crashcourse.ca
Mon Jun 30 05:23:43 PDT 2014
Adjusted Sphinx markup for devicetree bindings pages.
Signed-off-by: Robert P. J. Day <rpjday at crashcourse.ca>
---
not completely confident in my markup here so i'm open to
suggestions.
diff --git a/Documentation/devicetree/bindings/barebox/barebox,environment.rst b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
index d243484..d472f66 100644
--- a/Documentation/devicetree/bindings/barebox/barebox,environment.rst
+++ b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
@@ -4,18 +4,19 @@ barebox environment
This driver provides an environment for barebox from the devicetree.
Required properties:
-- compatible: should be "barebox,environment"
-- device-path: path to the environment
+
+* ``compatible``: should be ``barebox,environment``
+* ``device-path``: path to the environment
The device-path is a multistring property. The first string should be a
nodepath to the node containing the physical device of the environment.
The subsequent strings are of the form <type>:<options> to further describe
the path to the environment. Supported values for <type>:
-partname:<partname> This describes a partition on a device. <partname> can
- be the label for mtd partitions, the number for DOS
- partitions (beginning with 0) or the name for GPT
- partitions
+``partname``:<partname>
+ This describes a partition on a device. <partname> can
+ be the label for MTD partitions, the number for DOS
+ partitions (beginning with 0) or the name for GPT partitions.
Example::
diff --git a/Documentation/devicetree/bindings/leds/common.rst b/Documentation/devicetree/bindings/leds/common.rst
index 63a45bd..c1fd1ab 100644
--- a/Documentation/devicetree/bindings/leds/common.rst
+++ b/Documentation/devicetree/bindings/leds/common.rst
@@ -1,9 +1,10 @@
Common leds properties
======================
-- linux,default-trigger barebox,default-trigger: This parameter, if present, is a
+* ``linux,default-trigger``, ``barebox,default-trigger``: This parameter, if present, is a
string defining the trigger assigned to the LED. Current triggers are:
- "heartbeat" - LED flashes at a constant rate
- "panic" - LED turns on when barebox panics
- "net" - LED indicates network activity
+
+ * ``heartbeat`` - LED flashes at a constant rate
+ * ``panic`` - LED turns on when barebox panics
+ * ``net`` - LED indicates network activity
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
index a067579..b9d5bcb 100644
--- a/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
+++ b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
@@ -3,14 +3,14 @@ Freescale i.MX IIM (Ic Identification Module)
Required properties:
-- compatible: fsl,imx27-iim
-- reg: physical register base and size
+* ``compatible``: ``fsl,imx27-iim``, ``fsl,imx51-iim``
+* ``reg``: physical register base and size
Optional properties:
-- barebox,provide-mac-address: Provide MAC addresses for ethernet devices. This
- can be multiple entries in the form <&phandle bankno fuseofs> to specify a MAC
- address to a ethernet device.
+* ``barebox,provide-mac-address``: Provide MAC addresses for Ethernet devices. This
+ can be multiple entries in the form <&phandle bankno fuseofs> to assign a MAC
+ address to an Ethernet device.
Example::
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
index 472b9e2..403863e 100644
--- a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
+++ b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
@@ -3,14 +3,14 @@ Freescale i.MX OCOTP (On-Chip OTP)
Required properties:
-- compatible: fsl,imx6q-ocotp
-- reg: physical register base and size
+* ``compatible``: ``fsl,imx6q-ocotp``
+* ``reg``: physical register base and size
Optional properties:
-- barebox,provide-mac-address: Provide MAC addresses for ethernet devices. This
- can be multiple entries in the form <&phandle regofs> to specify a MAC
- address to a ethernet device.
+* ``barebox,provide-mac-address``: Provide MAC addresses for Ethernet devices. This
+ can be multiple entries in the form <&phandle regofs> to assign a MAC
+ address to an Ethernet device.
Example::
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
More information about the barebox
mailing list