From: Paul Walmsley <paul@pwsan.com>
To: Rob Herring <robherring2@gmail.com>
Cc: Mark Rutland <mark.rutland@arm.com>,
Alexandre Courbot <gnurou@gmail.com>,
Pawel Moll <pawel.moll@arm.com>,
Ian Campbell <ijc+devicetree@hellion.org.uk>,
"linux-pci@vger.kernel.org" <linux-pci@vger.kernel.org>,
Stephen Warren <swarren@wwwdotorg.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
Rob Herring <robh+dt@kernel.org>,
"devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
Thierry Reding <thierry.reding@gmail.com>,
Kumar Gala <galak@codeaurora.org>,
"linux-tegra@vger.kernel.org" <linux-tegra@vger.kernel.org>
Subject: Re: [PATCH 02/24] Documentation: DT bindings: add more chip compatible strings for Tegra PCIe
Date: Fri, 30 Jan 2015 03:07:12 +0000 (UTC) [thread overview]
Message-ID: <alpine.DEB.2.02.1501300306140.6569@utopia.booyaka.com> (raw)
In-Reply-To: <alpine.DEB.2.02.1501291846340.16475@utopia.booyaka.com>
Hi Rob
I've also updated the first patch, that tries to document what the DT
maintainers' expectations are. Care to give this one a quick glance too?
- Paul
From: Paul Walmsley <pwalmsley@nvidia.com>
Date: Wed, 28 Jan 2015 16:43:16 -0700
Subject: [PATCH] Documentation: DT: document compatible string existence
requirement
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.
This second version updates the documentation to align with
Rob's comments here:
http://marc.info/?l=devicetree&m=142255654213019&w=2
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 | 23 ++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
index b7ba01ad1426..56742bc70218 100644
--- a/Documentation/devicetree/bindings/submitting-patches.txt
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -15,6 +15,29 @@ 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"). ]
+
+ 5) The wildcard "<chip>" may be used in compatible strings, as in
+ the following example:
+
+ - compatible: Must contain '"nvidia,<chip>-pcie",
+ "nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
+
+ As in the above example, the known values of "<chip>" should be
+ documented if it is used.
+
+ 6) If a documented compatible string is not yet matched by the
+ driver, the documentation should also include a compatible
+ string that is matched by the driver (as in the "nvidia,tegra20-pcie"
+ example above).
+
+
II. For kernel maintainers
1) If you aren't comfortable reviewing a given binding, reply to it and ask
--
2.1.4
next prev parent reply other threads:[~2015-01-30 3:07 UTC|newest]
Thread overview: 39+ 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 ` [PATCH 08/24] Documentation: DT bindings: add more chip compatible strings for Tegra UART 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 ` [PATCH 02/24] Documentation: DT bindings: add more chip compatible strings for Tegra PCIe Paul Walmsley
2015-01-29 14:45 ` Rob Herring
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:29 ` Paul Walmsley
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 [this message]
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 ` [PATCH 01/24] Documentation: DT: document compatible string existence requirement Paul Walmsley
2015-01-29 16:43 ` Javier Martinez Canillas
2015-01-29 17:06 ` Paul Walmsley
2015-01-29 18:15 ` Rob Herring
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 ` [PATCH 09/24] Documentation: DT bindings: add more chip compatible strings for Tegra PWM 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 ` [PATCH 05/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHB gizmo 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 ` [PATCH 03/24] Documentation: DT bindings: add more chip compatible strings for Tegra SOR 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 ` [PATCH 14/24] Documentation: DT bindings: add more chip compatible strings for Tegra eFuse 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 ` [PATCH 13/24] Documentation: DT bindings: add more chip compatible strings for Tegra PMC 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 ` [PATCH 22/24] Documentation: DT bindings: add more chip compatible strings for Tegra EHCI 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 ` [PATCH 12/24] Documentation: DT bindings: add more chip compatible strings for Tegra RTC 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 ` [PATCH 15/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHCI 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 ` [PATCH 19/24] Documentation: DT bindings: add more chip compatible strings for Tegra SOC_THERM Paul Walmsley
2015-01-28 23:49 ` [PATCH 24/24] Documentation: DT bindings: add nvidia, denver compatible string Paul Walmsley
2015-01-29 14:36 ` Rob Herring
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=alpine.DEB.2.02.1501300306140.6569@utopia.booyaka.com \
--to=paul@pwsan.com \
--cc=devicetree@vger.kernel.org \
--cc=galak@codeaurora.org \
--cc=gnurou@gmail.com \
--cc=ijc+devicetree@hellion.org.uk \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=linux-tegra@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=pawel.moll@arm.com \
--cc=robh+dt@kernel.org \
--cc=robherring2@gmail.com \
--cc=swarren@wwwdotorg.org \
--cc=thierry.reding@gmail.com \
/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).