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>
This commit is contained in:
Mauro Carvalho Chehab 2020-04-15 16:45:26 +02:00 committed by Rob Herring
parent 858e684565
commit e7728fcf7d
2 changed files with 8 additions and 0 deletions

View File

@ -9,3 +9,4 @@ Device Tree
ABI
submitting-patches
writing-bindings

View File

@ -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.