| Message ID | 20240212150524.81819-3-krzysztof.kozlowski@linaro.org |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [1/3] docs: dt: writing-schema: clarify that schema should describe hardware | expand |
| Context | Check | Description |
|---|---|---|
| robh/checkpatch | success | |
| robh/patch-applied | success |
On Mon, 12 Feb 2024 16:05:24 +0100, Krzysztof Kozlowski wrote: > 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> > --- > Documentation/devicetree/bindings/writing-schema.rst | 6 ++++-- > 1 file changed, 4 insertions(+), 2 deletions(-) > Applied, thanks!
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.
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> --- Documentation/devicetree/bindings/writing-schema.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)