devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH RFC] dt: bindings: submitting patches document
@ 2013-11-06 17:32 Jason Cooper
       [not found] ` <1383759120-21571-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
  0 siblings, 1 reply; 12+ messages in thread
From: Jason Cooper @ 2013-11-06 17:32 UTC (permalink / raw)
  To: Rob Herring, Grant Likely, Pawel Moll, Mark Rutland,
	Stephen Warren, Ian Campbell, Rob Landley
  Cc: Jason Cooper, devicetree-u79uwXL29TY76Z2rM5mHXA

Signed-off-by: Jason Cooper <jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
---
All,

Since I've now had to answer this question a couple of times, I thought it
might be worth trying to put it in a document.  I don't like long documents, so
this is pretty concise, and most likely wrong.  Hence, RFC.  :)

I also dislike quoting people from my imperfect memory, much better to have an
agreed upon document we can point people towards.

thx,

Jason.

 .../devicetree/bindings/submitting-patches.txt     | 52 ++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/submitting-patches.txt

diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
new file mode 100644
index 000000000000..5a84d5ebb0f5
--- /dev/null
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -0,0 +1,52 @@
+
+  Submitting devicetree (DT) binding patches
+
+I. For patch submitters
+
+  0) Normal patch submission rules from Documentation/SubmittingPatches
+     applies.
+
+  1) The Documentation/ portion of the patch should be a separate patch
+     and clearly labelled as such.  For example:
+
+       [PATCH X/Y] dt: binding: mvebu mbus driver
+
+     This makes the binding portion easy to find among large patch series.
+
+  2) Submit the entire series to the devicetree mailinglist at
+
+       devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
+
+II. For sub-system maintainers
+
+  1) If you aren't comfortable reviewing a given binding, reply to it and ask
+     the devicetree maintainers for guidance.  This will help them prioritize
+     which ones to review and which ones are ok to let go.
+
+  2) If you are comfortable with the binding, and it hasn't received an
+     Acked-by from the devicetree maintainers after a few weeks, go ahead and
+     take it.
+
+  3) For a series going though multiple trees, the binding patch should be
+     kept with the driver using the binding.
+
+III.  General binding rules
+
+  1) Don't hold up a binding because it isn't perfect.
+
+  2) Use specific compatible strings so that if we need to add a feature (DMA)
+     in the future, we can create a new compatible string.
+
+  3) Ideally, all bindings receive sufficient review.  In the real world, we
+     need to prioritize.  Bindings for a specific block of IP aren't as
+     critical as a binding for a common subsystem, like PCI.
+
+  4) Don't submit bindings for staging or unstable.  That will be decided by
+     the devicetree maintainers *after* discussion on the mailinglist.
+
+IV. Notes
+
+  This document is intended as a general familiarization with the process as
+  decided at the 2013 Kernel Summit.  When in doubt, the current word of the
+  devicetree maintainers overrules this document.  In that situation, a patch
+  updating this document would be appreciated.
-- 
1.8.4.2

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply related	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2014-01-20 22:31 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-11-06 17:32 [PATCH RFC] dt: bindings: submitting patches document Jason Cooper
     [not found] ` <1383759120-21571-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
2013-11-06 18:08   ` Kumar Gala
     [not found]     ` <94951083-8220-46EB-A96B-5FFF95D944EA-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org>
2013-11-06 18:10       ` Jason Cooper
2013-11-07 11:42   ` Nicolas Ferre
     [not found]     ` <527B7C94.7030708-AIFe0yeh4nAAvxtiuMwx3w@public.gmane.org>
2013-11-07 11:56       ` Jason Cooper
     [not found]         ` <20131107115604.GJ8308-u4khhh1J0LxI1Ri9qeTfzeTW4wlIGRCZ@public.gmane.org>
2013-11-07 15:26           ` Brian Austin
2013-11-07 18:53   ` [PATCH RFC V2] " Jason Cooper
2013-12-03 13:09   ` [PATCH RFC] " Grant Likely
2013-12-17 16:59   ` [PATCH V2] dt: bindings: submitting patches and ABI documents Jason Cooper
     [not found]     ` <1387299580-9100-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
2014-01-10 18:30       ` Jason Cooper
2014-01-10 23:34       ` Tomasz Figa
2014-01-20 22:31       ` Grant Likely

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).