[dpdk-dev] [PATCH] docs: add default that all fixes are backported

[dpdk-dev] [PATCH] docs: add default that all fixes are backported

[Kevin Traynor]

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

Re: [dpdk-dev] [PATCH] docs: add default that all fixes are backported

[Luca Boccassi]

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>

-- 
Kind regards,
Luca Boccassi

Re: [dpdk-dev] [PATCH] docs: add default that all fixes are backported

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

>  
>  Features should not be backported to stable releases. It may be acceptable, in
> 

Re: [dpdk-dev] [PATCH] docs: add default that all fixes are backported

[Aaron Conole]

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>

Re: [dpdk-dev] [PATCH] docs: add default that all fixes are backported

[Thomas Monjalon]

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

Re: [dpdk-dev] [PATCH] docs: add default that all fixes are backported

[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 :-)

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.

[dpdk-dev] [PATCH v2] docs: add default that all fixes should be backported

[Kevin Traynor]

Set the starting point that all commits on master branch
with Fixes tag should be backported to relevant stable/LTS
branches, and explain that the submitter may indicate it is
not suitable for backport.

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: Luca Boccassi <bluca@debian.org>
Acked-by: Aaron Conole <aconole@redhat.com>
---
 doc/guides/contributing/stable.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
index 0f2f1f3..c8c6058 100644
--- a/doc/guides/contributing/stable.rst
+++ b/doc/guides/contributing/stable.rst
@@ -58,5 +58,8 @@ 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 should be backported to the relevant stable/LTS branches,
+unless the submitter indicates otherwise. 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
@@ -77,5 +80,6 @@ list.
 All fix patches to the master branch that are candidates for backporting
 should also be CCed to the `stable@dpdk.org <http://dpdk.org/ml/listinfo/stable>`_
-mailing list.
+mailing list. Absence of this CC is an indication that the patch is not suitable
+for backporting.
 
 
-- 
1.8.3.1

Re: [dpdk-dev] [PATCH] docs: add default that all fixes are backported

[Thomas Monjalon]

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

Re: [dpdk-dev] [PATCH v2] docs: add default that all fixes should be backported

[Thomas Monjalon]

29/06/2018 23:47, Kevin Traynor:
> -Backporting should be limited to bug fixes.
> +Backporting should be limited to bug fixes. All patches accepted on the master
> +branch with Fixes tags should be backported to the relevant stable/LTS branches,
> +unless the submitter indicates otherwise. 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
> @@ -77,5 +80,6 @@ list.
>  All fix patches to the master branch that are candidates for backporting
>  should also be CCed to the `stable@dpdk.org <http://dpdk.org/ml/listinfo/stable>`_
> -mailing list.
> +mailing list. Absence of this CC is an indication that the patch is not suitable
> +for backporting.

We should mention that it is not a matter of Cc'ing the dpdk-stable ML,
but more importantly, a tag which remains in the git history:
	Cc: stable@dpdk.org

[dpdk-dev] [PATCH v3] docs: add default that all fixes should be backported

[Kevin Traynor]

Set the starting point that all commits on master branch
with Fixes tag should be backported to relevant stable/LTS
branches, and explain that the submitter may indicate it is
not suitable for backport.

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: Luca Boccassi <bluca@debian.org>
Acked-by: Aaron Conole <aconole@redhat.com>
---
 doc/guides/contributing/stable.rst | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
index 0f2f1f3..f66e562 100644
--- a/doc/guides/contributing/stable.rst
+++ b/doc/guides/contributing/stable.rst
@@ -58,5 +58,23 @@ 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 a Fixes: tag should be backported to the relevant stable/LTS
+branches, unless the submitter indicates otherwise. If there are exceptions,
+they will be discussed on the mailing lists.
+
+Fixes suitable for backport should have a ``Cc: stable@dpdk.org`` tag in the
+commit message body as follows::
+
+     doc: fix some parameter description
+
+     Update the docs, fixing description of some parameter.
+
+     Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: stable@dpdk.org
+
+     Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
+Fixes not suitable for backport should not include the ``Cc: stable@dpdk.org`` tag.
 
 Features should not be backported to stable releases. It may be acceptable, in
-- 
1.8.3.1

Re: [dpdk-dev] [PATCH v2] docs: add default that all fixes should be backported

[Kevin Traynor]

On 06/29/2018 11:02 PM, Thomas Monjalon wrote:
> 29/06/2018 23:47, Kevin Traynor:
>> -Backporting should be limited to bug fixes.
>> +Backporting should be limited to bug fixes. All patches accepted on the master
>> +branch with Fixes tags should be backported to the relevant stable/LTS branches,
>> +unless the submitter indicates otherwise. 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
>> @@ -77,5 +80,6 @@ list.
>>  All fix patches to the master branch that are candidates for backporting
>>  should also be CCed to the `stable@dpdk.org <http://dpdk.org/ml/listinfo/stable>`_
>> -mailing list.
>> +mailing list. Absence of this CC is an indication that the patch is not suitable
>> +for backporting.
> 
> We should mention that it is not a matter of Cc'ing the dpdk-stable ML,
> but more importantly, a tag which remains in the git history:
> 	Cc: stable@dpdk.org
> 
> 

Yes, you are right - fixed that in v3. The format is mentioned in
patches.rst, but it's small so I added here to be complete.

Re: [dpdk-dev] [PATCH v3] docs: add default that all fixes should be backported

[Thomas Monjalon]

30/06/2018 01:10, Kevin Traynor:
> Set the starting point that all commits on master branch
> with Fixes tag should be backported to relevant stable/LTS
> branches, and explain that the submitter may indicate it is
> not suitable for backport.
> 
> 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: Luca Boccassi <bluca@debian.org>
> Acked-by: Aaron Conole <aconole@redhat.com>
> ---
> -Backporting should be limited to bug fixes.
> +Backporting should be limited to bug fixes. All patches accepted on the master
> +branch with a Fixes: tag should be backported to the relevant stable/LTS
> +branches, unless the submitter indicates otherwise. If there are exceptions,
> +they will be discussed on the mailing lists.
> +
> +Fixes suitable for backport should have a ``Cc: stable@dpdk.org`` tag in the
> +commit message body as follows::
> +
> +     doc: fix some parameter description
> +
> +     Update the docs, fixing description of some parameter.
> +
> +     Fixes: abcdefgh1234 ("doc: add some parameter")
> +     Cc: stable@dpdk.org
> +
> +     Signed-off-by: Alex Smith <alex.smith@example.com>
> +
> +
> +Fixes not suitable for backport should not include the ``Cc: stable@dpdk.org`` tag.

Acked-by: Thomas Monjalon <thomas@monjalon.net>

The technical board reviewed it and approve this clarified guideline.

Thanks

Re: [dpdk-dev] [PATCH v3] docs: add default that all fixes should be backported

[Thomas Monjalon]

04/07/2018 17:22, Thomas Monjalon:
> 30/06/2018 01:10, Kevin Traynor:
> > Set the starting point that all commits on master branch
> > with Fixes tag should be backported to relevant stable/LTS
> > branches, and explain that the submitter may indicate it is
> > not suitable for backport.
> > 
> > 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: Luca Boccassi <bluca@debian.org>
> > Acked-by: Aaron Conole <aconole@redhat.com>
> > ---
> > -Backporting should be limited to bug fixes.
> > +Backporting should be limited to bug fixes. All patches accepted on the master
> > +branch with a Fixes: tag should be backported to the relevant stable/LTS
> > +branches, unless the submitter indicates otherwise. If there are exceptions,
> > +they will be discussed on the mailing lists.
> > +
> > +Fixes suitable for backport should have a ``Cc: stable@dpdk.org`` tag in the
> > +commit message body as follows::
> > +
> > +     doc: fix some parameter description
> > +
> > +     Update the docs, fixing description of some parameter.
> > +
> > +     Fixes: abcdefgh1234 ("doc: add some parameter")
> > +     Cc: stable@dpdk.org
> > +
> > +     Signed-off-by: Alex Smith <alex.smith@example.com>
> > +
> > +
> > +Fixes not suitable for backport should not include the ``Cc: stable@dpdk.org`` tag.
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
> 
> The technical board reviewed it and approve this clarified guideline.

Applied, thanks