docs: dt-bindings: add missing address/size-cells to example

[PATCH] docs: dt-bindings: add missing address/size-cells to example

Posted by Krzysztof Kozlowski 1 year, 10 months ago

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>

---

Cc: Tudor Ambarus <tudor.ambarus@linaro.org>
---
 Documentation/devicetree/bindings/dts-coding-style.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/devicetree/bindings/dts-coding-style.rst b/Documentation/devicetree/bindings/dts-coding-style.rst
index a9bdd2b59dca..8a68331075a0 100644
--- a/Documentation/devicetree/bindings/dts-coding-style.rst
+++ b/Documentation/devicetree/bindings/dts-coding-style.rst
@@ -144,6 +144,8 @@ Example::
 		#dma-cells = <1>;
 		clocks = <&clock_controller 0>, <&clock_controller 1>;
 		clock-names = "bus", "host";
+		#address-cells = <1>;
+		#size-cells = <1>;
 		vendor,custom-property = <2>;
 		status = "disabled";
 
-- 
2.34.1

Re: [PATCH] docs: dt-bindings: add missing address/size-cells to example

Posted by Rob Herring 1 year, 10 months ago

On Mon, 25 Mar 2024 10:11:39 +0100, Krzysztof Kozlowski wrote:
> 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>
> 
> ---
> 
> Cc: Tudor Ambarus <tudor.ambarus@linaro.org>
> ---
>  Documentation/devicetree/bindings/dts-coding-style.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 

Applied, thanks!

Re: [PATCH] docs: dt-bindings: add missing address/size-cells to example

Posted by Tudor Ambarus 1 year, 10 months ago

Hi, Krzysztof,


On 3/25/24 09:11, Krzysztof Kozlowski wrote:
> 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

some typo here

> confuse readers.
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> 
> ---
> 
> Cc: Tudor Ambarus <tudor.ambarus@linaro.org>
> ---
>  Documentation/devicetree/bindings/dts-coding-style.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/dts-coding-style.rst b/Documentation/devicetree/bindings/dts-coding-style.rst
> index a9bdd2b59dca..8a68331075a0 100644
> --- a/Documentation/devicetree/bindings/dts-coding-style.rst
> +++ b/Documentation/devicetree/bindings/dts-coding-style.rst
> @@ -144,6 +144,8 @@ Example::
>  		#dma-cells = <1>;
>  		clocks = <&clock_controller 0>, <&clock_controller 1>;
>  		clock-names = "bus", "host";
> +		#address-cells = <1>;
> +		#size-cells = <1>;

I propose having #address-cells and #size-cells after ranges, because
they are related:
https://devicetree-specification.readthedocs.io/en/stable/devicetree-basics.html#ranges

Looking good:
Reviewed-by: Tudor Ambarus <tudor.ambarus@linaro.org>

>  		vendor,custom-property = <2>;
>  		status = "disabled";
>