mirrors/linux
2
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-08-28 14:34:17 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: dt: writing-schema: Extend expectations about example part of binding

Browse Source 
Document already used rules about example DTS in the binding:

 - All final device bindings (except sub-block of more complex devices)
   should have an example.

 - Phandles do not need to be resolvable - Sashiko already provided
   incorrect review, so this might help it to understand the concept.

 - Example should be complete, readable (use known defines), without
   'status' property.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@oss.qualcomm.com>
Link: https://patch.msgid.link/20260722062240.19382-2-krzysztof.kozlowski@oss.qualcomm.com
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
This commit is contained in:
Krzysztof Kozlowski
2026-07-22 08:22:41 +02:00
committed by Rob Herring (Arm)
parent bfd4e4b12d
commit 87ef382e44
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/devicetree/bindings/writing-schema.rst
View File

@@ -127,9 +127,16 @@ additionalProperties / unevaluatedProperties
two above cases ('false').
examples
Optional. A list of one or more DTS hunks implementing this binding only.
Example should not contain unrelated device nodes, e.g. consumer nodes in a
provider binding, other nodes referenced by phandle.
Optional, although expected outside of bindings describing common properties
or sub-blocks of more complex devices. A list of one or more DTS hunks
implementing this binding only. Example should not contain unrelated device
nodes, e.g. consumer nodes in a provider binding, other nodes referenced by
phandles or node labels which are not directly referenced in the example
itself. Phandles in the example do not have to be resolvable. The example
must be complete as much as possible - have most of the properties - and look
readable to developers, thus for example use known defines for interrupt or
GPIO flags. Example should not contain 'status' property in typical cases.
Note: YAML doesn't allow leading tabs, so spaces must be used instead.
Unless noted otherwise, all above schema properties are required.