From: Paul Walmsley <paul@pwsan.com>
Cc: Mark Rutland <mark.rutland@arm.com>,
devicetree@vger.kernel.org, Pawel Moll <pawel.moll@arm.com>,
Ian Campbell <ijc+devicetree@hellion.org.uk>,
Jonathan Corbet <corbet@lwn.net>,
linux-kernel@vger.kernel.org, Rob Herring <robh+dt@kernel.org>,
Paul Walmsley <pwalmsley@nvidia.com>,
Kumar Gala <galak@codeaurora.org>,
Javier Martinez Canillas <javier.martinez@collabora.co.uk>
Subject: [PATCH 01/24] Documentation: DT: document compatible string existence requirement
Date: Wed, 28 Jan 2015 16:49:37 -0700 [thread overview]
Message-ID: <20150128234936.20644.76672.stgit@dusk.lan> (raw)
In-Reply-To: <20150128234935.20644.89300.stgit@dusk.lan>
DT maintainers require all compatible strings used in chip or board
DTS file to be previously documented somewhere in
Documentation/devicetree/bindings, per:
http://marc.info/?l=linux-tegra&m=142201349727836&w=2
Document this requirement in the DT patch submission requirements
text file.
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Pawel Moll <pawel.moll@arm.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
Cc: Kumar Gala <galak@codeaurora.org>
Cc: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Paul Walmsley <pwalmsley@nvidia.com>
Cc: devicetree@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
---
.../devicetree/bindings/submitting-patches.txt | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
index b7ba01ad1426..4b2bbb6047c4 100644
--- a/Documentation/devicetree/bindings/submitting-patches.txt
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -15,6 +15,14 @@ I. For patch submitters
3) The Documentation/ portion of the patch should come in the series before
the code implementing the binding.
+ 4) Any compatible strings used in a chip or board DTS file must be
+ previously documented in the corresponding DT binding text file
+ in Documentation/devicetree/bindings. This rule applies even if
+ the Linux device driver does not yet match on the compatible
+ string. checkpatch will emit warnings if this step is not
+ followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
+ ("checkpatch: add DT compatible string documentation checks").
+
II. For kernel maintainers
1) If you aren't comfortable reviewing a given binding, reply to it and ask
WARNING: multiple messages have this Message-ID (diff)
From: Paul Walmsley <paul@pwsan.com>
To: unlisted-recipients:; (no To-header on input)
Cc: Mark Rutland <mark.rutland@arm.com>,
devicetree@vger.kernel.org, Pawel Moll <pawel.moll@arm.com>,
Ian Campbell <ijc+devicetree@hellion.org.uk>,
Jonathan Corbet <corbet@lwn.net>,
linux-kernel@vger.kernel.org, Rob Herring <robh+dt@kernel.org>,
Paul Walmsley <pwalmsley@nvidia.com>,
Kumar Gala <galak@codeaurora.org>,
Javier Martinez Canillas <javier.martinez@collabora.co.uk>
Subject: [PATCH 01/24] Documentation: DT: document compatible string existence requirement
Date: Wed, 28 Jan 2015 16:49:37 -0700 [thread overview]
Message-ID: <20150128234936.20644.76672.stgit@dusk.lan> (raw)
In-Reply-To: <20150128234935.20644.89300.stgit@dusk.lan>
DT maintainers require all compatible strings used in chip or board
DTS file to be previously documented somewhere in
Documentation/devicetree/bindings, per:
http://marc.info/?l=linux-tegra&m=142201349727836&w=2
Document this requirement in the DT patch submission requirements
text file.
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Pawel Moll <pawel.moll@arm.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
Cc: Kumar Gala <galak@codeaurora.org>
Cc: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Paul Walmsley <pwalmsley@nvidia.com>
Cc: devicetree@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
---
.../devicetree/bindings/submitting-patches.txt | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
index b7ba01ad1426..4b2bbb6047c4 100644
--- a/Documentation/devicetree/bindings/submitting-patches.txt
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -15,6 +15,14 @@ I. For patch submitters
3) The Documentation/ portion of the patch should come in the series before
the code implementing the binding.
+ 4) Any compatible strings used in a chip or board DTS file must be
+ previously documented in the corresponding DT binding text file
+ in Documentation/devicetree/bindings. This rule applies even if
+ the Linux device driver does not yet match on the compatible
+ string. checkpatch will emit warnings if this step is not
+ followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
+ ("checkpatch: add DT compatible string documentation checks").
+
II. For kernel maintainers
1) If you aren't comfortable reviewing a given binding, reply to it and ask
next prev parent reply other threads:[~2015-01-28 23:49 UTC|newest]
Thread overview: 74+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-28 23:49 Documentation: DT bindings: update DT binding docs with Tegra chips Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 04/24] Documentation: DT bindings: add more chip compatible strings for Tegra timers Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley [this message]
2015-01-28 23:49 ` [PATCH 01/24] Documentation: DT: document compatible string existence requirement Paul Walmsley
[not found] ` <20150128234936.20644.76672.stgit-orwA252wQtA@public.gmane.org>
2015-01-29 16:43 ` Javier Martinez Canillas
2015-01-29 16:43 ` Javier Martinez Canillas
2015-01-29 17:06 ` Paul Walmsley
2015-01-29 17:06 ` Paul Walmsley
[not found] ` <54CA6331.3010909-ZGY8ohtN/8pPYcu2f3hruQ@public.gmane.org>
2015-01-29 18:15 ` Rob Herring
2015-01-29 18:15 ` Rob Herring
2015-01-28 23:49 ` [PATCH 08/24] Documentation: DT bindings: add more chip compatible strings for Tegra UART Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 03/24] Documentation: DT bindings: add more chip compatible strings for Tegra SOR Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 02/24] Documentation: DT bindings: add more chip compatible strings for Tegra PCIe Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-29 14:45 ` Rob Herring
2015-01-29 15:45 ` Paul Walmsley
2015-01-29 15:45 ` Paul Walmsley
2015-01-29 16:44 ` Rob Herring
2015-01-29 17:08 ` Paul Walmsley
2015-01-29 17:08 ` Paul Walmsley
2015-01-29 17:29 ` Paul Walmsley
2015-01-29 18:34 ` Rob Herring
2015-01-29 18:34 ` Rob Herring
2015-01-29 18:49 ` Paul Walmsley
2015-01-30 3:06 ` Paul Walmsley
2015-01-30 3:07 ` Paul Walmsley
2015-01-30 3:07 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 10/24] Documentation: DT bindings: add more chip compatible strings for Tegra I2C Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 11/24] Documentation: DT bindings: add more chip compatible strings for Tegra SPI Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 14/24] Documentation: DT bindings: add more chip compatible strings for Tegra eFuse Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 20/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHUB Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 21/24] Documentation: DT bindings: add more chip compatible strings for Tegra I2S Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 18/24] Documentation: DT bindings: add more chip compatible strings for Tegra SDHCI Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 22/24] Documentation: DT bindings: add more chip compatible strings for Tegra EHCI Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 19/24] Documentation: DT bindings: add more chip compatible strings for Tegra SOC_THERM Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 13/24] Documentation: DT bindings: add more chip compatible strings for Tegra PMC Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 12/24] Documentation: DT bindings: add more chip compatible strings for Tegra RTC Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
[not found] ` <20150128234935.20644.89300.stgit-orwA252wQtA@public.gmane.org>
2015-01-28 23:49 ` [PATCH 09/24] Documentation: DT bindings: add more chip compatible strings for Tegra PWM Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 05/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHB gizmo Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 07/24] Documentation: DT bindings: add more chip compatible strings for Tegra124 pinmux Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 06/24] Documentation: DT bindings: add more chip compatible strings for Tegra APB_MISC Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 23/24] Documentation: DT bindings: add more chip compatible strings for Tegra USB PHY Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 17/24] Documentation: DT bindings: add more chip compatible strings for Tegra XUSB pad control Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 16/24] Documentation: DT bindings: add more chip compatible strings for Tegra HDA Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 15/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHCI Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 24/24] Documentation: DT bindings: add nvidia, denver compatible string Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-28 23:49 ` Paul Walmsley
2015-01-29 14:36 ` Rob Herring
2015-01-29 14:36 ` Rob Herring
2015-01-30 19:33 ` Paul Walmsley
2015-01-30 19:33 ` Paul Walmsley
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=20150128234936.20644.76672.stgit@dusk.lan \
--to=paul@pwsan.com \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=galak@codeaurora.org \
--cc=ijc+devicetree@hellion.org.uk \
--cc=javier.martinez@collabora.co.uk \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=pawel.moll@arm.com \
--cc=pwalmsley@nvidia.com \
--cc=robh+dt@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.