Commit 651fcd25 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring (Arm)
Browse files

docs: dt: submitting-patches: Avoid 'YAML' in the subject and add an example 



Patches adding new device bindings should avoid 'YAML' keyword in the
subject, because all bindings are supposed to be in DT schema format,
which uses YAML.  The DT schema is welcomed only in case of patches
doing conversion.  Effectively people get confused that subject should
not contain anything else than device name after the prefix, so add two
recommended examples.

Signed-off-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reviewed-by: default avatarConor Dooley <conor.dooley@microchip.com>
Link: https://lore.kernel.org/r/20250713-dt-bindings-docs-v2-1-672c898054ae@linaro.org


Signed-off-by: default avatarRob Herring (Arm) <robh@kernel.org>
parent 26ff041e

Documentation/devicetree/bindings/submitting-patches.rst

+10 −2
Original line number Diff line number Diff line
@@ -21,8 +21,16 @@ I. For patch submitters 
       "<binding dir>: dt-bindings: ..."



     The 80 characters of the subject are precious. It is recommended to not

     use "Documentation" or "doc" because that is implied. All bindings are

     docs. Repeating "binding" again should also be avoided.

     use "Documentation", "doc" or "YAML" because that is implied. All

     bindings are docs and all new bindings are supposed to be in Devicetree

     schema format.  Repeating "binding" again should also be avoided, so for

     a new device it is often enough for example::



       "dt-bindings: iio: adc: Add ROHM BD79100G"



     Conversion of other formats to DT schema::



       "dt-bindings: iio: adc: adi,ad7476: Convert to DT schema"



  2) DT binding files are written in DT schema format using json-schema

     vocabulary and YAML file format. The DT binding files must pass validation