linux-kernel - Re: [PATCH] docs: dt: submitting-patches: Avoid 'schema' in subject and add an example

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250710224419.GA10902-robh@kernel.org>
Date: Thu, 10 Jul 2025 17:44:19 -0500
From: Rob Herring <robh@...nel.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
Cc: Krzysztof Kozlowski <krzk+dt@...nel.org>,
	Conor Dooley <conor+dt@...nel.org>, devicetree@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: dt: submitting-patches: Avoid 'schema' in subject
 and add an example

On Thu, Jul 10, 2025 at 10:58:15AM +0200, Krzysztof Kozlowski wrote:
> Subjects should avoid also 'schema' keyword, because all bindings are
> supposed to be in DT schema format.  Effectively people get confused
> that subject should not contain anything else than device name after the
> prefix, so add a recommended example.

However, conversions should because if you say don't say schema, then 
people will say YAML which I don't prefer. I prefer "convert foo to DT 
schema" as lots of things are YAML and only 1 thing is "DT schema".

> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
> ---
>  Documentation/devicetree/bindings/submitting-patches.rst | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
> index f3e23e69a638..bf32b784cb82 100644
> --- a/Documentation/devicetree/bindings/submitting-patches.rst
> +++ b/Documentation/devicetree/bindings/submitting-patches.rst
> @@ -21,8 +21,12 @@ I. For patch submitters
>         "<binding dir>: dt-bindings: ..."
>  
>       The 80 characters of the subject are precious. It is recommended to not
> -     use "Documentation" or "doc" because that is implied. All bindings are
> -     docs. Repeating "binding" again should also be avoided.
> +     use "Documentation", "doc" or "schema" because that is implied. All
> +     bindings are docs and all new bindings are supposed to be in Devicetree
> +     schema format.  Repeating "binding" again should also be avoided, so for
> +     a new device it is often enough for example::
> +
> +       "dt-bindings: iio: adc: Add ROHM BD79100G"
>  
>    2) DT binding files are written in DT schema format using json-schema
>       vocabulary and YAML file format. The DT binding files must pass validation
> -- 
> 2.43.0
>