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

Message ID 20180516170538.21784-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, 5:05 p.m. UTC
From: Luca Boccassi <bluca@debian.org>

We have many stable branches being maintained 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>
---

v2: hint that --subject-prefix is required, fix typos

 doc/guides/contributing/patches.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Kevin Traynor May 16, 2018, 7:45 p.m. UTC | #1
On 05/16/2018 06:05 PM, luca.boccassi@gmail.com wrote:
> From: Luca Boccassi <bluca@debian.org>
> 
> We have many stable branches being maintained 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.
> 

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

> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
> 
> v2: hint that --subject-prefix is required, fix typos
> 
>  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..47c41288e 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(es) the patch is for using ``git send-email --subject-prefix='16.11' ...`` and also optionally in the cover letter or in the annotation.
> +
> +
>  The Review Process
>  ------------------
>  
>

Patch
diff mbox

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 2287835f9..47c41288e 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(es) the patch is for using ``git send-email --subject-prefix='16.11' ...`` and also optionally in the cover letter or in the annotation.
+
+
 The Review Process
 ------------------