Commit e7728fcf authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Rob Herring

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent 858e6845
......@@ -9,3 +9,4 @@ Device Tree
ABI
submitting-patches
writing-bindings
.. 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.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment