2023-12-29 05:48:16

by Rafał Miłecki

Subject: [PATCH] docs: dt-bindings: suggest "reg-names" position in DTS Coding Style

From: Rafał Miłecki <[email protected]>

Property "reg-names" is strictly related to "reg" so it should follow it
directly instead of falling into "Standard/common properties". This
helps reading DTS files.

Cc: Andrew Davis <[email protected]>
cc: Andrew Lunn <[email protected]>
Cc: AngeloGioacchino Del Regno <[email protected]>
Cc: Arnd Bergmann <[email protected]>
Cc: Bjorn Andersson <[email protected]>
Cc: Chen-Yu Tsai <[email protected]>
Cc: Dmitry Baryshkov <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: Matthias Brugger <[email protected]>
Cc: Michal Simek <[email protected]>
Cc: Neil Armstrong <[email protected]>
Cc: Nishanth Menon <[email protected]>
Cc: Olof Johansson <[email protected]>
Signed-off-by: Rafał Miłecki <[email protected]>
---
.../devicetree/bindings/dts-coding-style.rst | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/Documentation/devicetree/bindings/dts-coding-style.rst b/Documentation/devicetree/bindings/dts-coding-style.rst
index a9bdd2b59dca..1a48e2ca80e9 100644
--- a/Documentation/devicetree/bindings/dts-coding-style.rst
+++ b/Documentation/devicetree/bindings/dts-coding-style.rst
@@ -116,12 +116,13 @@ The following order of properties in device nodes is preferred:

1. "compatible"
2. "reg"
-3. "ranges"
-4. Standard/common properties (defined by common bindings, e.g. without
+3. "reg-names"
+4. "ranges"
+5. Standard/common properties (defined by common bindings, e.g. without
vendor-prefixes)
-5. Vendor-specific properties
-6. "status" (if applicable)
-7. Child nodes, where each node is preceded with a blank line
+6. Vendor-specific properties
+7. "status" (if applicable)
+8. Child nodes, where each node is preceded with a blank line

The "status" property is by default "okay", thus it can be omitted.

--
2.35.3

2023-12-30 14:31:51

by Krzysztof Kozlowski

Subject: Re: [PATCH] docs: dt-bindings: suggest "reg-names" position in DTS Coding Style

On 29/12/2023 06:47, Rafał Miłecki wrote:
> From: Rafał Miłecki <[email protected]>
>
> Property "reg-names" is strictly related to "reg" so it should follow it
> directly instead of falling into "Standard/common properties". This
> helps reading DTS files.

All 'xxx-names' should immediately follow 'xxx'. Instead of this change,
just add a note at the bottom of this section?

Best regards,
Krzysztof