[PATCH renesas-drivers] dt-bindings: misc: Fix logic analyzer bindings

[PATCH renesas-drivers] dt-bindings: misc: Fix logic analyzer bindings

[Geert Uytterhoeven]

When running "make dt_binding_check":

    Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml: properties:required: ['compatible', 'probe-gpios'] is not of type 'object', 'boolean'
    Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml: properties: {'enum': ['$ref', 'additionalItems', 'additionalProperties', 'allOf', 'anyOf', 'const', 'contains', 'default', 'dependencies', 'deprecated', 'description', 'else', 'enum', 'if', 'items', 'maxItems', 'maximum', 'minItems', 'minimum', 'multipleOf', 'not', 'oneOf', 'pattern', 'patternProperties', 'properties', 'propertyNames', 'required', 'then', 'unevaluatedProperties']} is not allowed for 'required'
      SCHEMA  Documentation/devicetree/bindings/processed-schema-examples.json
    Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml: ignoring, error in schema: properties: required
    warning: no schema found in file: Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml

and:

    Error: Documentation/devicetree/bindings/misc/gpio-logic-analyzer.example.dts:22.42-43 syntax error
    FATAL ERROR: Unable to parse input tree

Fix this by correcting the indentation of the "required" block, and
adding the missing include.

Fixes: 1c8e77fc12417023 ("misc: add simple logic analyzer using polling")
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 .../devicetree/bindings/misc/gpio-logic-analyzer.yaml      | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml b/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml
index e664cec85a72facd..5516f95b72d53ff1 100644
--- a/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml
+++ b/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml
@@ -22,14 +22,15 @@ properties:
     description:
       names used to distinguish the probes
 
-  required:
-    - compatible
-    - probe-gpios
+required:
+  - compatible
+  - probe-gpios
 
 additionalProperties: false
 
 examples:
   - |
+    #include <dt-bindings/gpio/gpio.h>
     i2c-analyzer {
             compatible = "gpio-logic-analyzer";
 
-- 
2.25.1

Re: [PATCH renesas-drivers] dt-bindings: misc: Fix logic analyzer bindings

[Niklas Söderlund]

Hi Geert,

Thanks for your work.

On 2021-04-29 11:30:37 +0200, Geert Uytterhoeven wrote:
> When running "make dt_binding_check":
> 
>     Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml: properties:required: ['compatible', 'probe-gpios'] is not of type 'object', 'boolean'
>     Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml: properties: {'enum': ['$ref', 'additionalItems', 'additionalProperties', 'allOf', 'anyOf', 'const', 'contains', 'default', 'dependencies', 'deprecated', 'description', 'else', 'enum', 'if', 'items', 'maxItems', 'maximum', 'minItems', 'minimum', 'multipleOf', 'not', 'oneOf', 'pattern', 'patternProperties', 'properties', 'propertyNames', 'required', 'then', 'unevaluatedProperties']} is not allowed for 'required'
>       SCHEMA  Documentation/devicetree/bindings/processed-schema-examples.json
>     Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml: ignoring, error in schema: properties: required
>     warning: no schema found in file: Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml
> 
> and:
> 
>     Error: Documentation/devicetree/bindings/misc/gpio-logic-analyzer.example.dts:22.42-43 syntax error
>     FATAL ERROR: Unable to parse input tree
> 
> Fix this by correcting the indentation of the "required" block, and
> adding the missing include.
> 
> Fixes: 1c8e77fc12417023 ("misc: add simple logic analyzer using polling")
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Reviewed-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>

> ---
>  .../devicetree/bindings/misc/gpio-logic-analyzer.yaml      | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml b/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml
> index e664cec85a72facd..5516f95b72d53ff1 100644
> --- a/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml
> +++ b/Documentation/devicetree/bindings/misc/gpio-logic-analyzer.yaml
> @@ -22,14 +22,15 @@ properties:
>      description:
>        names used to distinguish the probes
>  
> -  required:
> -    - compatible
> -    - probe-gpios
> +required:
> +  - compatible
> +  - probe-gpios
>  
>  additionalProperties: false
>  
>  examples:
>    - |
> +    #include <dt-bindings/gpio/gpio.h>
>      i2c-analyzer {
>              compatible = "gpio-logic-analyzer";
>  
> -- 
> 2.25.1
> 

-- 
Regards,
Niklas Söderlund

Re: [PATCH renesas-drivers] dt-bindings: misc: Fix logic analyzer bindings

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 255 bytes --]


> Fix this by correcting the indentation of the "required" block, and
> adding the missing include.

Thank you! But this file is going to be removed in v2. I agree with
LinusW and the GPIO crowd that bindings for debugging do not need to be
"official".


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH renesas-drivers] dt-bindings: misc: Fix logic analyzer bindings

[Geert Uytterhoeven]

Hi Wolfram,

On Thu, Apr 29, 2021 at 3:33 PM Wolfram Sang
<wsa+renesas@sang-engineering.com> wrote:
> > Fix this by correcting the indentation of the "required" block, and
> > adding the missing include.
>
> Thank you! But this file is going to be removed in v2. I agree with
> LinusW and the GPIO crowd that bindings for debugging do not need to be
> "official".

I understand.

I fixed it because it was bugging people working on Renesas DT bindings.

Gr{oetje,eeting}s,

                        Geert

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds