Skip to content

Commit 651fcd2

Browse files
krzkrobherring
authored andcommitted
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: Krzysztof Kozlowski <[email protected]> Reviewed-by: Conor Dooley <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Rob Herring (Arm) <[email protected]>
1 parent 26ff041 commit 651fcd2

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

Documentation/devicetree/bindings/submitting-patches.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,16 @@ I. For patch submitters
2121
"<binding dir>: dt-bindings: ..."
2222

2323
The 80 characters of the subject are precious. It is recommended to not
24-
use "Documentation" or "doc" because that is implied. All bindings are
25-
docs. Repeating "binding" again should also be avoided.
24+
use "Documentation", "doc" or "YAML" because that is implied. All
25+
bindings are docs and all new bindings are supposed to be in Devicetree
26+
schema format. Repeating "binding" again should also be avoided, so for
27+
a new device it is often enough for example::
28+
29+
"dt-bindings: iio: adc: Add ROHM BD79100G"
30+
31+
Conversion of other formats to DT schema::
32+
33+
"dt-bindings: iio: adc: adi,ad7476: Convert to DT schema"
2634

2735
2) DT binding files are written in DT schema format using json-schema
2836
vocabulary and YAML file format. The DT binding files must pass validation

0 commit comments

Comments
 (0)