diff mbox series

docs: dt-bindings: suggest "reg-names" position in DTS Coding Style

Message ID 20231229054711.17317-1-zajec5@gmail.com
State Changes Requested, archived
Headers show
Series docs: dt-bindings: suggest "reg-names" position in DTS Coding Style | expand

Checks

Context Check Description
robh/checkpatch success
robh/patch-applied fail build log

Commit Message

Rafał Miłecki Dec. 29, 2023, 5:47 a.m. UTC 
From: Rafał Miłecki <rafal@milecki.pl>

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 <afd@ti.com>
cc: Andrew Lunn <andrew@lunn.ch>
Cc: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Bjorn Andersson <andersson@kernel.org>
Cc: Chen-Yu Tsai <wens@kernel.org>
Cc: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Matthias Brugger <matthias.bgg@gmail.com>
Cc: Michal Simek <michal.simek@amd.com>
Cc: Neil Armstrong <neil.armstrong@linaro.org>
Cc: Nishanth Menon <nm@ti.com>
Cc: Olof Johansson <olof@lixom.net>
Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
---
 .../devicetree/bindings/dts-coding-style.rst          | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Krzysztof Kozlowski Dec. 30, 2023, 2:31 p.m. UTC | #1 
On 29/12/2023 06:47, Rafał Miłecki wrote:
> From: Rafał Miłecki <rafal@milecki.pl>
> 
> 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
diff mbox series

Patch

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.