From: Dragan Simic <dsimic@manjaro.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Cc: "Rob Herring" <robh+dt@kernel.org>,
"Krzysztof Kozlowski" <krzysztof.kozlowski+dt@linaro.org>,
"Conor Dooley" <conor+dt@kernel.org>,
"Matthias Brugger" <matthias.bgg@gmail.com>,
"AngeloGioacchino Del Regno"
<angelogioacchino.delregno@collabora.com>,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linux-mediatek@lists.infradead.org, "Andrew Davis" <afd@ti.com>,
"Andrew Lunn" <andrew@lunn.ch>, "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>,
"Michal Simek" <michal.simek@amd.com>,
"Neil Armstrong" <neil.armstrong@linaro.org>,
"Nishanth Menon" <nm@ti.com>, "Olof Johansson" <olof@lixom.net>,
"Rafał Miłecki" <zajec5@gmail.com>,
"Heiko Stuebner" <heiko@sntech.de>,
"Laurent Pinchart" <laurent.pinchart@ideasonboard.com>,
"Konrad Dybcio" <konradybcio@kernel.org>,
"Geert Uytterhoeven" <geert+renesas@glider.be>,
linux-rockchip@lists.infradead.org,
linux-samsung-soc@vger.kernel.org,
linux-amlogic@lists.infradead.org, linux-arm-msm@vger.kernel.org,
workflows@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH v4] docs: dt-bindings: add DTS Coding Style document
Date: Sun, 03 Dec 2023 21:25:54 +0100 [thread overview]
Message-ID: <2223b302fc43959a61578aae9cc3a15a@manjaro.org> (raw)
In-Reply-To: <20231203174622.18402-1-krzysztof.kozlowski@linaro.org>
> +Order of Properties in Device Node
> +----------------------------------
> +
> +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
> + vendor-prefixes)
> +5. Vendor-specific properties
> +6. status (if applicable)
> +7. Child nodes, where each node is preceded with a blank line
Another small suggestion... It would be good to put the property names
found in the list items, such as "compatible" and "status", into
quotation marks, to make it obvious what they are. That way, the list
would also be more consistent with the property names mentioned in the
sentence right below.
> +
> +The "status" property is by default "okay", thus it can be omitted.
> +
> +The above-described ordering follows this approach:
> +
> +1. Most important properties start the node: compatible then bus
> addressing to
> + match unit address.
> +2. Each node will have common properties in similar place.
> +3. Status is the last information to annotate that device node is or
> is not
> + finished (board resources are needed).
next prev parent reply other threads:[~2023-12-03 20:25 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-03 17:46 [PATCH v4] docs: dt-bindings: add DTS Coding Style document Krzysztof Kozlowski
2023-12-03 18:40 ` Francesco Dolcini
2023-12-03 20:25 ` Dragan Simic [this message]
2023-12-04 15:15 ` Krzysztof Kozlowski
2023-12-04 12:13 ` AngeloGioacchino Del Regno
2023-12-04 17:33 ` Conor Dooley
2023-12-07 17:58 ` Rob Herring
2023-12-08 4:49 ` Florian Fainelli
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=2223b302fc43959a61578aae9cc3a15a@manjaro.org \
--to=dsimic@manjaro.org \
--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=heiko@sntech.de \
--cc=konradybcio@kernel.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=krzysztof.kozlowski@linaro.org \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-amlogic@lists.infradead.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mediatek@lists.infradead.org \
--cc=linux-rockchip@lists.infradead.org \
--cc=linux-samsung-soc@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=robh+dt@kernel.org \
--cc=wens@kernel.org \
--cc=workflows@vger.kernel.org \
--cc=zajec5@gmail.com \
/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).