From: "Rafał Miłecki" <zajec5@gmail.com>
To: Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Conor Dooley <conor+dt@kernel.org>
Cc: "Geert Uytterhoeven" <geert+renesas@glider.be>,
"Konrad Dybcio" <konradybcio@kernel.org>,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-doc@vger.kernel.org, "Rafał Miłecki" <rafal@milecki.pl>,
"Andrew Davis" <afd@ti.com>, "Andrew Lunn" <andrew@lunn.ch>,
"AngeloGioacchino Del Regno"
<angelogioacchino.delregno@collabora.com>,
"Arnd Bergmann" <arnd@arndb.de>,
"Bjorn Andersson" <andersson@kernel.org>,
"Chen-Yu Tsai" <wens@kernel.org>,
"Dmitry Baryshkov" <dmitry.baryshkov@linaro.org>,
"Jonathan Corbet" <corbet@lwn.net>,
"Matthias Brugger" <matthias.bgg@gmail.com>,
"Michal Simek" <michal.simek@amd.com>,
"Neil Armstrong" <neil.armstrong@linaro.org>,
"Nishanth Menon" <nm@ti.com>, "Olof Johansson" <olof@lixom.net>
Subject: [PATCH] docs: dt-bindings: suggest "reg-names" position in DTS Coding Style
Date: Fri, 29 Dec 2023 06:47:11 +0100 [thread overview]
Message-ID: <20231229054711.17317-1-zajec5@gmail.com> (raw)
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(-)
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
next reply other threads:[~2023-12-29 5:48 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-29 5:47 Rafał Miłecki [this message]
2023-12-30 14:31 ` [PATCH] docs: dt-bindings: suggest "reg-names" position in DTS Coding Style Krzysztof Kozlowski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231229054711.17317-1-zajec5@gmail.com \
--to=zajec5@gmail.com \
--cc=afd@ti.com \
--cc=andersson@kernel.org \
--cc=andrew@lunn.ch \
--cc=angelogioacchino.delregno@collabora.com \
--cc=arnd@arndb.de \
--cc=conor+dt@kernel.org \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=dmitry.baryshkov@linaro.org \
--cc=geert+renesas@glider.be \
--cc=konradybcio@kernel.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=matthias.bgg@gmail.com \
--cc=michal.simek@amd.com \
--cc=neil.armstrong@linaro.org \
--cc=nm@ti.com \
--cc=olof@lixom.net \
--cc=rafal@milecki.pl \
--cc=robh+dt@kernel.org \
--cc=wens@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).