diff mbox series

[2/2] docs: dt: submitting-patches: add commit subject prefix in reversed format

Message ID 20240108083750.16350-2-krzysztof.kozlowski@linaro.org
State Accepted
Headers show
Series [1/2] docs: dt: submitting-patches: drop outdated points to TXT format | expand

Checks

Context Check Description
robh/checkpatch success
robh/patch-applied success

Commit Message

Krzysztof Kozlowski Jan. 8, 2024, 8:37 a.m. UTC
ASoC, media, regulators and SPI subsystems prefer commits starting with
subsystem name (e.g. "spi: dt-bindings:"), so document this to avoid
confusing contributors.

Cc: Mark Brown <broonie@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
 Documentation/devicetree/bindings/submitting-patches.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Mark Brown Jan. 8, 2024, 1:10 p.m. UTC | #1
On Mon, Jan 08, 2024 at 09:37:50AM +0100, Krzysztof Kozlowski wrote:
> ASoC, media, regulators and SPI subsystems prefer commits starting with
> subsystem name (e.g. "spi: dt-bindings:"), so document this to avoid
> confusing contributors.

Reviewed-by: Mark Brown <broonie@kernel.org>
Rob Herring (Arm) Jan. 13, 2024, 1:59 a.m. UTC | #2
On Mon, 08 Jan 2024 09:37:50 +0100, Krzysztof Kozlowski wrote:
> ASoC, media, regulators and SPI subsystems prefer commits starting with
> subsystem name (e.g. "spi: dt-bindings:"), so document this to avoid
> confusing contributors.
> 
> Cc: Mark Brown <broonie@kernel.org>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> ---
>  Documentation/devicetree/bindings/submitting-patches.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 

Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index b460ebffee42..a64f21a5f299 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -15,6 +15,11 @@  I. For patch submitters
 
        "dt-bindings: <binding dir>: ..."
 
+     Few subsystems, like ASoC, media, regulators and SPI, expect reverse order
+     of the prefixes::
+
+       "<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.