| Message ID | 20231105184154.43700-1-krzysztof.kozlowski@linaro.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | [1/2] dt-bindings: watchdog: re-order entries to match coding convention | expand |
On 11/5/23 10:41, Krzysztof Kozlowski wrote: > The Devicetree bindings coding convention, as used in most of the files > and expressed in Documentation/devicetree/bindings/example-schema.yaml, > expects: > 1. "allOf:" block just before "properties:" (or after "required:" for > more complex cases), > 2. additionalProperties/unevaluatedProperties at the end of the file, > just before the examples section. > > Re-order few schemas to match the convention to avoid repeating review > comments for new patches using existing code as template. No functional > changes. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Acked-by: Guenter Roeck <linux@roeck-us.net> > --- > .../bindings/watchdog/allwinner,sun4i-a10-wdt.yaml | 6 +++--- > .../bindings/watchdog/alphascale,asm9260-wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/apple,wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/arm-smc-wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml | 10 +++++----- > .../devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/maxim,max63xx.yaml | 8 ++++---- > .../devicetree/bindings/watchdog/snps,dw-wdt.yaml | 10 +++++----- > 8 files changed, 29 insertions(+), 29 deletions(-) > > diff --git a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml > index 274519fc24fd..64c8f7393809 100644 > --- a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml > +++ b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml > @@ -6,13 +6,13 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# > > title: Allwinner A10 Watchdog > > -allOf: > - - $ref: watchdog.yaml# > - > maintainers: > - Chen-Yu Tsai <wens@csie.org> > - Maxime Ripard <mripard@kernel.org> > > +allOf: > + - $ref: watchdog.yaml# > + > properties: > compatible: > oneOf: > diff --git a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml > index fea84f5b7e6d..6425fe51d20c 100644 > --- a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml > +++ b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml > @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# > > title: Alphascale asm9260 Watchdog timer > > -allOf: > - - $ref: watchdog.yaml# > - > maintainers: > - Oleksij Rempel <linux@rempel-privat.de> > > +allOf: > + - $ref: watchdog.yaml# > + > properties: > compatible: > const: alphascale,asm9260-wdt > diff --git a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml > index 929681127df0..21872e15916c 100644 > --- a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml > +++ b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml > @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# > > title: Apple SoC Watchdog > > -allOf: > - - $ref: watchdog.yaml# > - > maintainers: > - Sven Peter <sven@svenpeter.dev> > > +allOf: > + - $ref: watchdog.yaml# > + > properties: > compatible: > items: > diff --git a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml > index b5573852ef5a..8e9d0b7e8244 100644 > --- a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml > +++ b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml > @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# > > title: ARM Secure Monitor Call based watchdog > > -allOf: > - - $ref: watchdog.yaml# > - > maintainers: > - Julius Werner <jwerner@chromium.org> > > +allOf: > + - $ref: watchdog.yaml# > + > properties: > compatible: > enum: > diff --git a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml > index 526ff908d134..e898167ef628 100644 > --- a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml > +++ b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml > @@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# > > title: BCM63xx and BCM7038 watchdog timer > > -allOf: > - - $ref: watchdog.yaml# > - > maintainers: > - Florian Fainelli <f.fainelli@gmail.com> > - Justin Chen <justinpopo6@gmail.com> > - Rafał Miłecki <rafal@milecki.pl> > > +allOf: > + - $ref: watchdog.yaml# > + > properties: > compatible: > enum: > @@ -29,11 +29,11 @@ properties: > The clock running the watchdog. If no clock is found the driver will > default to 27000000 Hz. > > -unevaluatedProperties: false > - > required: > - reg > > +unevaluatedProperties: false > + > examples: > - | > watchdog@f040a7e8 { > diff --git a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml > index 1844d7e026fe..13236ee61f6f 100644 > --- a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml > +++ b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml > @@ -12,12 +12,12 @@ description: | > timer counters. The first timer (called "Timer A") is the only one that can be > used as watchdog. > > -allOf: > - - $ref: watchdog.yaml# > - > maintainers: > - Baruch Siach <baruch@tkos.co.il> > > +allOf: > + - $ref: watchdog.yaml# > + > properties: > compatible: > const: cnxt,cx92755-wdt > diff --git a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml > index 1a6490c43d89..442c21f12a3b 100644 > --- a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml > +++ b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml > @@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# > > title: Maxim 63xx Watchdog Timers > > -allOf: > - - $ref: watchdog.yaml# > - - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml# > - > maintainers: > - Marc Zyngier <maz@kernel.org> > - Linus Walleij <linus.walleij@linaro.org> > > +allOf: > + - $ref: watchdog.yaml# > + - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml# > + > properties: > compatible: > enum: > diff --git a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml > index 76eceeddd150..c7aab0418a32 100644 > --- a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml > +++ b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml > @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# > > title: Synopsys Designware Watchdog Timer > > -allOf: > - - $ref: watchdog.yaml# > - > maintainers: > - Jamie Iles <jamie@jamieiles.com> > > +allOf: > + - $ref: watchdog.yaml# > + > properties: > compatible: > oneOf: > @@ -73,13 +73,13 @@ properties: > minItems: 16 > maxItems: 16 > > -unevaluatedProperties: false > - > required: > - compatible > - reg > - clocks > > +unevaluatedProperties: false > + > examples: > - | > watchdog@ffd02000 {
On 2023-11-05 19:41, Krzysztof Kozlowski wrote: > The Devicetree bindings coding convention, as used in most of the files > and expressed in Documentation/devicetree/bindings/example-schema.yaml, > expects: > 1. "allOf:" block just before "properties:" (or after "required:" for > more complex cases), > 2. additionalProperties/unevaluatedProperties at the end of the file, > just before the examples section. > > Re-order few schemas to match the convention to avoid repeating review > comments for new patches using existing code as template. No > functional > changes. It's surely going to help a bit but for a long time solution maybe you could consider adding proper check to Rob's bot and/or checkpatch.pl.
On Mon, Nov 06, 2023 at 09:10:44AM +0100, Rafał Miłecki wrote: > On 2023-11-05 19:41, Krzysztof Kozlowski wrote: > > The Devicetree bindings coding convention, as used in most of the files > > and expressed in Documentation/devicetree/bindings/example-schema.yaml, > > expects: > > 1. "allOf:" block just before "properties:" (or after "required:" for > > more complex cases), > > 2. additionalProperties/unevaluatedProperties at the end of the file, > > just before the examples section. > > > > Re-order few schemas to match the convention to avoid repeating review > > comments for new patches using existing code as template. No functional > > changes. > > It's surely going to help a bit but for a long time solution maybe you > could consider adding proper check to Rob's bot and/or checkpatch.pl. I have such a check I wrote long ago. tools/yaml-format in dtschema. It just does a ruamel read and write back out so you get exactly how ruamel is configured or defaults to for things not configurable. Primarily, the non-configurable part is multi-line text without a '|'. So lots of 'description' paragraphs are reformatted. It ends up being too strict IMO. The key order is checked, but not fixed. Probably could add reordering. Adding this by default (and to the bot) means fixing *every* file in tree first. That's not something I care to do and enforce. Rob
On Sun, 05 Nov 2023 19:41:53 +0100, Krzysztof Kozlowski wrote: > The Devicetree bindings coding convention, as used in most of the files > and expressed in Documentation/devicetree/bindings/example-schema.yaml, > expects: > 1. "allOf:" block just before "properties:" (or after "required:" for > more complex cases), > 2. additionalProperties/unevaluatedProperties at the end of the file, > just before the examples section. > > Re-order few schemas to match the convention to avoid repeating review > comments for new patches using existing code as template. No functional > changes. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > --- > .../bindings/watchdog/allwinner,sun4i-a10-wdt.yaml | 6 +++--- > .../bindings/watchdog/alphascale,asm9260-wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/apple,wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/arm-smc-wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml | 10 +++++----- > .../devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml | 6 +++--- > .../devicetree/bindings/watchdog/maxim,max63xx.yaml | 8 ++++---- > .../devicetree/bindings/watchdog/snps,dw-wdt.yaml | 10 +++++----- > 8 files changed, 29 insertions(+), 29 deletions(-) > Acked-by: Rob Herring <robh@kernel.org>
diff --git a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml index 274519fc24fd..64c8f7393809 100644 --- a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml +++ b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml @@ -6,13 +6,13 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# title: Allwinner A10 Watchdog -allOf: - - $ref: watchdog.yaml# - maintainers: - Chen-Yu Tsai <wens@csie.org> - Maxime Ripard <mripard@kernel.org> +allOf: + - $ref: watchdog.yaml# + properties: compatible: oneOf: diff --git a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml index fea84f5b7e6d..6425fe51d20c 100644 --- a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml +++ b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# title: Alphascale asm9260 Watchdog timer -allOf: - - $ref: watchdog.yaml# - maintainers: - Oleksij Rempel <linux@rempel-privat.de> +allOf: + - $ref: watchdog.yaml# + properties: compatible: const: alphascale,asm9260-wdt diff --git a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml index 929681127df0..21872e15916c 100644 --- a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml +++ b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# title: Apple SoC Watchdog -allOf: - - $ref: watchdog.yaml# - maintainers: - Sven Peter <sven@svenpeter.dev> +allOf: + - $ref: watchdog.yaml# + properties: compatible: items: diff --git a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml index b5573852ef5a..8e9d0b7e8244 100644 --- a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml +++ b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# title: ARM Secure Monitor Call based watchdog -allOf: - - $ref: watchdog.yaml# - maintainers: - Julius Werner <jwerner@chromium.org> +allOf: + - $ref: watchdog.yaml# + properties: compatible: enum: diff --git a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml index 526ff908d134..e898167ef628 100644 --- a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml +++ b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml @@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# title: BCM63xx and BCM7038 watchdog timer -allOf: - - $ref: watchdog.yaml# - maintainers: - Florian Fainelli <f.fainelli@gmail.com> - Justin Chen <justinpopo6@gmail.com> - Rafał Miłecki <rafal@milecki.pl> +allOf: + - $ref: watchdog.yaml# + properties: compatible: enum: @@ -29,11 +29,11 @@ properties: The clock running the watchdog. If no clock is found the driver will default to 27000000 Hz. -unevaluatedProperties: false - required: - reg +unevaluatedProperties: false + examples: - | watchdog@f040a7e8 { diff --git a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml index 1844d7e026fe..13236ee61f6f 100644 --- a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml +++ b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml @@ -12,12 +12,12 @@ description: | timer counters. The first timer (called "Timer A") is the only one that can be used as watchdog. -allOf: - - $ref: watchdog.yaml# - maintainers: - Baruch Siach <baruch@tkos.co.il> +allOf: + - $ref: watchdog.yaml# + properties: compatible: const: cnxt,cx92755-wdt diff --git a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml index 1a6490c43d89..442c21f12a3b 100644 --- a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml +++ b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml @@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# title: Maxim 63xx Watchdog Timers -allOf: - - $ref: watchdog.yaml# - - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml# - maintainers: - Marc Zyngier <maz@kernel.org> - Linus Walleij <linus.walleij@linaro.org> +allOf: + - $ref: watchdog.yaml# + - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml# + properties: compatible: enum: diff --git a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml index 76eceeddd150..c7aab0418a32 100644 --- a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml +++ b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml# title: Synopsys Designware Watchdog Timer -allOf: - - $ref: watchdog.yaml# - maintainers: - Jamie Iles <jamie@jamieiles.com> +allOf: + - $ref: watchdog.yaml# + properties: compatible: oneOf: @@ -73,13 +73,13 @@ properties: minItems: 16 maxItems: 16 -unevaluatedProperties: false - required: - compatible - reg - clocks +unevaluatedProperties: false + examples: - | watchdog@ffd02000 {
The Devicetree bindings coding convention, as used in most of the files and expressed in Documentation/devicetree/bindings/example-schema.yaml, expects: 1. "allOf:" block just before "properties:" (or after "required:" for more complex cases), 2. additionalProperties/unevaluatedProperties at the end of the file, just before the examples section. Re-order few schemas to match the convention to avoid repeating review comments for new patches using existing code as template. No functional changes. Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> --- .../bindings/watchdog/allwinner,sun4i-a10-wdt.yaml | 6 +++--- .../bindings/watchdog/alphascale,asm9260-wdt.yaml | 6 +++--- .../devicetree/bindings/watchdog/apple,wdt.yaml | 6 +++--- .../devicetree/bindings/watchdog/arm-smc-wdt.yaml | 6 +++--- .../devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml | 10 +++++----- .../devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml | 6 +++--- .../devicetree/bindings/watchdog/maxim,max63xx.yaml | 8 ++++---- .../devicetree/bindings/watchdog/snps,dw-wdt.yaml | 10 +++++----- 8 files changed, 29 insertions(+), 29 deletions(-)