docs: dt: writing-schema: clarify that schema should describe hardware
authorKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Mon, 12 Feb 2024 15:05:22 +0000 (16:05 +0100)
committerRob Herring <robh@kernel.org>
Tue, 13 Feb 2024 18:12:29 +0000 (12:12 -0600)
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>
Documentation/devicetree/bindings/writing-schema.rst

index 0a6cf19a14599b818164426a28881f2a6f4be4f6..2e5575e6a4e5ba5eac9ea78aa549b315e3204c3b 100644 (file)
@@ -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.