diff options
| author | Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> | 2024-02-12 16:05:22 +0100 |
|---|---|---|
| committer | Rob Herring <robh@kernel.org> | 2024-02-13 12:12:29 -0600 |
| commit | ceecb37e49673019afdcf39e2d4fcfd5ebcf06c3 (patch) | |
| tree | c30a60e447791a6b3757d4e770fb7b39ecf5518d | |
| parent | 6e7164714539eeed9c616d33547fdd3961e6a11c (diff) | |
| download | linux-stable-ceecb37e49673019afdcf39e2d4fcfd5ebcf06c3.tar.gz linux-stable-ceecb37e49673019afdcf39e2d4fcfd5ebcf06c3.tar.bz2 linux-stable-ceecb37e49673019afdcf39e2d4fcfd5ebcf06c3.zip | |
docs: dt: writing-schema: clarify that schema should describe hardware
The 'title' and 'description' fields in Devicetree schema is supposed to
describe hardware, not the binding itself.
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20240212150524.81819-1-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring <robh@kernel.org>
| -rw-r--r-- | Documentation/devicetree/bindings/writing-schema.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index 0a6cf19a1459..2e5575e6a4e5 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -31,7 +31,7 @@ $schema Indicates the meta-schema the schema file adheres to. title - A one-line description on the contents of the binding schema. + A one-line description of the hardware being described in the binding schema. maintainers A DT specific property. Contains a list of email address(es) @@ -39,7 +39,7 @@ maintainers description Optional. A multi-line text block containing any detailed - information about this binding. It should contain things such as what the block + information about this hardware. It should contain things such as what the block or device does, standards the device conforms to, and links to datasheets for more information. |