]> www.infradead.org Git - users/jedix/linux-maple.git/commitdiff
docs: dt: writing-schema: document expectations on example DTS
authorKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Mon, 12 Feb 2024 15:05:24 +0000 (16:05 +0100)
committerRob Herring <robh@kernel.org>
Tue, 13 Feb 2024 18:12:29 +0000 (12:12 -0600)
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>
Documentation/devicetree/bindings/writing-schema.rst

index a35859f3be0095c29b9e671f362a4c88c9c94a48..7e71cdd1d6ded6cb3b6b4ae76d6249e2504a1cd5 100644 (file)
@@ -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.