diff options
author | Krzysztof Kozlowski <[email protected]> | 2024-02-12 16:05:23 +0100 |
---|---|---|
committer | Rob Herring <[email protected]> | 2024-02-13 12:12:29 -0600 |
commit | d9a41dc4de9fcdf6395a31bfcb737328e2b9fe1e (patch) | |
tree | bb1d0f9f27e4e1b0d34cb4b3ab352d143891eeb2 | |
parent | ceecb37e49673019afdcf39e2d4fcfd5ebcf06c3 (diff) |
docs: dt: writing-schema: explain additional/unevaluatedProperties
Add to the list of schema contents expected keywords with their
explanation: additionalProperties and unevaluatedProperties.
Signed-off-by: Krzysztof Kozlowski <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Rob Herring <[email protected]>
-rw-r--r-- | Documentation/devicetree/bindings/writing-schema.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index 2e5575e6a4e5..a35859f3be00 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -71,6 +71,26 @@ required A list of DT properties from the 'properties' section that must always be present. +additionalProperties / unevaluatedProperties + Keywords controlling how schema will validate properties not matched by this + schema's 'properties' or 'patternProperties'. Each schema is supposed to + have exactly one of these keywords in top-level part, so either + additionalProperties or unevaluatedProperties. Nested nodes, so properties + being objects, are supposed to have one as well. + + * additionalProperties: false + Most common case, where no additional schema is referenced or if this + binding allows subset of properties from other referenced schemas. + + * unevaluatedProperties: false + Used when this binding references other schema whose all properties + should be allowed. + + * additionalProperties: true + Rare case, used for schemas implementing common set of properties. Such + schemas are supposed to be referenced by other schemas, which then use + '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. |