Re: [PATCH v4] docs: dt-bindings: Specify ordering for properties within groups
From: Krzysztof Kozlowski
Date: Fri Mar 21 2025 - 05:24:59 EST
On 21/03/2025 05:57, Dragan Simic wrote:
> 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@xxxxxxxxxxx/
> [3] https://lore.kernel.org/linux-rockchip/174104113599.8946.16805724674396090918.b4-ty@xxxxxxxxx/
> [4] https://lore.kernel.org/linux-rockchip/757afa87255212dfa5abf4c0e31deb08@xxxxxxxxxxx/
>
> Signed-off-by: Dragan Simic <dsimic@xxxxxxxxxxx>
> ---
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@xxxxxxxxxx>
Best regards,
Krzysztof