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

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.orgSigned-off-by: default avatarRob Herring <robh@kernel.org>
parent 6e716471
...@@ -31,7 +31,7 @@ $schema ...@@ -31,7 +31,7 @@ $schema
Indicates the meta-schema the schema file adheres to. Indicates the meta-schema the schema file adheres to.
title 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 maintainers
A DT specific property. Contains a list of email address(es) A DT specific property. Contains a list of email address(es)
...@@ -39,7 +39,7 @@ maintainers ...@@ -39,7 +39,7 @@ maintainers
description description
Optional. A multi-line text block containing any detailed 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 or device does, standards the device conforms to, and links to datasheets for
more information. more information.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment