public-mirrors/linux
1
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-11-01 09:13:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: dt: writing-schema: clarify that schema should describe hardware

Browse source 
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>
This commit is contained in:
Krzysztof Kozlowski 2024-02-12 16:05:22 +01:00 • committed by Rob Herring
parent 6e71647145
commit ceecb37e49
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Documentation/devicetree/bindings/writing-schema.rst
View 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.