All of lore.kernel.org
 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

* Re: [PATCH RFC] dt: bindings: submitting patches document
       [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-07 11:42   ` Nicolas Ferre
                     ` (3 subsequent siblings)
  4 siblings, 1 reply; 12+ messages in thread
From: Kumar Gala @ 2013-11-06 18:08 UTC (permalink / raw)
  To: Jason Cooper
  Cc: Rob Herring, Grant Likely, Pawel Moll, Mark Rutland,
	Stephen Warren, Ian Campbell, Rob Landley,
	devicetree-u79uwXL29TY76Z2rM5mHXA


On Nov 6, 2013, at 11:32 AM, Jason Cooper wrote:

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

Who is that a statement to, the maintainers or the developer?  Are just saying publish early for feedback or accept something that 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

-- 
Employee of Qualcomm Innovation Center, Inc.
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum, hosted by The Linux Foundation

--
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	[flat|nested] 12+ messages in thread

* Re: [PATCH RFC] dt: bindings: submitting patches document
       [not found]     ` <94951083-8220-46EB-A96B-5FFF95D944EA-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org>
@ 2013-11-06 18:10       ` Jason Cooper
  0 siblings, 0 replies; 12+ messages in thread
From: Jason Cooper @ 2013-11-06 18:10 UTC (permalink / raw)
  To: Kumar Gala
  Cc: Rob Herring, Grant Likely, Pawel Moll, Mark Rutland,
	Stephen Warren, Ian Campbell, Rob Landley,
	devicetree-u79uwXL29TY76Z2rM5mHXA

On Wed, Nov 06, 2013 at 12:08:01PM -0600, Kumar Gala wrote:
> 
> On Nov 6, 2013, at 11:32 AM, Jason Cooper wrote:
> 
> > 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.
> 
> Who is that a statement to, the maintainers or the developer?  Are just saying publish early for feedback or accept something that isn't perfect?

I was targeting the maintainers, eg:

       1) Maintainers, don't let perfection be the enemy of the good.
          Bindings don't need to be perfect.

better?

thx,

Jason.
> 
> > +
> > +  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
> 
> -- 
> Employee of Qualcomm Innovation Center, Inc.
> Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum, hosted by The Linux Foundation
> 
--
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	[flat|nested] 12+ messages in thread

* Re: [PATCH RFC] dt: bindings: submitting patches document
       [not found] ` <1383759120-21571-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
  2013-11-06 18:08   ` Kumar Gala
@ 2013-11-07 11:42   ` Nicolas Ferre
       [not found]     ` <527B7C94.7030708-AIFe0yeh4nAAvxtiuMwx3w@public.gmane.org>
  2013-11-07 18:53   ` [PATCH RFC V2] " Jason Cooper
                     ` (2 subsequent siblings)
  4 siblings, 1 reply; 12+ messages in thread
From: Nicolas Ferre @ 2013-11-07 11:42 UTC (permalink / raw)
  To: Jason Cooper, Rob Herring, Grant Likely, Pawel Moll,
	Mark Rutland, Stephen Warren, Ian Campbell, Rob Landley
  Cc: devicetree-u79uwXL29TY76Z2rM5mHXA

On 06/11/2013 18:32, Jason Cooper :
> 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

This is not what I understood.
It seems that we said that only the patch that was containing the 
binding documentation have to be sent to the devicetree mainling-list 
(but this patch being part of a patch series anyway). This way the 
devicetree maintainers would not have to deal with the patch review 
process, even if they can have a look to the code source on the 
mailing-list archive if they need to.

Someone to clarify?


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


-- 
Nicolas Ferre
--
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	[flat|nested] 12+ messages in thread

