diff options
| author | Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> | 2024-02-12 16:05:24 +0100 |
|---|---|---|
| committer | Rob Herring <robh@kernel.org> | 2024-02-13 12:12:29 -0600 |
| commit | 2ff94f7ce292a77e77965919d7dccb7ac04a88f5 (patch) | |
| tree | 58c64d3b08dfc9257cb478eec8f6bf95937c80a6 | |
| parent | d9a41dc4de9fcdf6395a31bfcb737328e2b9fe1e (diff) | |
| download | linux-stable-2ff94f7ce292a77e77965919d7dccb7ac04a88f5.tar.gz linux-stable-2ff94f7ce292a77e77965919d7dccb7ac04a88f5.tar.bz2 linux-stable-2ff94f7ce292a77e77965919d7dccb7ac04a88f5.zip | |
docs: dt: writing-schema: document expectations on example DTS
Devicetree binding maintainers expect the example DTS in a binding to
show the usage of only this one particular binding, without unrelated
device nodes.
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20240212150524.81819-3-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring <robh@kernel.org>
| -rw-r--r-- | Documentation/devicetree/bindings/writing-schema.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index a35859f3be00..7e71cdd1d6de 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -92,8 +92,10 @@ additionalProperties / unevaluatedProperties 'unevaluatedProperties: false'. Typically bus or common-part schemas. examples - Optional. A list of one or more DTS hunks implementing the - binding. Note: YAML doesn't allow leading tabs, so spaces must be used instead. + 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. + Note: YAML doesn't allow leading tabs, so spaces must be used instead. Unless noted otherwise, all properties are required. |