[dpdk-dev,v1,2/2] doc: add guidelines for stable tags

Message ID 20180109155101.12165-2-marko.kovacevic@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

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

Commit Message

Kovacevic, Marko Jan. 9, 2018, 3:51 p.m. UTC
  Added contribution guideline for adding stable
   tags when sending patches all fix patches to the
   master branch that are candidates for backporting

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
---
 doc/guides/contributing/patches.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
  

Comments

Hemant Agrawal Jan. 10, 2018, 12:34 p.m. UTC | #1
On 1/9/2018 9:21 PM, Marko Kovacevic wrote:
>    Added contribution guideline for adding stable
>    tags when sending patches all fix patches to the
>    master branch that are candidates for backporting
>
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
> ---
>  doc/guides/contributing/patches.rst | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
>
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index e6b6e80..f98e601 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -276,6 +276,21 @@ Coverity issue tag should be inserted into the commit message body as so::
>
>       Signed-off-by: Alex Smith <alex.smith@example.com>
>
> +Patch for Stable Releases:
> +~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +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. In the commit message body the Cc: stable@dpdk.org should be inserted as so::
> +
> +     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>
>

you may also give reference to 
http://dpdk.org/doc/guides/contributing/stable.html


>  Creating Patches
>  ----------------
>
  
Kovacevic, Marko Jan. 10, 2018, 1:34 p.m. UTC | #2
Sure thing will do.

<...>

> > +Patch for Stable Releases:
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +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. In the commit message body the Cc: stable@dpdk.org should be
> inserted as so::
> > +
> > +     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>
> >
> 
> you may also give reference to
> http://dpdk.org/doc/guides/contributing/stable.html
> 
> 
> >  Creating Patches
> >  ----------------
> >
  

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index e6b6e80..f98e601 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -276,6 +276,21 @@  Coverity issue tag should be inserted into the commit message body as so::
 
      Signed-off-by: Alex Smith <alex.smith@example.com>
 
+Patch for Stable Releases:
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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. In the commit message body the Cc: stable@dpdk.org should be inserted as so::
+
+     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>
 
 Creating Patches
 ----------------