From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 923EF1482ED; Tue, 21 May 2024 19:25:17 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1716319517; cv=none; b=sqS3kcOiNHbuLM50CNsHWMI7BdB3cTtx5GCujJAFfbWSpp72P86KbKXJatKbfe4pbsm6PXypsunoCClGhtA6bYl5Z8e1EYHYdyoEZp+IPEqFvtobkIBskTXKT0MrPoVJAxEYbLvZHSPdJduCVPTv1Z/6w/8p4tarrHrDSDOoTc8= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1716319517; c=relaxed/simple; bh=/uj3GUXyfLo4Vrzi4Pw65rRknHeZPOUliddFNscK1pU=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=DX0Uuou5vXzSuld5sEAxQF1kLEly9MksM4BLK6WDOCpJp2eBuZgyJfkY5Z+yNdZ9Ve0vgxoSvw2ymiPEd7UmdxAt1pOWHDXViH1bJRzLAcQr0GWZeOKJFcOcgIqh/b3QyC2kZ61cBUQa9poWceMJpjck1HSog7YDGbBeGd0TLgY= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=UZqh6xjl; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="UZqh6xjl" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 965CBC2BD11; Tue, 21 May 2024 19:25:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1716319517; bh=/uj3GUXyfLo4Vrzi4Pw65rRknHeZPOUliddFNscK1pU=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=UZqh6xjleq1x/201RKGlkzJPO0o3J+9BQ5HnvAotf/XRRuP7mi3UlCzAVqA7ZzjaM g/Ghhhxs8XRrKKRj3Dq2ctI15czSlexuoh+XuQQtRE5enoQm4btZ+6qrnacMoJS/pA vO8PSSCvz5wI3v7s1oBLYH3IGRNgEAyVYq3yewEu2OI4862GEb+/DmM1drc10Jmdpy nfj4OdU+dSV2pPVk5dcMd+kaSlTE+eoZY65clRruGfRh+tljfU1adnWHCOOzIMz+ne g3YEym47BccVM87KspovKS8tGj/VTsXtwAW+/SfwVy8YtKtZrtsmKJ5PFp7T1ZPF6s wjRgU4GkX/YOw== Date: Tue, 21 May 2024 20:25:10 +0100 From: Conor Dooley To: Elliot Berman Cc: Rob Herring , Frank Rowand , Krzysztof Kozlowski , Conor Dooley , Bjorn Andersson , Konrad Dybcio , Amrit Anand , Peter Griffin , Caleb Connolly , Andy Gross , Doug Anderson , Simon Glass , Chen-Yu Tsai , Julius Werner , "Humphreys, Jonathan" , Sumit Garg , Jon Hunter , Michal Simek , boot-architecture@lists.linaro.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-arm-msm@vger.kernel.org Subject: Re: [PATCH RFC v3 2/9] dt-bindings: board: Introduce board-id Message-ID: <20240521-unskilled-spindle-c4161092ae83@spud> References: <20240521-board-ids-v3-0-e6c71d05f4d2@quicinc.com> <20240521-board-ids-v3-2-e6c71d05f4d2@quicinc.com> <20240521-bonfire-backboned-9ef33c10d447@spud> Precedence: bulk X-Mailing-List: devicetree@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="HMNztt7rFbGkeMuD" Content-Disposition: inline In-Reply-To: <20240521-bonfire-backboned-9ef33c10d447@spud> --HMNztt7rFbGkeMuD Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Tue, May 21, 2024 at 08:21:45PM +0100, Conor Dooley wrote: > On Tue, May 21, 2024 at 11:37:59AM -0700, Elliot Berman wrote: > > Device manufcturers frequently ship multiple boards or SKUs under a > > single softwre package. These software packages ship multiple devicetree > > blobs and require some mechanims to pick the correct DTB for the boards > > that use the software package. >=20 > Okay, you've got the problem statement here, nice. >=20 > > This patch introduces a common language > > for adding board identifiers to devicetrees. >=20 > But then a completely useless remainder of the commit message. > I open this patch, see the regexes, say "wtf", look at the commit > message and there is absolutely no explanation of what these properties > are for. That's quite frankly just not good enough - even for an RFC. >=20 > >=20 > > Signed-off-by: Elliot Berman > > --- > > .../devicetree/bindings/board/board-id.yaml | 24 ++++++++++++++= ++++++++ > > 1 file changed, 24 insertions(+) > >=20 > > diff --git a/Documentation/devicetree/bindings/board/board-id.yaml b/Do= cumentation/devicetree/bindings/board/board-id.yaml > > new file mode 100644 > > index 000000000000..99514aef9718 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/board/board-id.yaml > > @@ -0,0 +1,24 @@ > > +# SPDX-License-Identifier: BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/board/board-id.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: board identifiers > > +description: Common property for board-id subnode >=20 > s/property/properties/ >=20 > > + > > +maintainers: > > + - Elliot Berman > > + > > +properties: > > + $nodename: > > + const: '/' > > + board-id: > > + type: object > > + patternProperties: > > + "^.*(?!_str)$": >=20 > Does this regex even work? Take "foo_str" as an example - doesn't "^.*" > consume all of the string, leaving the negative lookahead with nothing > to object to? I didn't properly test this with an example and the dt > tooling, but I lazily threw it into regex101 and both the python and > emcascript versions agree with me. Did you test this? >=20 > And while I am here, no underscores in property names please. And if > "str" means string, I suggest not saving 3 characters. >=20 > > + $ref: /schemas/types.yaml#/definitions/uint32-matrix > > + "^.*_str$": > > + $ref: /schemas/types.yaml#/definitions/string-array >=20 > Why do we even need two methods? Commit message tells me nothing and > there's no description at all... Why do we need regexes here, rather > than explicitly defined properties? Your commit message should explain > the justification for that and the property descriptions (as comments if > needs be for patternProperties) should explain why this is intended to > be used. >=20 > How is anyone supposed to look at this binding and understand how it > should be used? Also, please do not CC private mailing lists on your postings, I do not want to get spammed by linaro's mailman :( Thanks, Conor. --HMNztt7rFbGkeMuD Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iHQEABYIAB0WIQRh246EGq/8RLhDjO14tDGHoIJi0gUCZkz1FgAKCRB4tDGHoIJi 0uiAAQD9eJxsSq6+LCsqMOHFOpfgcQuXZlbReSj4uR+NjBuGBAD0CkG0ZrXIcSEC BXqPTAviNHbnx2hfx5hytC4pR02ACQ== =UPCe -----END PGP SIGNATURE----- --HMNztt7rFbGkeMuD--