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:
Aksel Skauge Mellbye 2025-04-30 13:16:13 +02:00 committed by Benjamin Cabé
commit 3a2f839d45

View file

@ -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: