linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
To: Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	 Conor Dooley <conor+dt@kernel.org>
Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
	 Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Subject: [PATCH v2 1/4] docs: dt: submitting-patches: Avoid 'YAML' in the subject and add an example
Date: Sun, 13 Jul 2025 14:46:36 +0200	[thread overview]
Message-ID: <20250713-dt-bindings-docs-v2-1-672c898054ae@linaro.org> (raw)
In-Reply-To: <20250713-dt-bindings-docs-v2-0-672c898054ae@linaro.org>

Patches adding new device bindings should avoid 'YAML' keyword in the
subject, because all bindings are supposed to be in DT schema format,
which uses YAML.  The DT schema is welcomed only in case of patches
doing conversion.  Effectively people get confused that subject should
not contain anything else than device name after the prefix, so add two
recommended examples.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

---

Changes in v2:
1. Rephrase - use YAML instead of schema, add another example for
   conversion.
---
 Documentation/devicetree/bindings/submitting-patches.rst | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index f3e23e69a6389e7e5d8db66af5060978ecff8a9d..46d0b036c97eb531dec95ef52261988d3bfa3aad 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -21,8 +21,16 @@ 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 "YAML" 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"
+
+     Conversion of other formats to DT schema::
+
+       "dt-bindings: iio: adc: adi,ad7476: Convert to DT schema"
 
   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


  reply	other threads:[~2025-07-13 12:46 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-13 12:46 [PATCH v2 0/4] docs: dt: Document established practices: compatible and file naming, subjects Krzysztof Kozlowski
2025-07-13 12:46 ` Krzysztof Kozlowski [this message]
2025-07-14 17:19   ` [PATCH v2 1/4] docs: dt: submitting-patches: Avoid 'YAML' in the subject and add an example Conor Dooley
2025-07-14 21:22   ` Rob Herring (Arm)
2025-07-13 12:46 ` [PATCH v2 2/4] docs: dt: writing-bindings: Document compatible and filename naming Krzysztof Kozlowski
2025-07-14 17:20   ` Conor Dooley
2025-07-14 21:22   ` Rob Herring (Arm)
2025-07-13 12:46 ` [PATCH v2 3/4] docs: dt: writing-bindings: Document discouraged instance IDs Krzysztof Kozlowski
2025-07-14 17:20   ` Conor Dooley
2025-07-14 21:22   ` Rob Herring (Arm)
2025-07-13 12:46 ` [PATCH v2 4/4] docs: dt: writing-schema: Document preferred order of properties Krzysztof Kozlowski
2025-07-14 17:20   ` Conor Dooley
2025-07-14 21:23   ` Rob Herring (Arm)

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=20250713-dt-bindings-docs-v2-1-672c898054ae@linaro.org \
    --to=krzysztof.kozlowski@linaro.org \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh@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).