Re: [PATCH] dt-bindings: pwm: drop unneeded quotes

From: Uwe Kleine-König
Date: Mon Jun 12 2023 - 05:50:27 EST


Hello,

On Fri, Jun 09, 2023 at 04:07:09PM +0200, Krzysztof Kozlowski wrote:
> Cleanup bindings dropping unneeded quotes. Once all these are fixed,
> checking for this can be enabled in yamllint.

in my book quoting everything instead of dropping quotes is the better
option. While that policy adds more quotes, it prevents surprises like:

$ yaml2json << EOF
> countrycodes:
> - de
> - fr
> - no
> - pl
> EOF
{
"countrycodes": [
"de",
"fr",
false,
"pl"
]
}

And if you use the "only-when-needed" rule of yamllint you have to write
the above list as:

countrycodes:
- de
- fr
- "no"
- pl

which is IMHO really ugly.

Another culprit is "on" (which is used e.g. in github action workflows),
so yamllint tells for example for
https://github.com/pengutronix/microcom/blob/main/.github/workflows/build.yml:

3:1 warning truthy value should be one of [false, true] (truthy)

and there are still more surprises (e.g. version numbers might be
subject to conversion to float). So at least in my bubble the general
hint is to *always* quote strings. Note that required: true is also the
default for yamllint's quoted-strings setting, proably for pitfalls like
these.

Best regards
Uwe

--
Pengutronix e.K. | Uwe Kleine-König |
Industrial Linux Solutions | https://www.pengutronix.de/ |

Attachment: signature.asc
Description: PGP signature