Skip to content

Commit 56296bb

Browse files
mbolivarkartben
authored andcommitted
doc: contribute: DTS style guideline updates
This is a follow-up from a recent debate on Discord about whether splitting up related groups of properties is OK. Record the consensus outcome of the debate so this question is easier to answer next time. Signed-off-by: Martí Bolívar <[email protected]>
1 parent 74f6f7f commit 56296bb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/contribute/style/devicetree.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ Devicetree Style Guidelines
55

66
* Indent with tabs.
77
* Follow the Devicetree specification conventions and rules.
8+
* If the Linux kernel rules in
9+
`Devicetree Sources (DTS) Coding Style <https://docs.kernel.org/devicetree/bindings/dts-coding-style.html>`_
10+
make a recommendation, it's the preferred style in Zephyr too.
11+
* You can split related groups of properties into "paragraphs" by
12+
separating them with one empty line (two newline characters) if it aids
13+
readability.
814
* Use dashes (``-``) as word separators for node and property names.
915
* Use underscores (``_``) as word separators in node labels.
1016
* Leave a single space on each side of the equal sign (``=``) in property

0 commit comments

Comments
 (0)