Commit ceecb37e authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring
Browse files

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: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20240212150524.81819-1-krzysztof.kozlowski@linaro.org


Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent 6e716471

Documentation/devicetree/bindings/writing-schema.rst

+2 −2
Original line number Diff line number Diff line
@@ -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.