[dpdk-dev] doc: advise to specify LTS branch when backporting patches
diff mbox

Message ID 20180516143134.24838-1-luca.boccassi@gmail.com
State Superseded, archived
Headers show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Luca Boccassi May 16, 2018, 2:31 p.m. UTC
From: Luca Boccassi <bluca@debian.org>

We have many stable branches being maintaned at the same time, and
sometimes it's not clear which branch a patch is being backported for.
Note in the guidelines that it should be specified via the cover letter,
annotation or using --subject-prefix.
Also note to send only to stable@dpdk.org, not dev@dpdk.org.

Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 doc/guides/contributing/patches.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Kevin Traynor May 16, 2018, 3:19 p.m. UTC | #1
On 05/16/2018 03:31 PM, luca.boccassi@gmail.com wrote:
> From: Luca Boccassi <bluca@debian.org>
> 
> We have many stable branches being maintaned at the same time, and

typo

> sometimes it's not clear which branch a patch is being backported for.
> Note in the guidelines that it should be specified via the cover letter,
> annotation or using --subject-prefix.
> Also note to send only to stable@dpdk.org, not dev@dpdk.org.
> 
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
>  doc/guides/contributing/patches.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index 2287835f9..1dc623a23 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -450,6 +450,14 @@ Experienced committers may send patches directly with ``git send-email`` without
>  The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending.
>  
>  
> +Backporting patches for Stable Releases
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Sometimes a maintainer or contributor wishes, or can be asked, to send a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``stable@dpdk.org``, not to ``dev@dpdk.org``.
> +
> +Given that there are multiple stable releases being maintained at the same time, please specify exactly which branch the patch is for in the cover letter, in the annotation or using ``git send-email --subject-prefix='16.11' ...``
> +

s/branch/branch(es)/

How about [16.11] instead of '16.11' ?

I would be in favour that the prefix(es) should always be added for this
very specific case, as it will make it stand out more.

either way,
Acked-by: Kevin Traynor <ktraynor@redhat.com>

> +
>  The Review Process
>  ------------------
>  
>
Luca Boccassi May 16, 2018, 5:03 p.m. UTC | #2
On Wed, 2018-05-16 at 16:19 +0100, Kevin Traynor wrote:
> On 05/16/2018 03:31 PM, luca.boccassi@gmail.com wrote:
> > From: Luca Boccassi <bluca@debian.org>
> > 
> > We have many stable branches being maintaned at the same time, and
> 
> typo
> 
> > sometimes it's not clear which branch a patch is being backported
> > for.
> > Note in the guidelines that it should be specified via the cover
> > letter,
> > annotation or using --subject-prefix.
> > Also note to send only to stable@dpdk.org, not dev@dpdk.org.
> > 
> > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > ---
> >  doc/guides/contributing/patches.rst | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> > 
> > diff --git a/doc/guides/contributing/patches.rst
> > b/doc/guides/contributing/patches.rst
> > index 2287835f9..1dc623a23 100644
> > --- a/doc/guides/contributing/patches.rst
> > +++ b/doc/guides/contributing/patches.rst
> > @@ -450,6 +450,14 @@ Experienced committers may send patches
> > directly with ``git send-email`` without
> >  The options ``--annotate`` and ``confirm = always`` are
> > recommended for checking patches before sending.
> >  
> >  
> > +Backporting patches for Stable Releases
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +Sometimes a maintainer or contributor wishes, or can be asked, to
> > send a patch for a stable release rather than mainline. In this
> > case the patch(es) should be sent to ``stable@dpdk.org``, not to ``
> > dev@dpdk.org``.
> > +
> > +Given that there are multiple stable releases being maintained at
> > the same time, please specify exactly which branch the patch is for
> > in the cover letter, in the annotation or using ``git send-email --
> > subject-prefix='16.11' ...``
> > +
> 
> s/branch/branch(es)/
> 
> How about [16.11] instead of '16.11' ?

Using --subject-prefix git will already use "[PATCH 16.11]

> I would be in favour that the prefix(es) should always be added for
> this
> very specific case, as it will make it stand out more.
> 
> either way,
> Acked-by: Kevin Traynor <ktraynor@redhat.com>

