David Heidelberg
527bb3a747
docs: dt-bindings: Extend the ordering list with a blank newline before status
...
For better readability, it is recommended to insert a newline before the
'status' property. Adjust the examples accordingly.
Signed-off-by: David Heidelberg <david@ixit.cz >
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org >
Link: https://patch.msgid.link/20251023-docs-dt-newline-v1-1-1bf5e0040c0b@ixit.cz
Signed-off-by: Rob Herring (Arm) <robh@kernel.org >
2025-11-17 11:24:50 -06:00
Dragan Simic
18d00558e8
docs: dt-bindings: Specify ordering for properties within groups
...
Ordering of the individual properties inside each property group benefits
from applying natural sort order [1] by the property names, because it
results in more logical and more usable property lists, similarly to what's
already the case with the alpha-numerical ordering of the nodes without
unit addresses.
Let's have this clearly specified in the DTS coding style, and let's expand
the provided node example a bit, to actually show the results of applying
natural sort order.
Applying strict alpha-numerical ordering can result in property lists that
are suboptimal from the usability standpoint. For the provided example,
which stems from a real-world DT, [2][3][4] applying strict alpha-numerical
ordering produces the following undesirable result:
vdd-0v9-supply = <&board_vreg1>;
vdd-12v-supply = <&board_vreg3>;
vdd-1v8-supply = <&board_vreg4>;
vdd-3v3-supply = <&board_vreg2>;
Having the properties sorted in natural order by their associated voltages
is more logical, more usable, and a bit more consistent.
[1] https://en.wikipedia.org/wiki/Natural_sort_order
[2] https://lore.kernel.org/linux-rockchip/b39cfd7490d8194f053bf3971f13a43472d1769e.1740941097.git.dsimic@manjaro.org/
[3] https://lore.kernel.org/linux-rockchip/174104113599.8946.16805724674396090918.b4-ty@sntech.de/
[4] https://lore.kernel.org/linux-rockchip/757afa87255212dfa5abf4c0e31deb08@manjaro.org/
Signed-off-by: Dragan Simic <dsimic@manjaro.org >
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org >
Link: https://lore.kernel.org/r/6468619098f94d8acb00de0431c414c5fcfbbdbf.1742532899.git.dsimic@manjaro.org
Signed-off-by: Rob Herring (Arm) <robh@kernel.org >
2025-03-21 11:27:56 -05:00
Krzysztof Kozlowski
1f744135f9
docs: dt-bindings: Document preferred line wrapping
...
There are some patches with long lines as a result of checkpatch
enforcing 100, not 80, but checkpatch is only a tool not a coding style.
The Linux Kernel Coding Style is still clear here on preferred limit.
Mentioned preferred style of wrapping long lines in DTS, based on Linux
Kernel Coding Style.
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org >
Link: https://lore.kernel.org/r/20250118102247.18257-1-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring (Arm) <robh@kernel.org >
2025-01-23 16:53:10 -06:00
Krzysztof Kozlowski
3d9b8e6db9
docs: dt-bindings: add missing address/size-cells to example
...
Complete the example of recommended order of properties by adding
missing address/size-cells. They are not necessary to illustrate the
style, but lack of them us bit really correct DTS code which might
confuse readers.
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org >
Reviewed-by: Tudor Ambarus <tudor.ambarus@linaro.org >
Link: https://lore.kernel.org/r/20240325091139.18602-1-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring <robh@kernel.org >
2024-03-25 11:09:12 -05:00
Krzysztof Kozlowski
83a368a3fc
docs: dt-bindings: add DTS Coding Style document
...
Document preferred coding style for Devicetree sources (DTS and DTSI),
to bring consistency among all (sub)architectures and ease in reviews.
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 >
Cc: Rafał Miłecki <zajec5@gmail.com >
Acked-by: Neil Armstrong <neil.armstrong@linaro.org >
Acked-by: Heiko Stuebner <heiko@sntech.de >
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com >
Acked-by: Konrad Dybcio <konradybcio@kernel.org >
Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be >
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org >
Reviewed-by: Conor Dooley <conor.dooley@microchip.com >
Reviewed-by: Francesco Dolcini <francesco.dolcini@toradex.com >
Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com >
Link: https://lore.kernel.org/r/20231203174622.18402-1-krzysztof.kozlowski@linaro.org
[robh: quote property names in order of properties section]
Signed-off-by: Rob Herring <robh@kernel.org >
2023-12-07 15:56:50 -06:00
