Re: [PATCH net-next v4 1/7] dt-bindings: net: dsa: Require ports or ethernet-ports

From: "Russell King (Oracle)" <linux@armlinux.org.uk>
To: Conor Dooley <conor@kernel.org>
Cc: Linus Walleij <linus.walleij@linaro.org>,
	Rob Herring <robh@kernel.org>,
	Christian Marangi <ansuelsmth@gmail.com>,
	Andrew Lunn <andrew@lunn.ch>,
	Florian Fainelli <f.fainelli@gmail.com>,
	linux-arm-kernel@lists.infradead.org,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	devicetree@vger.kernel.org, Conor Dooley <conor+dt@kernel.org>,
	Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>,
	Eric Dumazet <edumazet@google.com>,
	Vladimir Oltean <olteanv@gmail.com>,
	Rob Herring <robh+dt@kernel.org>,
	netdev@vger.kernel.org, Jakub Kicinski <kuba@kernel.org>,
	Paolo Abeni <pabeni@redhat.com>,
	"David S. Miller" <davem@davemloft.net>,
	linux-kernel@vger.kernel.org,
	Gregory Clement <gregory.clement@bootlin.com>
Subject: Re: [PATCH net-next v4 1/7] dt-bindings: net: dsa: Require ports or ethernet-ports
Date: Thu, 19 Oct 2023 13:27:09 +0100	[thread overview]
Message-ID: <ZTEgnUP0rFL2frkk@shell.armlinux.org.uk> (raw)
In-Reply-To: <20231019-pulse-autopilot-166bb6c96090@spud>

On Thu, Oct 19, 2023 at 12:58:46PM +0100, Conor Dooley wrote:
> On Thu, Oct 19, 2023 at 11:58:49AM +0100, Russell King (Oracle) wrote:
> > On Wed, Oct 18, 2023 at 01:11:45PM +0200, Linus Walleij wrote:
> > > On Wed, Oct 18, 2023 at 12:32 PM Rob Herring <robh@kernel.org> wrote:
> > > > On Wed, 18 Oct 2023 11:03:40 +0200, Linus Walleij wrote:
> > > 
> > > > > Bindings using dsa.yaml#/$defs/ethernet-ports specify that
> > > > > a DSA switch node need to have a ports or ethernet-ports
> > > > > subnode, and that is actually required, so add requirements
> > > > > using oneOf.
> > > > >
> > > > > Suggested-by: Rob Herring <robh@kernel.org>
> > > > > Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
> > > > > ---
> > > > >  Documentation/devicetree/bindings/net/dsa/dsa.yaml | 6 ++++++
> > > > >  1 file changed, 6 insertions(+)
> > > > >
> > > >
> > > > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> > > > on your patch (DT_CHECKER_FLAGS is new in v5.13):
> > > >
> > > > yamllint warnings/errors:
> > > > ./Documentation/devicetree/bindings/net/dsa/dsa.yaml:60:7: [warning] wrong indentation: expected 8 but found 6 (indentation)
> > > > ./Documentation/devicetree/bindings/net/dsa/dsa.yaml:62:7: [warning] wrong indentation: expected 8 but found 6 (indentation)
> > > 
> > > Really?
> > > 
> > > +  oneOf:
> > > +    - required:
> > > +      - ports
> > > +    - required:
> > > +      - ethernet-ports
> > > 
> > > Two spaces after the oneOf, 2 spaces after a required as usual.
> > > I don't get it.
> > 
> > Given the other python errors spat out in Rob's report, I would suggest
> > that the "bot" is running a development version that hasn't been fully
> > tested, so anything it spits out is suspect. Maybe Rob can comment on
> > the validity of the warnings in the report.
> 
> In this case, I think it is correct.
> 2 spaces for the oneOf, 2 spaces the start of the required for the
> nested list, so:
> oneOf:
>   - required:

This is a total of two spaces indentation.

>       - ports

This is a total of six spaces indentation.

You mention 2 spaces for the oneOf, which explains why the "- required"
needs to be indented by two spaces. You also say 2 spaces for the
required nested list, but what about the other two spaces?

I guess if you're a YAML expert, this all makes sense, but to those of
us who aren't, these quirky "features" of it just seem totally
illogical.

-- 
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTP is here! 80Mbps down 10Mbps up. Decent connectivity at last!

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel