[PATCH 1/3] docs: dt: writing-schema: clarify that schema should describe hardware

From: Krzysztof Kozlowski
Date: Mon Feb 12 2024 - 10:05:41 EST


The 'title' and 'description' fields in Devicetree schema is supposed to
describe hardware, not the binding itself.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@xxxxxxxxxx>
---
Documentation/devicetree/bindings/writing-schema.rst | 4 ++--
1 file 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.

--
2.34.1