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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20231229054711.17317-1-zajec5@gmail.com>
Date: Fri, 29 Dec 2023 06:47:11 +0100
From: Rafał Miłecki <zajec5@...il.com>
To: Rob Herring <robh+dt@...nel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
	Conor Dooley <conor+dt@...nel.org>
Cc: Geert Uytterhoeven <geert+renesas@...der.be>,
	Konrad Dybcio <konradybcio@...nel.org>,
	devicetree@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	linux-doc@...r.kernel.org,
	Rafał Miłecki <rafal@...ecki.pl>,
	Andrew Davis <afd@...com>,
	Andrew Lunn <andrew@...n.ch>,
	AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>,
	Arnd Bergmann <arnd@...db.de>,
	Bjorn Andersson <andersson@...nel.org>,
	Chen-Yu Tsai <wens@...nel.org>,
	Dmitry Baryshkov <dmitry.baryshkov@...aro.org>,
	Jonathan Corbet <corbet@....net>,
	Matthias Brugger <matthias.bgg@...il.com>,
	Michal Simek <michal.simek@....com>,
	Neil Armstrong <neil.armstrong@...aro.org>,
	Nishanth Menon <nm@...com>,
	Olof Johansson <olof@...om.net>
Subject: [PATCH] docs: dt-bindings: suggest "reg-names" position in DTS Coding Style

From: Rafał Miłecki <rafal@...ecki.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@...com>
cc: Andrew Lunn <andrew@...n.ch>
Cc: AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>
Cc: Arnd Bergmann <arnd@...db.de>
Cc: Bjorn Andersson <andersson@...nel.org>
Cc: Chen-Yu Tsai <wens@...nel.org>
Cc: Dmitry Baryshkov <dmitry.baryshkov@...aro.org>
Cc: Jonathan Corbet <corbet@....net>
Cc: Matthias Brugger <matthias.bgg@...il.com>
Cc: Michal Simek <michal.simek@....com>
Cc: Neil Armstrong <neil.armstrong@...aro.org>
Cc: Nishanth Menon <nm@...com>
Cc: Olof Johansson <olof@...om.net>
Signed-off-by: Rafał Miłecki <rafal@...ecki.pl>
---
 .../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