diff mbox series

yamllint: Drop excluding quoted values with ',' from checks

Message ID 20240426195438.2771968-1-robh@kernel.org
State Under Review
Headers show
Series yamllint: Drop excluding quoted values with ',' from checks | expand

Checks

Context Check Description
robh/checkpatch success
robh/patch-applied success

Commit Message

Rob Herring (Arm) April 26, 2024, 7:54 p.m. UTC
From: Rob Herring <robh@kernel.org>

Strings with commas were excluded from checks because yamllint had false
positives for flow style maps and sequences which need quotes when
values contain commas. This issue has been fixed as of the 1.34 release,
so drop the work-around.

Signed-off-by: Rob Herring <robh@kernel.org>
---
 Documentation/devicetree/bindings/.yamllint | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Conor Dooley April 30, 2024, 5:40 p.m. UTC | #1
On Fri, Apr 26, 2024 at 02:54:37PM -0500, Rob Herring (Arm) wrote:
> From: Rob Herring <robh@kernel.org>
> 
> Strings with commas were excluded from checks because yamllint had false
> positives for flow style maps and sequences which need quotes when
> values contain commas. This issue has been fixed as of the 1.34 release,
> so drop the work-around.

Hmm, is this a bit aggressive of an upgrade? I only checked Debian since
it is what this machine uses, and it only seems to be shipping 1.33 in
testing & unstable.

> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  Documentation/devicetree/bindings/.yamllint | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/.yamllint b/Documentation/devicetree/bindings/.yamllint
> index 358c88813937..fadbc6ad3c76 100644
> --- a/Documentation/devicetree/bindings/.yamllint
> +++ b/Documentation/devicetree/bindings/.yamllint
> @@ -7,7 +7,7 @@ rules:
>    quoted-strings:
>      required: only-when-needed
>      extra-allowed:
> -      - '[$^,[]'
> +      - '[$^[]'
>        - '^/$'
>    line-length:
>      # 80 chars should be enough, but don't fail if a line is longer
> -- 
> 2.43.0
>
Rob Herring (Arm) April 30, 2024, 5:53 p.m. UTC | #2
On Tue, Apr 30, 2024 at 12:40 PM Conor Dooley <conor@kernel.org> wrote:
>
> On Fri, Apr 26, 2024 at 02:54:37PM -0500, Rob Herring (Arm) wrote:
> > From: Rob Herring <robh@kernel.org>
> >
> > Strings with commas were excluded from checks because yamllint had false
> > positives for flow style maps and sequences which need quotes when
> > values contain commas. This issue has been fixed as of the 1.34 release,
> > so drop the work-around.
>
> Hmm, is this a bit aggressive of an upgrade? I only checked Debian since
> it is what this machine uses, and it only seems to be shipping 1.33 in
> testing & unstable.

Humm, yeah and that's what the bot is running...

It's only required if you don't want warnings. The issue for me is if
we don't enable this, we get new cases we have to go fix. I could
enable it only on the bot (with some work), but then I get 'I ran the
checks and didn't see this'.

There is also a new check for quoted keys that I want to enable. I
haven't done that because then 1.34 is really required as yamllint
will error out on unknown (to older versions) checks. That's what
really drives the minimum version.

I'll hold off on this at least until it lands in debian.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/.yamllint b/Documentation/devicetree/bindings/.yamllint
index 358c88813937..fadbc6ad3c76 100644
--- a/Documentation/devicetree/bindings/.yamllint
+++ b/Documentation/devicetree/bindings/.yamllint
@@ -7,7 +7,7 @@  rules:
   quoted-strings:
     required: only-when-needed
     extra-allowed:
-      - '[$^,[]'
+      - '[$^[]'
       - '^/$'
   line-length:
     # 80 chars should be enough, but don't fail if a line is longer