diff mbox series

[2/2] dt-bindings: soc: qcom: eud: Fix identation issues in the example

Message ID 20230104091922.3959602-3-bhupesh.sharma@linaro.org
State New
Headers
Series Fix EUD dt-binding doc & sc7280 EUD node syntax |

Commit Message

Bhupesh Sharma Jan. 4, 2023, 9:19 a.m. UTC 
  As noted by Konrad while reviewing [1], the example
node in the EUD yaml documentation has identation
issues.

So fix them.

[1]. https://lore.kernel.org/linux-arm-msm/20221231131945.3286639-1-bhupesh.sharma@linaro.org

Signed-off-by: Bhupesh Sharma <bhupesh.sharma@linaro.org>
---
 Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

Rob Herring Jan. 5, 2023, 2:53 a.m. UTC | #1 
On Wed, 04 Jan 2023 14:49:22 +0530, Bhupesh Sharma wrote:
> As noted by Konrad while reviewing [1], the example
> node in the EUD yaml documentation has identation
> issues.
> 
> So fix them.
> 
> [1]. https://lore.kernel.org/linux-arm-msm/20221231131945.3286639-1-bhupesh.sharma@linaro.org
> 
> Signed-off-by: Bhupesh Sharma <bhupesh.sharma@linaro.org>
> ---
>  Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/soc/qcom/qcom,eud.example.dtb: eud@88e0000: reg: [[0, 143523840], [0, 8192], [0, 143532032], [0, 4096]] is too long
	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230104091922.3959602-3-bhupesh.sharma@linaro.org

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Bhupesh Sharma Jan. 6, 2023, 6:48 a.m. UTC | #2 
On Thu, 5 Jan 2023 at 08:24, Rob Herring <robh@kernel.org> wrote:
>
>
> On Wed, 04 Jan 2023 14:49:22 +0530, Bhupesh Sharma wrote:
> > As noted by Konrad while reviewing [1], the example
> > node in the EUD yaml documentation has identation
> > issues.
> >
> > So fix them.
> >
> > [1]. https://lore.kernel.org/linux-arm-msm/20221231131945.3286639-1-bhupesh.sharma@linaro.org
> >
> > Signed-off-by: Bhupesh Sharma <bhupesh.sharma@linaro.org>
> > ---
> >  Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml | 8 +++++---
> >  1 file changed, 5 insertions(+), 3 deletions(-)
> >
>
> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> on your patch (DT_CHECKER_FLAGS is new in v5.13):
>
> yamllint warnings/errors:
>
> dtschema/dtc warnings/errors:
> /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/soc/qcom/qcom,eud.example.dtb: eud@88e0000: reg: [[0, 143523840], [0, 8192], [0, 143532032], [0, 4096]] is too long
>         From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
>
> doc reference errors (make refcheckdocs):
>
> See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230104091922.3959602-3-bhupesh.sharma@linaro.org
>
> The base for the series is generally the latest rc1. A different dependency
> should be noted in *this* patch.
>
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure 'yamllint' is installed and dt-schema is up to
> date:
>
> pip3 install dtschema --upgrade
>
> Please check and re-submit after running the above command yourself. Note
> that DT_SCHEMA_FILES can be set to your schema file to speed up checking
> your schema. However, it must be unset to test all examples with your schema.

Ok, let me try and fix this via v2.

Thanks.
Rob Herring Jan. 8, 2023, 4:12 p.m. UTC | #3 
On Wed, Jan 04, 2023 at 02:49:22PM +0530, Bhupesh Sharma wrote:
> As noted by Konrad while reviewing [1], the example
> node in the EUD yaml documentation has identation
> issues.

I don't see any indentation changes...

> 
> So fix them.
> 
> [1]. https://lore.kernel.org/linux-arm-msm/20221231131945.3286639-1-bhupesh.sharma@linaro.org
> 
> Signed-off-by: Bhupesh Sharma <bhupesh.sharma@linaro.org>
> ---
>  Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml b/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
> index c98aab209bc5d..385ebd7cbbf0c 100644
> --- a/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
> +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
> @@ -55,9 +55,10 @@ additionalProperties: false
>  examples:
>    - |
>      eud@88e0000 {
> -           compatible = "qcom,sc7280-eud","qcom,eud";
> -           reg = <0x88e0000 0x2000>,
> -                 <0x88e2000 0x1000>;
> +           compatible = "qcom,sc7280-eud", "qcom,eud";
> +           reg = <0 0x88e0000 0 0x2000>,
> +                 <0 0x88e2000 0 0x1000>;
> +
>             ports {
>                     #address-cells = <1>;
>                     #size-cells = <0>;
> @@ -67,6 +68,7 @@ examples:
>                                     remote-endpoint = <&usb2_role_switch>;
>                             };
>                     };
> +
>                     port@1 {
>                             reg = <1>;
>                             eud_con: endpoint {
> -- 
> 2.38.1
> 
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml b/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
index c98aab209bc5d..385ebd7cbbf0c 100644
--- a/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
+++ b/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
@@ -55,9 +55,10 @@  additionalProperties: false
 examples:
   - |
     eud@88e0000 {
-           compatible = "qcom,sc7280-eud","qcom,eud";
-           reg = <0x88e0000 0x2000>,
-                 <0x88e2000 0x1000>;
+           compatible = "qcom,sc7280-eud", "qcom,eud";
+           reg = <0 0x88e0000 0 0x2000>,
+                 <0 0x88e2000 0 0x1000>;
+
            ports {
                    #address-cells = <1>;
                    #size-cells = <0>;
@@ -67,6 +68,7 @@  examples:
                                    remote-endpoint = <&usb2_role_switch>;
                            };
                    };
+
                    port@1 {
                            reg = <1>;
                            eud_con: endpoint {