diff mbox series

Introduce a description of a new optional tag for Backports

Message ID 20191108190952.22163-1-sstabellini@kernel.org (mailing list archive)
State New, archived
Headers show
Series Introduce a description of a new optional tag for Backports | expand

Commit Message

Stefano Stabellini Nov. 8, 2019, 7:09 p.m. UTC
Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
CC: jbeulich@suse.com
CC: george.dunlap@citrix.com
CC: julien@xen.org
CC: lars.kurth@citrix.com
CC: andrew.cooper3@citrix.com
CC: ian.jackson@eu.citrix.com
CC: konrad.wilk@oracle.com
CC: wl@xen.org
---
 docs/process/backport-tag.pandoc | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 docs/process/backport-tag.pandoc

Comments

Ian Jackson Nov. 11, 2019, 10:50 a.m. UTC | #1
Stefano Stabellini writes ("[PATCH] Introduce a description of a new optional tag for Backports"):
> Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>

+2

Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
Wei Liu Nov. 11, 2019, 11:35 a.m. UTC | #2
On Fri, Nov 08, 2019 at 11:09:52AM -0800, Stefano Stabellini wrote:
> Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>

Acked-by: Wei Liu <wl@xen.org>
George Dunlap Nov. 11, 2019, 2:12 p.m. UTC | #3
On 11/8/19 7:09 PM, Stefano Stabellini wrote:
> Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
> CC: jbeulich@suse.com
> CC: george.dunlap@citrix.com
> CC: julien@xen.org
> CC: lars.kurth@citrix.com
> CC: andrew.cooper3@citrix.com
> CC: ian.jackson@eu.citrix.com
> CC: konrad.wilk@oracle.com
> CC: wl@xen.org
> ---
>  docs/process/backport-tag.pandoc | 23 +++++++++++++++++++++++
>  1 file changed, 23 insertions(+)
>  create mode 100644 docs/process/backport-tag.pandoc
> 
> diff --git a/docs/process/backport-tag.pandoc b/docs/process/backport-tag.pandoc
> new file mode 100644
> index 0000000000..e570efdcc8
> --- /dev/null
> +++ b/docs/process/backport-tag.pandoc
> @@ -0,0 +1,23 @@
> +Backport Tag
> +------------
> +
> +A backport tag is an optional tag in the commit message to request a
> +given commit to be backported to the stable trees:
> +
> +    Backport: all
> +
> +It marks a commit for being a candidate for backports to all relevant
> +trees.
> +
> +    Backport: 4.9+
> +
> +It marks a commit for being a candidate for backports to all stable
> +trees from 4.9 onward.
> +
> +Maintainers request the Backport tag to be added on commit.
> +Contributors are also welcome to mark their patches with the Backport
> +tag when they deem appropriate. Maintainers will request for it to be
> +removed when that is not the case.
> +
> +Please note that the Backport tag is a **request** for backport, which
> +will still need to be evaluated by the stable tree maintainers.

The text and the idea both look good to me.

But it seems kind of balkanized to put it in its own file.  Would it be
better to try to make a slightly more general bit of content?  Either
about the backport process, or about tags in general?

(This would simply be renaming the file; not expecting you to generate
extra content.)

 -George
Lars Kurth Nov. 11, 2019, 2:19 p.m. UTC | #4
On 11/11/2019, 08:12, "George Dunlap" <george.dunlap@citrix.com> wrote:

    On 11/8/19 7:09 PM, Stefano Stabellini wrote:
    > Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
    > CC: jbeulich@suse.com
    > CC: george.dunlap@citrix.com
    > CC: julien@xen.org
    > CC: lars.kurth@citrix.com
    > CC: andrew.cooper3@citrix.com
    > CC: ian.jackson@eu.citrix.com
    > CC: konrad.wilk@oracle.com
    > CC: wl@xen.org
    > ---
    >  docs/process/backport-tag.pandoc | 23 +++++++++++++++++++++++
    >  1 file changed, 23 insertions(+)
    >  create mode 100644 docs/process/backport-tag.pandoc
    > 
    > diff --git a/docs/process/backport-tag.pandoc b/docs/process/backport-tag.pandoc
    > new file mode 100644
    > index 0000000000..e570efdcc8
    > --- /dev/null
    > +++ b/docs/process/backport-tag.pandoc
    > @@ -0,0 +1,23 @@
    > +Backport Tag
    > +------------
    > +
    > +A backport tag is an optional tag in the commit message to request a
    > +given commit to be backported to the stable trees:
    > +
    > +    Backport: all
    > +
    > +It marks a commit for being a candidate for backports to all relevant
    > +trees.
    > +
    > +    Backport: 4.9+
    > +
    > +It marks a commit for being a candidate for backports to all stable
    > +trees from 4.9 onward.
    > +
    > +Maintainers request the Backport tag to be added on commit.
    > +Contributors are also welcome to mark their patches with the Backport
    > +tag when they deem appropriate. Maintainers will request for it to be
    > +removed when that is not the case.
    > +
    > +Please note that the Backport tag is a **request** for backport, which
    > +will still need to be evaluated by the stable tree maintainers.
    
    The text and the idea both look good to me.
    
    But it seems kind of balkanized to put it in its own file.  Would it be
    better to try to make a slightly more general bit of content?  Either
    about the backport process, or about tags in general?
    
It should be in https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F
What is currently missing is
- Release-Acked-by
- The new proposed tag 

But maybe we should have a master document in tree, which defines the tags in use
And then I can refer to it from https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F 

Regards
Lars
Stefano Stabellini Nov. 11, 2019, 5:03 p.m. UTC | #5
On Mon, 11 Nov 2019, Lars Kurth wrote:
> On 11/11/2019, 08:12, "George Dunlap" <george.dunlap@citrix.com> wrote:
> 
>     On 11/8/19 7:09 PM, Stefano Stabellini wrote:
>     > Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
>     > CC: jbeulich@suse.com
>     > CC: george.dunlap@citrix.com
>     > CC: julien@xen.org
>     > CC: lars.kurth@citrix.com
>     > CC: andrew.cooper3@citrix.com
>     > CC: ian.jackson@eu.citrix.com
>     > CC: konrad.wilk@oracle.com
>     > CC: wl@xen.org
>     > ---
>     >  docs/process/backport-tag.pandoc | 23 +++++++++++++++++++++++
>     >  1 file changed, 23 insertions(+)
>     >  create mode 100644 docs/process/backport-tag.pandoc
>     > 
>     > diff --git a/docs/process/backport-tag.pandoc b/docs/process/backport-tag.pandoc
>     > new file mode 100644
>     > index 0000000000..e570efdcc8
>     > --- /dev/null
>     > +++ b/docs/process/backport-tag.pandoc
>     > @@ -0,0 +1,23 @@
>     > +Backport Tag
>     > +------------
>     > +
>     > +A backport tag is an optional tag in the commit message to request a
>     > +given commit to be backported to the stable trees:
>     > +
>     > +    Backport: all
>     > +
>     > +It marks a commit for being a candidate for backports to all relevant
>     > +trees.
>     > +
>     > +    Backport: 4.9+
>     > +
>     > +It marks a commit for being a candidate for backports to all stable
>     > +trees from 4.9 onward.
>     > +
>     > +Maintainers request the Backport tag to be added on commit.
>     > +Contributors are also welcome to mark their patches with the Backport
>     > +tag when they deem appropriate. Maintainers will request for it to be
>     > +removed when that is not the case.
>     > +
>     > +Please note that the Backport tag is a **request** for backport, which
>     > +will still need to be evaluated by the stable tree maintainers.
>     
>     The text and the idea both look good to me.

Thank you!


>     But it seems kind of balkanized to put it in its own file.  Would it be
>     better to try to make a slightly more general bit of content?  Either
>     about the backport process, or about tags in general?

Yeah, it was never meant to stay in its own separate file. I thought it
would get merged into a bigger file about the whole process when it gets
submitted.


> It should be in https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F
> What is currently missing is
> - Release-Acked-by
> - The new proposed tag 
> 
> But maybe we should have a master document in tree, which defines the tags in use
> And then I can refer to it from https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F 

For now, would you like me to add the text to the wiki at
https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F ?
Or would you rather do it?
Lars Kurth Nov. 11, 2019, 8:15 p.m. UTC | #6
On 11/11/2019, 11:03, "Stefano Stabellini" <sstabellini@kernel.org> wrote:

    On Mon, 11 Nov 2019, Lars Kurth wrote:
    > On 11/11/2019, 08:12, "George Dunlap" <george.dunlap@citrix.com> wrote:
    > 
    >     On 11/8/19 7:09 PM, Stefano Stabellini wrote:
    >     > Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
    >     > CC: jbeulich@suse.com
    >     > CC: george.dunlap@citrix.com
    >     > CC: julien@xen.org
    >     > CC: lars.kurth@citrix.com
    >     > CC: andrew.cooper3@citrix.com
    >     > CC: ian.jackson@eu.citrix.com
    >     > CC: konrad.wilk@oracle.com
    >     > CC: wl@xen.org
    >     > ---
    >     >  docs/process/backport-tag.pandoc | 23 +++++++++++++++++++++++
    >     >  1 file changed, 23 insertions(+)
    >     >  create mode 100644 docs/process/backport-tag.pandoc
    >     > 
    >     > diff --git a/docs/process/backport-tag.pandoc b/docs/process/backport-tag.pandoc
    >     > new file mode 100644
    >     > index 0000000000..e570efdcc8
    >     > --- /dev/null
    >     > +++ b/docs/process/backport-tag.pandoc
    >     > @@ -0,0 +1,23 @@
    >     > +Backport Tag
    >     > +------------
    >     > +
    >     > +A backport tag is an optional tag in the commit message to request a
    >     > +given commit to be backported to the stable trees:
    >     > +
    >     > +    Backport: all
    >     > +
    >     > +It marks a commit for being a candidate for backports to all relevant
    >     > +trees.
    >     > +
    >     > +    Backport: 4.9+
    >     > +
    >     > +It marks a commit for being a candidate for backports to all stable
    >     > +trees from 4.9 onward.
    >     > +
    >     > +Maintainers request the Backport tag to be added on commit.
    >     > +Contributors are also welcome to mark their patches with the Backport
    >     > +tag when they deem appropriate. Maintainers will request for it to be
    >     > +removed when that is not the case.
    >     > +
    >     > +Please note that the Backport tag is a **request** for backport, which
    >     > +will still need to be evaluated by the stable tree maintainers.
    >     
    >     The text and the idea both look good to me.
    
    Thank you!
    
    
    >     But it seems kind of balkanized to put it in its own file.  Would it be
    >     better to try to make a slightly more general bit of content?  Either
    >     about the backport process, or about tags in general?
    
    Yeah, it was never meant to stay in its own separate file. I thought it
    would get merged into a bigger file about the whole process when it gets
    submitted.
    
    
    > It should be in https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F
    > What is currently missing is
    > - Release-Acked-by
    > - The new proposed tag 
    > 
    > But maybe we should have a master document in tree, which defines the tags in use
    > And then I can refer to it from https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F 
    
    For now, would you like me to add the text to the wiki at
    https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches#What_is_in_a_patch.3F ?
    Or would you rather do it?

No: I can do it. Just ping me when we are in agreement about the proposal
Lars
Anthony PERARD Nov. 12, 2019, 11:14 a.m. UTC | #7
On Fri, Nov 08, 2019 at 11:09:52AM -0800, Stefano Stabellini wrote:
> +Backport Tag
> +------------
> +
> +A backport tag is an optional tag in the commit message to request a
> +given commit to be backported to the stable trees:
> +
> +    Backport: all
[...]

Should we describe the Fixes: tag as well? These would have a similar
purpose to the backport tag, I mean it could help figure out which
commit to backport to which tree.
Ian Jackson Nov. 12, 2019, 11:17 a.m. UTC | #8
Anthony PERARD writes ("Re: [Xen-devel] [PATCH] Introduce a description of a new optional tag for Backports"):
> Should we describe the Fixes: tag as well? These would have a similar
> purpose to the backport tag, I mean it could help figure out which
> commit to backport to which tree.

Good point.

Ian.
Stefano Stabellini Nov. 12, 2019, 5:10 p.m. UTC | #9
On Tue, 12 Nov 2019, Ian Jackson wrote:
> Anthony PERARD writes ("Re: [Xen-devel] [PATCH] Introduce a description of a new optional tag for Backports"):
> > Should we describe the Fixes: tag as well? These would have a similar
> > purpose to the backport tag, I mean it could help figure out which
> > commit to backport to which tree.
> 
> Good point.

Yes, good idea.


Lars, I think we are already in agreement.

You can find the description of "Fixes" here in Linux
Documentation/process/submitting-patches.rst.
Lars Kurth Nov. 12, 2019, 8:07 p.m. UTC | #10
On 12/11/2019, 11:10, "Stefano Stabellini" <sstabellini@kernel.org> wrote:

    On Tue, 12 Nov 2019, Ian Jackson wrote:
    > Anthony PERARD writes ("Re: [Xen-devel] [PATCH] Introduce a description of a new optional tag for Backports"):
    > > Should we describe the Fixes: tag as well? These would have a similar
    > > purpose to the backport tag, I mean it could help figure out which
    > > commit to backport to which tree.
    > 
    > Good point.
    
    Yes, good idea.
    
    
    Lars, I think we are already in agreement.
    
    You can find the description of "Fixes" here in Linux
    Documentation/process/submitting-patches.rst.

It would be good to get Jan's ACK at least
Lars
Julien Grall Jan. 29, 2020, 10:15 p.m. UTC | #11
Hi,

I have noticed Wei began to use the tag today. It reminded me that I 
never followed-up on the patch, sorry for that.

On 08/11/2019 19:09, Stefano Stabellini wrote:
> Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
> CC: jbeulich@suse.com
> CC: george.dunlap@citrix.com
> CC: julien@xen.org
> CC: lars.kurth@citrix.com
> CC: andrew.cooper3@citrix.com
> CC: ian.jackson@eu.citrix.com
> CC: konrad.wilk@oracle.com
> CC: wl@xen.org
> ---
>   docs/process/backport-tag.pandoc | 23 +++++++++++++++++++++++
>   1 file changed, 23 insertions(+)
>   create mode 100644 docs/process/backport-tag.pandoc
> 
> diff --git a/docs/process/backport-tag.pandoc b/docs/process/backport-tag.pandoc
> new file mode 100644
> index 0000000000..e570efdcc8
> --- /dev/null
> +++ b/docs/process/backport-tag.pandoc
> @@ -0,0 +1,23 @@
> +Backport Tag
> +------------
> +
> +A backport tag is an optional tag in the commit message to request a
> +given commit to be backported to the stable trees:
> +
> +    Backport: all
> +
> +It marks a commit for being a candidate for backports to all relevant
> +trees.
> +
> +    Backport: 4.9+
> +
> +It marks a commit for being a candidate for backports to all stable
> +trees from 4.9 onward.
> +
> +Maintainers request the Backport tag to be added on commit.
> +Contributors are also welcome to mark their patches with the Backport
> +tag when they deem appropriate. Maintainers will request for it to be
> +removed when that is not the case.
> +
> +Please note that the Backport tag is a **request** for backport, which
> +will still need to be evaluated by the stable tree maintainers.

This proposal look good to me. Are you planning to resend the patch with 
George's suggestion?

Cheers,
diff mbox series

Patch

diff --git a/docs/process/backport-tag.pandoc b/docs/process/backport-tag.pandoc
new file mode 100644
index 0000000000..e570efdcc8
--- /dev/null
+++ b/docs/process/backport-tag.pandoc
@@ -0,0 +1,23 @@ 
+Backport Tag
+------------
+
+A backport tag is an optional tag in the commit message to request a
+given commit to be backported to the stable trees:
+
+    Backport: all
+
+It marks a commit for being a candidate for backports to all relevant
+trees.
+
+    Backport: 4.9+
+
+It marks a commit for being a candidate for backports to all stable
+trees from 4.9 onward.
+
+Maintainers request the Backport tag to be added on commit.
+Contributors are also welcome to mark their patches with the Backport
+tag when they deem appropriate. Maintainers will request for it to be
+removed when that is not the case.
+
+Please note that the Backport tag is a **request** for backport, which
+will still need to be evaluated by the stable tree maintainers.