mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: "U-Boot Version 2 (barebox)" <barebox@lists.infradead.org>
Subject: [PATCH] Documentation: device tree bindings.
Date: Mon, 30 Jun 2014 08:23:43 -0400 (EDT)	[thread overview]
Message-ID: <alpine.LFD.2.11.1406300822050.721@localhost> (raw)


Adjusted Sphinx markup for devicetree bindings pages.

Signed-off-by: Robert P. J. Day <rpjday@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
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

             reply	other threads:[~2014-06-30 12:28 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-06-30 12:23 Robert P. J. Day [this message]
2014-06-30 15:56 ` Sascha Hauer

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=alpine.LFD.2.11.1406300822050.721@localhost \
    --to=rpjday@crashcourse.ca \
    --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