* Re: [PATCH RFC] dt: bindings: submitting patches document
       [not found]     ` <527B7C94.7030708-AIFe0yeh4nAAvxtiuMwx3w@public.gmane.org>
@ 2013-11-07 11:56       ` Jason Cooper
       [not found]         ` <20131107115604.GJ8308-u4khhh1J0LxI1Ri9qeTfzeTW4wlIGRCZ@public.gmane.org>
  0 siblings, 1 reply; 12+ messages in thread
From: Jason Cooper @ 2013-11-07 11:56 UTC (permalink / raw)
  To: Nicolas Ferre
  Cc: Rob Herring, Grant Likely, Pawel Moll, Mark Rutland,
	Stephen Warren, Ian Campbell, Rob Landley,
	devicetree-u79uwXL29TY76Z2rM5mHXA

On Thu, Nov 07, 2013 at 12:42:12PM +0100, Nicolas Ferre wrote:
> On 06/11/2013 18:32, Jason Cooper :
> >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
> 
> This is not what I understood.
> It seems that we said that only the patch that was containing the
> binding documentation have to be sent to the devicetree
> mainling-list (but this patch being part of a patch series anyway).
> This way the devicetree maintainers would not have to deal with the
> patch review process, even if they can have a look to the code
> source on the mailing-list archive if they need to.

And that is the exact reason I wrote this doc.  ;-)  Mark Rutland said
on Friday during the Q&A portion of the DT talk that he wanted to be
able to refer to the code changes that went with the binding doc patch.

I raised my hand and pointed to the elephant in the room, that this was
the exact opposite of what was decided during the mini-summit.  Grant
said to send the whole series since he has better filters now for
finding the binding documentation changes.

Since he isn't the only reviewer, I came up with the 'dt: binding: ...'
subject line to make the patch easier to find and review.

Long story short, we changed our mind on the last day, and as I said in
the comment section, I don't like quoting others from my imperfect
memory.  So, I'd like to have an agreed upon doc.

> Someone to clarify?

Please.

thx,

Jason.


> >+       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.
> >
> 
> 
> -- 
> Nicolas Ferre
--
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	[flat|nested] 12+ messages in thread

* Re: [PATCH RFC] dt: bindings: submitting patches document
       [not found]         ` <20131107115604.GJ8308-u4khhh1J0LxI1Ri9qeTfzeTW4wlIGRCZ@public.gmane.org>
@ 2013-11-07 15:26           ` Brian Austin
  0 siblings, 0 replies; 12+ messages in thread
From: Brian Austin @ 2013-11-07 15:26 UTC (permalink / raw)
  To: Jason Cooper
  Cc: Nicolas Ferre, Rob Herring, Grant Likely, Pawel Moll,
	Mark Rutland, Stephen Warren, Ian Campbell, Rob Landley,
	devicetree-u79uwXL29TY76Z2rM5mHXA

On Thu, 7 Nov 2013, Jason Cooper wrote:

> On Thu, Nov 07, 2013 at 12:42:12PM +0100, Nicolas Ferre wrote:
>> On 06/11/2013 18:32, Jason Cooper :
>>> 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
>>
>> This is not what I understood.
>> It seems that we said that only the patch that was containing the
>> binding documentation have to be sent to the devicetree
>> mainling-list (but this patch being part of a patch series anyway).
>> This way the devicetree maintainers would not have to deal with the
>> patch review process, even if they can have a look to the code
>> source on the mailing-list archive if they need to.
>
> And that is the exact reason I wrote this doc.  ;-)  Mark Rutland said
> on Friday during the Q&A portion of the DT talk that he wanted to be
> able to refer to the code changes that went with the binding doc patch.
>
> I raised my hand and pointed to the elephant in the room, that this was
> the exact opposite of what was decided during the mini-summit.  Grant
> said to send the whole series since he has better filters now for
> finding the binding documentation changes.
>
> Since he isn't the only reviewer, I came up with the 'dt: binding: ...'
> subject line to make the patch easier to find and review.
>

This sounds reasonable to me.  I submit a 3 series patch to ASoC for new 
DT support and have '[PATCH 3/3]dt: binding:' for the binding file and 
send the whole series to the DT and ASoC mailing lists.

It doubles the email for a patch, but if they can be filtered does it 
matter?

I will be sending one shortly so I guess I'll do that and see what 
happens.


--
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	[flat|nested] 12+ messages in thread

* [PATCH RFC V2] dt: bindings: submitting patches document
       [not found] ` <1383759120-21571-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
  2013-11-06 18:08   ` Kumar Gala
  2013-11-07 11:42   ` Nicolas Ferre
@ 2013-11-07 18:53   ` 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
  4 siblings, 0 replies; 12+ messages in thread
From: Jason Cooper @ 2013-11-07 18:53 UTC (permalink / raw)
  To: Rob Herring, 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>
---
Changes since V1:
 - clarified III.1. as speaking to maintainers
 - quoted Grant's ARM mini-summit document regarding DT as stable ABI (IV.2.)

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     | 68 ++++++++++++++++++++++
 1 file changed, 68 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..82ffdabd22cc
--- /dev/null
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -0,0 +1,68 @@
+
+  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) Maintainers, don't let perfect be the enemy of good.  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.  See IV.2.
+
+  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
+
+  1) 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.
+
+  2) Regarding stable bindings/ABI, we quote from the 2013 ARM mini-summit
+     summary document:
+
+       "That still leaves the question of, what does a stable binding look
+       like?  Certainly a stable binding means that a newer kernel will not
+       break on an older device tree, but that doesn't mean the binding is
+       frozen for all time. Grant said there are ways to change bindings that
+       don't result in breakage. For instance, if a new property is added,
+       then default to the previous behaviour if it is missing. If a binding
+       truly needs an incompatible change, then change the compatible string
+       at the same time.  The driver can bind against both the old and the
+       new. These guidelines aren't new, but they desperately need to be
+       documented."
+
-- 
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

* Re: [PATCH RFC] dt: bindings: submitting patches document
       [not found] ` <1383759120-21571-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
                     ` (2 preceding siblings ...)
  2013-11-07 18:53   ` [PATCH RFC V2] " Jason Cooper
@ 2013-12-03 13:09   ` Grant Likely
  2013-12-17 16:59   ` [PATCH V2] dt: bindings: submitting patches and ABI documents Jason Cooper
  4 siblings, 0 replies; 12+ messages in thread
From: Grant Likely @ 2013-12-03 13:09 UTC (permalink / raw)
  To: Rob Herring, Pawel Moll, Mark Rutland, Stephen Warren,
	Ian Campbell, Rob Landley
  Cc: Jason Cooper, devicetree-u79uwXL29TY76Z2rM5mHXA

On Wed,  6 Nov 2013 17:32:00 +0000, Jason Cooper <jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org> wrote:
> 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.

Sure. I don't actually care here since I filter on whether or not
Documentation/devicetree/bindings is one of the file diffs. I don't have
any objections to this however.

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

Providing it isn't a subsystem binding. Driver specific stuff this is
okay for. Stuff that impacts the entire subsystem really needs to be
reviewed.

> +
> +  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) Bindings can be augmented, but the driver shouldn't break when given
the old binding. ie. add additional properties, but don't change the
meaning of an existing property. For drivers, default to the original
behaviour when a newly added property is missing.

> +
> +  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	[flat|nested] 12+ messages in thread

* [PATCH V2] dt: bindings: submitting patches and ABI documents
       [not found] ` <1383759120-21571-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
                     ` (3 preceding siblings ...)
  2013-12-03 13:09   ` [PATCH RFC] " Grant Likely
@ 2013-12-17 16:59   ` Jason Cooper
       [not found]     ` <1387299580-9100-1-git-send-email-jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
  4 siblings, 1 reply; 12+ messages in thread
From: Jason Cooper @ 2013-12-17 16:59 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>
---
Changes from RFC:
 - incorporated Grant's language
 - split patches/ABI into two documents

 Documentation/devicetree/bindings/ABI.txt          | 39 ++++++++++++++++++++++
 .../devicetree/bindings/submitting-patches.txt     | 35 +++++++++++++++++++
 2 files changed, 74 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/ABI.txt
 create mode 100644 Documentation/devicetree/bindings/submitting-patches.txt

diff --git a/Documentation/devicetree/bindings/ABI.txt b/Documentation/devicetree/bindings/ABI.txt
new file mode 100644
index 000000000000..d25f8d379680
--- /dev/null
+++ b/Documentation/devicetree/bindings/ABI.txt
@@ -0,0 +1,39 @@
+
+  Devicetree (DT) ABI
+
+I. Regarding stable bindings/ABI, we quote from the 2013 ARM mini-summit
+   summary document:
+
+     "That still leaves the question of, what does a stable binding look
+     like?  Certainly a stable binding means that a newer kernel will not
+     break on an older device tree, but that doesn't mean the binding is
+     frozen for all time. Grant said there are ways to change bindings that
+     don't result in breakage. For instance, if a new property is added,
+     then default to the previous behaviour if it is missing. If a binding
+     truly needs an incompatible change, then change the compatible string
+     at the same time.  The driver can bind against both the old and the
+     new. These guidelines aren't new, but they desperately need to be
+     documented."
+
+II.  General binding rules
+
+  1) Maintainers, don't let perfect be the enemy of good.  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.  See I.
+
+  3) Bindings can be augmented, but the driver shouldn't break when given
+     the old binding. ie. add additional properties, but don't change the
+     meaning of an existing property. For drivers, default to the original
+     behaviour when a newly added property is missing.
+
+  4) Don't submit bindings for staging or unstable.  That will be decided by
+     the devicetree maintainers *after* discussion on the mailinglist.
+
+III. Notes
+
+  1) 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.
diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
new file mode 100644
index 000000000000..5672cb46681d
--- /dev/null
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -0,0 +1,35 @@
+
+  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.
+
+  2) Submit the entire series to the devicetree mailinglist at
+
+       devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
+
+II. For kernel 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) For driver (not subsystem) bindings: 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. Notes
+
+  0) Please see ...bindings/ABI.txt for details regarding devicetree ABI.
+
+  1) 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.5.1

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

* Re: [PATCH V2] dt: bindings: submitting patches and ABI documents
       [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
  2 siblings, 0 replies; 12+ messages in thread
From: Jason Cooper @ 2014-01-10 18:30 UTC (permalink / raw)
  To: Rob Herring, Grant Likely, Pawel Moll, Mark Rutland,
	Stephen Warren, Ian Campbell, Rob Landley
  Cc: devicetree-u79uwXL29TY76Z2rM5mHXA

Grant,

On Tue, Dec 17, 2013 at 04:59:40PM +0000, Jason Cooper wrote:
> Signed-off-by: Jason Cooper <jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
> ---
> Changes from RFC:
>  - incorporated Grant's language
>  - split patches/ABI into two documents
> 
>  Documentation/devicetree/bindings/ABI.txt          | 39 ++++++++++++++++++++++
>  .../devicetree/bindings/submitting-patches.txt     | 35 +++++++++++++++++++
>  2 files changed, 74 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/ABI.txt
>  create mode 100644 Documentation/devicetree/bindings/submitting-patches.txt

Are there any updates I should make to this?

thx,

Jason.

> diff --git a/Documentation/devicetree/bindings/ABI.txt b/Documentation/devicetree/bindings/ABI.txt
> new file mode 100644
> index 000000000000..d25f8d379680
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ABI.txt
> @@ -0,0 +1,39 @@
> +
> +  Devicetree (DT) ABI
> +
> +I. Regarding stable bindings/ABI, we quote from the 2013 ARM mini-summit
> +   summary document:
> +
> +     "That still leaves the question of, what does a stable binding look
> +     like?  Certainly a stable binding means that a newer kernel will not
> +     break on an older device tree, but that doesn't mean the binding is
> +     frozen for all time. Grant said there are ways to change bindings that
> +     don't result in breakage. For instance, if a new property is added,
> +     then default to the previous behaviour if it is missing. If a binding
> +     truly needs an incompatible change, then change the compatible string
> +     at the same time.  The driver can bind against both the old and the
> +     new. These guidelines aren't new, but they desperately need to be
> +     documented."
> +
> +II.  General binding rules
> +
> +  1) Maintainers, don't let perfect be the enemy of good.  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.  See I.
> +
> +  3) Bindings can be augmented, but the driver shouldn't break when given
> +     the old binding. ie. add additional properties, but don't change the
> +     meaning of an existing property. For drivers, default to the original
> +     behaviour when a newly added property is missing.
> +
> +  4) Don't submit bindings for staging or unstable.  That will be decided by
> +     the devicetree maintainers *after* discussion on the mailinglist.
> +
> +III. Notes
> +
> +  1) 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.
> diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
> new file mode 100644
> index 000000000000..5672cb46681d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/submitting-patches.txt
> @@ -0,0 +1,35 @@
> +
> +  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.
> +
> +  2) Submit the entire series to the devicetree mailinglist at
> +
> +       devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> +
> +II. For kernel 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) For driver (not subsystem) bindings: 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. Notes
> +
> +  0) Please see ...bindings/ABI.txt for details regarding devicetree ABI.
> +
> +  1) 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.5.1
> 
> --
> 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
--
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	[flat|nested] 12+ messages in thread

* Re: [PATCH V2] dt: bindings: submitting patches and ABI documents
       [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
  2 siblings, 0 replies; 12+ messages in thread
From: Tomasz Figa @ 2014-01-10 23:34 UTC (permalink / raw)
  To: Jason Cooper
  Cc: Rob Herring, Grant Likely, Pawel Moll, Mark Rutland,
	Stephen Warren, Ian Campbell, Rob Landley,
	devicetree-u79uwXL29TY76Z2rM5mHXA

Hi Jason,

Overall these are very nice and useful documents, but I have some minor
comments inline.

On Tuesday 17 of December 2013 16:59:40 Jason Cooper wrote:
> Signed-off-by: Jason Cooper <jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>
> ---
> Changes from RFC:
>  - incorporated Grant's language
>  - split patches/ABI into two documents
> 
>  Documentation/devicetree/bindings/ABI.txt          | 39 ++++++++++++++++++++++
>  .../devicetree/bindings/submitting-patches.txt     | 35 +++++++++++++++++++
>  2 files changed, 74 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/ABI.txt
>  create mode 100644 Documentation/devicetree/bindings/submitting-patches.txt
> 
> diff --git a/Documentation/devicetree/bindings/ABI.txt b/Documentation/devicetree/bindings/ABI.txt
> new file mode 100644
> index 000000000000..d25f8d379680
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ABI.txt
> @@ -0,0 +1,39 @@
> +
> +  Devicetree (DT) ABI
> +
> +I. Regarding stable bindings/ABI, we quote from the 2013 ARM mini-summit
> +   summary document:
> +
> +     "That still leaves the question of, what does a stable binding look
> +     like?  Certainly a stable binding means that a newer kernel will not
> +     break on an older device tree, but that doesn't mean the binding is
> +     frozen for all time. Grant said there are ways to change bindings that
> +     don't result in breakage. For instance, if a new property is added,
> +     then default to the previous behaviour if it is missing. If a binding
> +     truly needs an incompatible change, then change the compatible string
> +     at the same time.  The driver can bind against both the old and the
> +     new. These guidelines aren't new, but they desperately need to be
> +     documented."

I'm not sure if my memory isn't playing tricks on me, but I think more
than that has been said. I believe we have decided that, if really
necessary, bindings can be marked as unstable, but they need to become
stable after some period of time (3 months?), otherwise they are dropped.
Also, the marking is supposed to be done by explicitly stating in
documentation that such binding is unstable.

Also it might be a good idea to state (even if it's quite obvious) that
standard kernel release processes apply to bindings, so they become
really stable after release of first stable kernel where relevant
documentation is included. This means that the binding can be heavily
changed in -rc releases, if there is such need.

> +
> +II.  General binding rules
> +
> +  1) Maintainers, don't let perfect be the enemy of good.  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.  See I.
> +
> +  3) Bindings can be augmented, but the driver shouldn't break when given
> +     the old binding. ie. add additional properties, but don't change the
> +     meaning of an existing property. For drivers, default to the original
> +     behaviour when a newly added property is missing.
> +
> +  4) Don't submit bindings for staging or unstable.  That will be decided by
> +     the devicetree maintainers *after* discussion on the mailinglist.
> +
> +III. Notes
> +
> +  1) 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.
> diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
> new file mode 100644
> index 000000000000..5672cb46681d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/submitting-patches.txt
> @@ -0,0 +1,35 @@
> +
> +  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.
> +
> +  2) Submit the entire series to the devicetree mailinglist at
> +
> +       devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> +
> +II. For kernel 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) For driver (not subsystem) bindings: 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.

Even though the general rules of patch submission apply and pinging
maintainers is a part of them, it might be a good idea to do a last
minute ping as a warning for DT maintainers to give them one more day
to look at patches that they could have missed.

> +
> +  3) For a series going though multiple trees, the binding patch should be
> +     kept with the driver using the binding.

Also a note about trivial bindings might be added, because there is a lot
of such showing up constantly. With trivial I mean a compatible string
and a set of some generic properties, such as reg, interrupts, etc.,
without any special device-specific magic. I'm not sure if there is
a need to wait for DT maintainers to act, if subsystem maintainer can
identify such binding as trivial.

Best regards,
Tomasz

--
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	[flat|nested] 12+ messages in thread

* Re: [PATCH V2] dt: bindings: submitting patches and ABI documents
       [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
  2 siblings, 0 replies; 12+ messages in thread
From: Grant Likely @ 2014-01-20 22:31 UTC (permalink / raw)
  To: Rob Herring, Pawel Moll, Mark Rutland, Stephen Warren,
	Ian Campbell, Rob Landley
  Cc: Jason Cooper, devicetree-u79uwXL29TY76Z2rM5mHXA

On Tue, 17 Dec 2013 16:59:40 +0000, Jason Cooper <jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org> wrote:
> Signed-off-by: Jason Cooper <jason-NLaQJdtUoK4Be96aLqz0jA@public.gmane.org>

Applied, thanks.

One note though. Even when the diff is "obvious", the commit description
should really not be empty. I've added something, but my life is a lot
easier when I don't have to.

I've also added the following blurb to point II.2:

+     Subsystem bindings (anything affecting more than a single device)
+     then getting a devicetree maintainer to review it is required.

g.

> ---
> Changes from RFC:
>  - incorporated Grant's language
>  - split patches/ABI into two documents
> 
>  Documentation/devicetree/bindings/ABI.txt          | 39 ++++++++++++++++++++++
>  .../devicetree/bindings/submitting-patches.txt     | 35 +++++++++++++++++++
>  2 files changed, 74 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/ABI.txt
>  create mode 100644 Documentation/devicetree/bindings/submitting-patches.txt
> 
> diff --git a/Documentation/devicetree/bindings/ABI.txt b/Documentation/devicetree/bindings/ABI.txt
> new file mode 100644
> index 000000000000..d25f8d379680
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ABI.txt
> @@ -0,0 +1,39 @@
> +
> +  Devicetree (DT) ABI
> +
> +I. Regarding stable bindings/ABI, we quote from the 2013 ARM mini-summit
> +   summary document:
> +
> +     "That still leaves the question of, what does a stable binding look
> +     like?  Certainly a stable binding means that a newer kernel will not
> +     break on an older device tree, but that doesn't mean the binding is
> +     frozen for all time. Grant said there are ways to change bindings that
> +     don't result in breakage. For instance, if a new property is added,
> +     then default to the previous behaviour if it is missing. If a binding
> +     truly needs an incompatible change, then change the compatible string
> +     at the same time.  The driver can bind against both the old and the
> +     new. These guidelines aren't new, but they desperately need to be
> +     documented."
> +
> +II.  General binding rules
> +
> +  1) Maintainers, don't let perfect be the enemy of good.  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.  See I.
> +
> +  3) Bindings can be augmented, but the driver shouldn't break when given
> +     the old binding. ie. add additional properties, but don't change the
> +     meaning of an existing property. For drivers, default to the original
> +     behaviour when a newly added property is missing.
> +
> +  4) Don't submit bindings for staging or unstable.  That will be decided by
> +     the devicetree maintainers *after* discussion on the mailinglist.
> +
> +III. Notes
> +
> +  1) 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.
> diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
> new file mode 100644
> index 000000000000..5672cb46681d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/submitting-patches.txt
> @@ -0,0 +1,35 @@
> +
> +  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.
> +
> +  2) Submit the entire series to the devicetree mailinglist at
> +
> +       devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> +
> +II. For kernel 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) For driver (not subsystem) bindings: 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. Notes
> +
> +  0) Please see ...bindings/ABI.txt for details regarding devicetree ABI.
> +
> +  1) 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.5.1
> 

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