Re: [PATCH] dt-bindings: Whitespace clean-ups in schema files

Luca Ceresoli
2020-08-13T10:32:18Z

Hi Rob,

On 12/08/20 22:36, Rob Herring wrote:
> Clean-up incorrect indentation, extra spaces, long lines, and missing
> EOF newline in schema files. Most of the clean-ups are for list
> indentation which should always be 2 spaces more than the preceding
> keyword.
>
> Found with yamllint (which I plan to integrate into the checks).

[...]

> diff --git a/Documentation/devicetree/bindings/clock/idt,versaclock5.yaml b/Documentation/devicetree/bindings/clock/idt,versaclock5.yaml
> index 3d4e1685cc55..28c6461b9a9a 100644
> --- a/Documentation/devicetree/bindings/clock/idt,versaclock5.yaml
> +++ b/Documentation/devicetree/bindings/clock/idt,versaclock5.yaml
> @@ -95,10 +95,10 @@ allOf:
> # Devices without builtin crystal
> properties:
> clock-names:
> - minItems: 1
> - maxItems: 2
> - items:
> - enum: [ xin, clkin ]
> + minItems: 1
> + maxItems: 2
> + items:
> + enum: [ xin, clkin ]
> clocks:
> minItems: 1
> maxItems: 2

Thanks for noticing, LGTM.

[...]

> diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
> index d7dac16a3960..36dc7b56a453 100644
> --- a/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
> +++ b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
> @@ -33,8 +33,8 @@ properties:
> $ref: /schemas/types.yaml#/definitions/uint32
>
> touchscreen-min-pressure:
> - description: minimum pressure on the touchscreen to be achieved in order for the
> - touchscreen driver to report a touch event.
> + description: minimum pressure on the touchscreen to be achieved in order
> + for the touchscreen driver to report a touch event.

Out of personal taste, I find the original layout more pleasant and
readable. This third option is also good, especially for long descriptions:

description:
minimum pressure on the touchscreen to be achieved in order for the
touchscreen driver to report a touch event.

At first glance yamllint seems to support exactly these two by default:

> With indentation: {spaces: 4, check-multi-line-strings: true}
>
> the following code snippet would PASS:
>
> Blaise Pascal:
> Je vous écris une longue lettre parce que
> je n'ai pas le temps d'en écrire une courte.
>
> the following code snippet would PASS:
>
> Blaise Pascal: Je vous écris une longue lettre parce que
> je n'ai pas le temps d'en écrire une courte.
>
> the following code snippet would FAIL:
>
> Blaise Pascal: Je vous écris une longue lettre parce que
> je n'ai pas le temps d'en écrire une courte.
>
(https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.indentation)

--
Luca