Makes sense, I've slightly re-arranged to wording for that
Thomas Monjalon May 17, 2018, 1:12 p.m. UTC | #3
16/05/2018 19:03, Luca Boccassi:
> On Wed, 2018-05-16 at 16:19 +0100, Kevin Traynor wrote:
> > On 05/16/2018 03:31 PM, luca.boccassi@gmail.com wrote:
> > > From: Luca Boccassi <bluca@debian.org>
> > > 
> > > We have many stable branches being maintaned at the same time, and
> > 
> > typo
> > 
> > > sometimes it's not clear which branch a patch is being backported
> > > for.
> > > Note in the guidelines that it should be specified via the cover
> > > letter,
> > > annotation or using --subject-prefix.
> > > Also note to send only to stable@dpdk.org, not dev@dpdk.org.
> > > 
> > > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > > ---
> > >  doc/guides/contributing/patches.rst | 8 ++++++++
> > >  1 file changed, 8 insertions(+)
> > > 
> > > diff --git a/doc/guides/contributing/patches.rst
> > > b/doc/guides/contributing/patches.rst
> > > index 2287835f9..1dc623a23 100644
> > > --- a/doc/guides/contributing/patches.rst
> > > +++ b/doc/guides/contributing/patches.rst
> > > @@ -450,6 +450,14 @@ Experienced committers may send patches
> > > directly with ``git send-email`` without
> > >  The options ``--annotate`` and ``confirm = always`` are
> > > recommended for checking patches before sending.
> > >  
> > >  
> > > +Backporting patches for Stable Releases
> > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > > +
> > > +Sometimes a maintainer or contributor wishes, or can be asked, to
> > > send a patch for a stable release rather than mainline. In this
> > > case the patch(es) should be sent to ``stable@dpdk.org``, not to ``
> > > dev@dpdk.org``.
> > > +
> > > +Given that there are multiple stable releases being maintained at
> > > the same time, please specify exactly which branch the patch is for
> > > in the cover letter, in the annotation or using ``git send-email --
> > > subject-prefix='16.11' ...``
> > > +
> > 
> > s/branch/branch(es)/
> > 
> > How about [16.11] instead of '16.11' ?
> 
> Using --subject-prefix git will already use "[PATCH 16.11]

I think it should be --subject-prefix='PATCH 16.11'

Please wrap the lines after some punctuation signs to avoid really long lines
in the rst file.
Luca Boccassi May 17, 2018, 1:54 p.m. UTC | #4
On Thu, 2018-05-17 at 15:12 +0200, Thomas Monjalon wrote:
> 16/05/2018 19:03, Luca Boccassi:
> > On Wed, 2018-05-16 at 16:19 +0100, Kevin Traynor wrote:
> > > On 05/16/2018 03:31 PM, luca.boccassi@gmail.com wrote:
> > > > From: Luca Boccassi <bluca@debian.org>
> > > > 
> > > > We have many stable branches being maintaned at the same time,
> > > > and
> > > 
> > > typo
> > > 
> > > > sometimes it's not clear which branch a patch is being
> > > > backported
> > > > for.
> > > > Note in the guidelines that it should be specified via the
> > > > cover
> > > > letter,
> > > > annotation or using --subject-prefix.
> > > > Also note to send only to stable@dpdk.org, not dev@dpdk.org.
> > > > 
> > > > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > > > ---
> > > >  doc/guides/contributing/patches.rst | 8 ++++++++
> > > >  1 file changed, 8 insertions(+)
> > > > 
> > > > diff --git a/doc/guides/contributing/patches.rst
> > > > b/doc/guides/contributing/patches.rst
> > > > index 2287835f9..1dc623a23 100644
> > > > --- a/doc/guides/contributing/patches.rst
> > > > +++ b/doc/guides/contributing/patches.rst
> > > > @@ -450,6 +450,14 @@ Experienced committers may send patches
> > > > directly with ``git send-email`` without
> > > >  The options ``--annotate`` and ``confirm = always`` are
> > > > recommended for checking patches before sending.
> > > >  
> > > >  
> > > > +Backporting patches for Stable Releases
> > > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > > > +
> > > > +Sometimes a maintainer or contributor wishes, or can be asked,
> > > > to
> > > > send a patch for a stable release rather than mainline. In this
> > > > case the patch(es) should be sent to ``stable@dpdk.org``, not
> > > > to ``
> > > > dev@dpdk.org``.
> > > > +
> > > > +Given that there are multiple stable releases being maintained
> > > > at
> > > > the same time, please specify exactly which branch the patch is
> > > > for
> > > > in the cover letter, in the annotation or using ``git send-
> > > > email --
> > > > subject-prefix='16.11' ...``
> > > > +
> > > 
> > > s/branch/branch(es)/
> > > 
> > > How about [16.11] instead of '16.11' ?
> > 
> > Using --subject-prefix git will already use "[PATCH 16.11]
> 
> I think it should be --subject-prefix='PATCH 16.11'
> 
> Please wrap the lines after some punctuation signs to avoid really
> long lines
> in the rst file.

Ok, done both in v3.

Patch
diff mbox

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 2287835f9..1dc623a23 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -450,6 +450,14 @@  Experienced committers may send patches directly with ``git send-email`` without
 The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending.
 
 
+Backporting patches for Stable Releases
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sometimes a maintainer or contributor wishes, or can be asked, to send a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``stable@dpdk.org``, not to ``dev@dpdk.org``.
+
+Given that there are multiple stable releases being maintained at the same time, please specify exactly which branch the patch is for in the cover letter, in the annotation or using ``git send-email --subject-prefix='16.11' ...``
+
+
 The Review Process
 ------------------