From 3a2f839d459ae20597f1bc4af0e78d35a68b5dd4 Mon Sep 17 00:00:00 2001 From: Aksel Skauge Mellbye Date: Wed, 30 Apr 2025 13:16:13 +0200 Subject: [PATCH] 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 --- doc/build/dts/bindings-syntax.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/build/dts/bindings-syntax.rst b/doc/build/dts/bindings-syntax.rst index fea69ee5911..1447a2e6165 100644 --- a/doc/build/dts/bindings-syntax.rst +++ b/doc/build/dts/bindings-syntax.rst @@ -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: