diff mbox

[1/7] dt: dtb version: consolidate documentation of chosen node bindings

Message ID 550A4326.2070801@gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Frank Rowand March 19, 2015, 3:31 a.m. UTC
From: Frank Rowand <frank.rowand@sonymobile.com>

Documentation of bindings in node /chosen are scattered in several bindings
files.  If not already in Documentation/devicetree/bindings/chosen.txt, add
a pointer in that file to where the property and node bindings are described.

This is a clean up in anticipation of adding another node binding in /chosen.

Signed-off-by: Frank Rowand <frank.rowand@sonymobile.com>
---
 Documentation/devicetree/bindings/chosen.txt |   31 +++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

Comments

Mark Rutland March 19, 2015, 1:40 p.m. UTC | #1
On Thu, Mar 19, 2015 at 03:31:50AM +0000, Frank Rowand wrote:
> From: Frank Rowand <frank.rowand@sonymobile.com>
> 
> Documentation of bindings in node /chosen are scattered in several bindings
> files.  If not already in Documentation/devicetree/bindings/chosen.txt, add
> a pointer in that file to where the property and node bindings are described.
> 
> This is a clean up in anticipation of adding another node binding in /chosen.
> 
> Signed-off-by: Frank Rowand <frank.rowand@sonymobile.com>
> ---
>  Documentation/devicetree/bindings/chosen.txt |   31 +++++++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
> 
> Index: b/Documentation/devicetree/bindings/chosen.txt
> ===================================================================
> --- a/Documentation/devicetree/bindings/chosen.txt
> +++ b/Documentation/devicetree/bindings/chosen.txt
> @@ -44,3 +44,34 @@ Implementation note: Linux will look for
>  on PowerPC "stdout" if "stdout-path" is not found.  However, the
>  "linux,stdout-path" and "stdout" properties are deprecated. New platforms
>  should only use the "stdout-path" property.
> +
> +
> +Properties documented in other bindings
> +---------------------------------------
> +#address-cells                          video/simple-framebuffer-sunxi.txt
> +
> +#size-cells                             video/simple-framebuffer-sunxi.txt
> +
> +bootargs                                booting-without-of.txt
> +                                        usage-model.txt
> +
> +initrd-end                              usage-model.txt
> +initrd-start                            usage-model.txt
> +
> +interrupt-controller (obsolete)         booting-without-of.txt
> +
> +linux,pci-probe-only                    pci/host-generic-pci.txt
> +
> +linux,stdout-path                       booting-without-of.txt
> +
> +ranges                                  video/simple-framebuffer-sunxi.txt
> +
> +stdout-path                             video/simple-framebuffer.txt

The usual form of stdout-path is documented immediately above this
section. That should probably be updated to refer to the
video/simple-framebuffer.txt case.

Mark.
diff mbox

Patch

Index: b/Documentation/devicetree/bindings/chosen.txt
===================================================================
--- a/Documentation/devicetree/bindings/chosen.txt
+++ b/Documentation/devicetree/bindings/chosen.txt
@@ -44,3 +44,34 @@  Implementation note: Linux will look for
 on PowerPC "stdout" if "stdout-path" is not found.  However, the
 "linux,stdout-path" and "stdout" properties are deprecated. New platforms
 should only use the "stdout-path" property.
+
+
+Properties documented in other bindings
+---------------------------------------
+#address-cells                          video/simple-framebuffer-sunxi.txt
+
+#size-cells                             video/simple-framebuffer-sunxi.txt
+
+bootargs                                booting-without-of.txt
+                                        usage-model.txt
+
+initrd-end                              usage-model.txt
+initrd-start                            usage-model.txt
+
+interrupt-controller (obsolete)         booting-without-of.txt
+
+linux,pci-probe-only                    pci/host-generic-pci.txt
+
+linux,stdout-path                       booting-without-of.txt
+
+ranges                                  video/simple-framebuffer-sunxi.txt
+
+stdout-path                             video/simple-framebuffer.txt
+
+
+Nodes documented in other bindings
+----------------------------------
+framebuffer                             video/simple-framebuffer.txt
+                                        video/simple-framebuffer-sunxi.txt
+
+linux,sysrq-reset-seq                   input/input-reset.txt