Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Rob Herring
e7728fcf 858e6845

+8
+1
Documentation/devicetree/bindings/index.rst
··· 9 9 10 10 ABI 11 11 submitting-patches 12 + writing-bindings
+7
Documentation/devicetree/bindings/writing-bindings.txt Documentation/devicetree/bindings/writing-bindings.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ============================================================ 1 4 DOs and DON'Ts for designing and writing Devicetree bindings 5 + ============================================================ 2 6 3 7 This is a list of common review feedback items focused on binding design. With 4 8 every rule, there are exceptions and bindings have many gray areas. ··· 12 8 13 9 14 10 Overall design 11 + ============== 15 12 16 13 - DO attempt to make bindings complete even if a driver doesn't support some 17 14 features. For example, if a device has an interrupt, then include the ··· 37 32 38 33 39 34 Properties 35 + ========== 40 36 41 37 - DO make 'compatible' properties specific. DON'T use wildcards in compatible 42 38 strings. DO use fallback compatibles when devices are the same as or a subset ··· 59 53 60 54 61 55 Board/SoC .dts Files 56 + ==================== 62 57 63 58 - DO put all MMIO devices under a bus node and not at the top-level. 64 59