diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-04-15 16:45:26 +0200 |
|---|---|---|
| committer | Rob Herring <robh@kernel.org> | 2020-05-05 00:09:53 +0200 |
| commit | e7728fcf7dd7955dae7e6e9a14ab5faa392b8605 (patch) | |
| tree | a4b620a6adfcd97655dbc7d30ef98970bb183402 /Documentation/devicetree/bindings | |
| parent | docs: dt: convert submitting-patches.txt to ReST format (diff) | |
| download | linux-e7728fcf7dd7955dae7e6e9a14ab5faa392b8605.tar.xz linux-e7728fcf7dd7955dae7e6e9a14ab5faa392b8605.zip | |
docs: dt: convert writing-bindings.txt to ReST
- Add a SPDX header;
- Adjust document and section titles;
- Mark literal blocks as such;
- Add it to bindings/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Diffstat (limited to 'Documentation/devicetree/bindings')
| -rw-r--r-- | Documentation/devicetree/bindings/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/devicetree/bindings/writing-bindings.rst (renamed from Documentation/devicetree/bindings/writing-bindings.txt) | 7 |
2 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/index.rst b/Documentation/devicetree/bindings/index.rst index 6b87875a049c..3837b17c234f 100644 --- a/Documentation/devicetree/bindings/index.rst +++ b/Documentation/devicetree/bindings/index.rst @@ -9,3 +9,4 @@ Device Tree ABI submitting-patches + writing-bindings diff --git a/Documentation/devicetree/bindings/writing-bindings.txt b/Documentation/devicetree/bindings/writing-bindings.rst index ca024b9c7433..45ff426d0019 100644 --- a/Documentation/devicetree/bindings/writing-bindings.txt +++ b/Documentation/devicetree/bindings/writing-bindings.rst @@ -1,4 +1,8 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================================================ DOs and DON'Ts for designing and writing Devicetree bindings +============================================================ This is a list of common review feedback items focused on binding design. With every rule, there are exceptions and bindings have many gray areas. @@ -8,6 +12,7 @@ Documentation/devicetree/bindings/submitting-patches.rst Overall design +============== - DO attempt to make bindings complete even if a driver doesn't support some features. For example, if a device has an interrupt, then include the @@ -32,6 +37,7 @@ Overall design Properties +========== - DO make 'compatible' properties specific. DON'T use wildcards in compatible strings. DO use fallback compatibles when devices are the same as or a subset @@ -53,6 +59,7 @@ Properties Board/SoC .dts Files +==================== - DO put all MMIO devices under a bus node and not at the top-level. |