doc: bindings-syntax: Document requirements for title property
Add documentation for the expectations for the title property in devicetree bindings. Signed-off-by: Aksel Skauge Mellbye <aksel.mellbye@silabs.com>
This commit is contained in:
parent
4b4d40017a
commit
3a2f839d45
1 changed files with 12 additions and 2 deletions
14
doc/build/dts/bindings-syntax.rst
vendored
14
doc/build/dts/bindings-syntax.rst
vendored
|
@ -73,8 +73,18 @@ These keys are explained in the following sections.
|
|||
Title
|
||||
*****
|
||||
|
||||
Short description of the bound device, typically the hardware model.
|
||||
(It's optional.)
|
||||
Short description of the bound device, typically the hardware model. It should
|
||||
typically be on the format "Vendor Family Model". If acronyms are used, they
|
||||
should be spelled out in parentheses. The naming should stay as close to the
|
||||
vendor datasheet as possible.
|
||||
|
||||
Titles should not exceed 100 characters. The description field should be used
|
||||
for longer descriptions. The words "binding", "schema" or "driver" should not
|
||||
be used in the title, everything is a binding.
|
||||
|
||||
.. code-block:: YAML
|
||||
|
||||
title: Acme Foo UART (Universal Asynchronous Receiver/Transmitter)
|
||||
|
||||
.. _dt-bindings-description:
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue