docs: add default that all fixes are backported

Message ID 1529596827-14756-1-git-send-email-ktraynor@redhat.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series docs: add default that all fixes are backported |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK

Commit Message

Kevin Traynor June 21, 2018, 4 p.m. UTC
  Set the starting point that all commits on master branch
with Fixes tag are backported to relevant stable/LTS branches.

Of course there will be exceptions that will crop up from time
to time that need discussion, so also add a sentence for that.

This is to ensure that there is consistency between what is
backported to stable/LTS branches, remove some subjectivity
as to what constitutes "a fix" and avoid possible conflicts
for future backports.

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
 doc/guides/contributing/stable.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
  

Comments

Luca Boccassi June 21, 2018, 4:14 p.m. UTC | #1
On Thu, 2018-06-21 at 17:00 +0100, Kevin Traynor wrote:
> Set the starting point that all commits on master branch
> with Fixes tag are backported to relevant stable/LTS branches.
> 
> Of course there will be exceptions that will crop up from time
> to time that need discussion, so also add a sentence for that.
> 
> This is to ensure that there is consistency between what is
> backported to stable/LTS branches, remove some subjectivity
> as to what constitutes "a fix" and avoid possible conflicts
> for future backports.
> 
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> ---
>  doc/guides/contributing/stable.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/contributing/stable.rst
> b/doc/guides/contributing/stable.rst
> index 0f2f1f3..bbafc37 100644
> --- a/doc/guides/contributing/stable.rst
> +++ b/doc/guides/contributing/stable.rst
> @@ -58,5 +58,7 @@ What changes should be backported
>  ---------------------------------
>  
> -Backporting should be limited to bug fixes.
> +Backporting should be limited to bug fixes. All patches accepted on
> the master
> +branch with Fixes tags will be backported to the relevant stable/LTS
> branches.
> +If there are exceptions, they will be discussed on the mailing
> lists.
>  
>  Features should not be backported to stable releases. It may be
> acceptable, in

Acked-by: Luca Boccassi <bluca@debian.org>
  
Ferruh Yigit June 21, 2018, 4:45 p.m. UTC | #2
On 6/21/2018 5:00 PM, Kevin Traynor wrote:
> Set the starting point that all commits on master branch
> with Fixes tag are backported to relevant stable/LTS branches.
> 
> Of course there will be exceptions that will crop up from time
> to time that need discussion, so also add a sentence for that.
> 
> This is to ensure that there is consistency between what is
> backported to stable/LTS branches, remove some subjectivity
> as to what constitutes "a fix" and avoid possible conflicts
> for future backports.
> 
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> ---
>  doc/guides/contributing/stable.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
> index 0f2f1f3..bbafc37 100644
> --- a/doc/guides/contributing/stable.rst
> +++ b/doc/guides/contributing/stable.rst
> @@ -58,5 +58,7 @@ What changes should be backported
>  ---------------------------------
>  
> -Backporting should be limited to bug fixes.
> +Backporting should be limited to bug fixes. All patches accepted on the master
> +branch with Fixes tags will be backported to the relevant stable/LTS branches.
> +If there are exceptions, they will be discussed on the mailing lists.

Just to highlight, there are some cased fix is not applicable for stable trees,
for that case "Cc: stable@dpdk.org" tag explicitly omitted.

a) Fix with backport request:
 Fixes: ############ ("...")
 Cc: stable@dpdk.org

b) Fix but backport not applicable/requested:
 Fixes: ############ ("...")


So I agree there may be a confusion in b) if the backport is not requested or it
has been forgotten.
Is there anything we can do/change to help stable tree maintainers on this issue?

>  
>  Features should not be backported to stable releases. It may be acceptable, in
>
  
Aaron Conole June 21, 2018, 6 p.m. UTC | #3
Kevin Traynor <ktraynor@redhat.com> writes:

> Set the starting point that all commits on master branch
> with Fixes tag are backported to relevant stable/LTS branches.
>
> Of course there will be exceptions that will crop up from time
> to time that need discussion, so also add a sentence for that.
>
> This is to ensure that there is consistency between what is
> backported to stable/LTS branches, remove some subjectivity
> as to what constitutes "a fix" and avoid possible conflicts
> for future backports.
>
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> ---

Acked-by: Aaron Conole <aconole@redhat.com>
  
Thomas Monjalon June 29, 2018, 4:15 p.m. UTC | #4
21/06/2018 18:45, Ferruh Yigit:
> On 6/21/2018 5:00 PM, Kevin Traynor wrote:
> > Set the starting point that all commits on master branch
> > with Fixes tag are backported to relevant stable/LTS branches.
> > 
> > Of course there will be exceptions that will crop up from time
> > to time that need discussion, so also add a sentence for that.
> > 
> > This is to ensure that there is consistency between what is
> > backported to stable/LTS branches, remove some subjectivity
> > as to what constitutes "a fix" and avoid possible conflicts
> > for future backports.
> > 
> > Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> > ---
> >  doc/guides/contributing/stable.rst | 4 +++-
> >  1 file changed, 3 insertions(+), 1 deletion(-)
> > 
> > diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
> > index 0f2f1f3..bbafc37 100644
> > --- a/doc/guides/contributing/stable.rst
> > +++ b/doc/guides/contributing/stable.rst
> > @@ -58,5 +58,7 @@ What changes should be backported
> >  ---------------------------------
> >  
> > -Backporting should be limited to bug fixes.
> > +Backporting should be limited to bug fixes. All patches accepted on the master
> > +branch with Fixes tags will be backported to the relevant stable/LTS branches.
> > +If there are exceptions, they will be discussed on the mailing lists.
> 
> Just to highlight, there are some cased fix is not applicable for stable trees,
> for that case "Cc: stable@dpdk.org" tag explicitly omitted.
> 
> a) Fix with backport request:
>  Fixes: ############ ("...")
>  Cc: stable@dpdk.org
> 
> b) Fix but backport not applicable/requested:
>  Fixes: ############ ("...")
> 
> 
> So I agree there may be a confusion in b) if the backport is not requested or it
> has been forgotten.
> Is there anything we can do/change to help stable tree maintainers on this issue?

I agree with Ferruh that fixes without Cc: stable@dpdk.org
should not be backported, except if it is confirmed that it is a miss.

Can we change the wording to "all patches with Cc: stable@dpdk.org tag" ?
  
Kevin Traynor June 29, 2018, 9:39 p.m. UTC | #5
On 06/29/2018 05:15 PM, Thomas Monjalon wrote:
> 21/06/2018 18:45, Ferruh Yigit:
>> On 6/21/2018 5:00 PM, Kevin Traynor wrote:
>>> Set the starting point that all commits on master branch
>>> with Fixes tag are backported to relevant stable/LTS branches.
>>>
>>> Of course there will be exceptions that will crop up from time
>>> to time that need discussion, so also add a sentence for that.
>>>
>>> This is to ensure that there is consistency between what is
>>> backported to stable/LTS branches, remove some subjectivity
>>> as to what constitutes "a fix" and avoid possible conflicts
>>> for future backports.
>>>
>>> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
>>> ---
>>>  doc/guides/contributing/stable.rst | 4 +++-
>>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
>>> index 0f2f1f3..bbafc37 100644
>>> --- a/doc/guides/contributing/stable.rst
>>> +++ b/doc/guides/contributing/stable.rst
>>> @@ -58,5 +58,7 @@ What changes should be backported
>>>  ---------------------------------
>>>  
>>> -Backporting should be limited to bug fixes.
>>> +Backporting should be limited to bug fixes. All patches accepted on the master
>>> +branch with Fixes tags will be backported to the relevant stable/LTS branches.
>>> +If there are exceptions, they will be discussed on the mailing lists.
>>
>> Just to highlight, there are some cased fix is not applicable for stable trees,
>> for that case "Cc: stable@dpdk.org" tag explicitly omitted.
>>
>> a) Fix with backport request:
>>  Fixes: ############ ("...")
>>  Cc: stable@dpdk.org
>>
>> b) Fix but backport not applicable/requested:
>>  Fixes: ############ ("...")
>>
>>
>> So I agree there may be a confusion in b) if the backport is not requested or it
>> has been forgotten.
>> Is there anything we can do/change to help stable tree maintainers on this issue?
> 
> I agree with Ferruh that fixes without Cc: stable@dpdk.org
> should not be backported, except if it is confirmed that it is a miss.
> 
> Can we change the wording to "all patches with Cc: stable@dpdk.org tag" ?
> 
> 

I agree this case should be catered for. That approach will work fine as
long as most people remember the tags :-)

I reworded it a little bit differently to try and also keep the essence
that as many Fixes as possible should be backported. Otherwise devs may
use the Cc: stable@dpdk.org based on wildly different opinions about the
stable branches and what types of fixes are backported.

Aaron/Luca, I kept Acks because this is just adding for a special case.
Shout if any objection.
  
Thomas Monjalon June 29, 2018, 9:56 p.m. UTC | #6
29/06/2018 23:39, Kevin Traynor:
> On 06/29/2018 05:15 PM, Thomas Monjalon wrote:
> > 21/06/2018 18:45, Ferruh Yigit:
> >> On 6/21/2018 5:00 PM, Kevin Traynor wrote:
> >>> Set the starting point that all commits on master branch
> >>> with Fixes tag are backported to relevant stable/LTS branches.
> >>>
> >>> Of course there will be exceptions that will crop up from time
> >>> to time that need discussion, so also add a sentence for that.
> >>>
> >>> This is to ensure that there is consistency between what is
> >>> backported to stable/LTS branches, remove some subjectivity
> >>> as to what constitutes "a fix" and avoid possible conflicts
> >>> for future backports.
> >>>
> >>> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> >>> ---
> >>>  doc/guides/contributing/stable.rst | 4 +++-
> >>>  1 file changed, 3 insertions(+), 1 deletion(-)
> >>>
> >>> diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
> >>> index 0f2f1f3..bbafc37 100644
> >>> --- a/doc/guides/contributing/stable.rst
> >>> +++ b/doc/guides/contributing/stable.rst
> >>> @@ -58,5 +58,7 @@ What changes should be backported
> >>>  ---------------------------------
> >>>  
> >>> -Backporting should be limited to bug fixes.
> >>> +Backporting should be limited to bug fixes. All patches accepted on the master
> >>> +branch with Fixes tags will be backported to the relevant stable/LTS branches.
> >>> +If there are exceptions, they will be discussed on the mailing lists.
> >>
> >> Just to highlight, there are some cased fix is not applicable for stable trees,
> >> for that case "Cc: stable@dpdk.org" tag explicitly omitted.
> >>
> >> a) Fix with backport request:
> >>  Fixes: ############ ("...")
> >>  Cc: stable@dpdk.org
> >>
> >> b) Fix but backport not applicable/requested:
> >>  Fixes: ############ ("...")
> >>
> >>
> >> So I agree there may be a confusion in b) if the backport is not requested or it
> >> has been forgotten.
> >> Is there anything we can do/change to help stable tree maintainers on this issue?
> > 
> > I agree with Ferruh that fixes without Cc: stable@dpdk.org
> > should not be backported, except if it is confirmed that it is a miss.
> > 
> > Can we change the wording to "all patches with Cc: stable@dpdk.org tag" ?
> > 
> > 
> 
> I agree this case should be catered for. That approach will work fine as
> long as most people remember the tags :-)

As maintainers, our role is to make sure the tag is not forgotten.
We use the tool devtools/check-git-log.sh.

> I reworded it a little bit differently to try and also keep the essence
> that as many Fixes as possible should be backported. Otherwise devs may
> use the Cc: stable@dpdk.org based on wildly different opinions about the
> stable branches and what types of fixes are backported.

Yes the most important is to explain the intent.
Thanks
  

Patch

diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
index 0f2f1f3..bbafc37 100644
--- a/doc/guides/contributing/stable.rst
+++ b/doc/guides/contributing/stable.rst
@@ -58,5 +58,7 @@  What changes should be backported
 ---------------------------------
 
-Backporting should be limited to bug fixes.
+Backporting should be limited to bug fixes. All patches accepted on the master
+branch with Fixes tags will be backported to the relevant stable/LTS branches.
+If there are exceptions, they will be discussed on the mailing lists.
 
 Features should not be backported to stable releases. It may be acceptable, in