From: Rob Herring <robh@kernel.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Cc: Krzysztof Kozlowski <krzk+dt@kernel.org>,
Conor Dooley <conor+dt@kernel.org>,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: dt: submitting-patches: Avoid 'schema' in subject and add an example
Date: Thu, 10 Jul 2025 17:44:19 -0500 [thread overview]
Message-ID: <20250710224419.GA10902-robh@kernel.org> (raw)
In-Reply-To: <20250710085814.21810-2-krzysztof.kozlowski@linaro.org>
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@linaro.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
>
next prev parent reply other threads:[~2025-07-10 22:44 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-10 8:58 [PATCH] docs: dt: submitting-patches: Avoid 'schema' in subject and add an example Krzysztof Kozlowski
2025-07-10 22:44 ` Rob Herring [this message]
2025-07-13 10:46 ` Krzysztof Kozlowski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250710224419.GA10902-robh@kernel.org \
--to=robh@kernel.org \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=krzk+dt@kernel.org \
--cc=krzysztof.kozlowski@linaro.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).