Re: [PATCH 1/2] dt-bindings: watchdog: re-order entries to match coding convention

From: Rob Herring
Date: Wed Nov 08 2023 - 11:40:19 EST


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