Re: [PATCH] dt-bindings: Whitespace clean-ups in schema files
From: Luca Ceresoli <luca@lucaceresoli.net>
Date: 2020-08-13 10:31:39
Also in:
alsa-devel, dri-devel, linux-arm-kernel, linux-clk, linux-devicetree, linux-gpio, linux-hwmon, linux-i2c, linux-iio, linux-input, linux-media, linux-mmc, linux-pm, linux-remoteproc, linux-rtc, linux-serial, linux-spi, linux-usb, lkml, netdev
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).
[...]
quoted hunk
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. [...]
quoted hunk
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