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

Message ID 20180116091247.20842-2-marko.kovacevic@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Kovacevic, Marko Jan. 16, 2018, 9:12 a.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>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/contributing/patches.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
  

Comments

John McNamara Jan. 16, 2018, 4:37 p.m. UTC | #1
> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Tuesday, January 16, 2018 9:13 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Yigit, Ferruh
> <ferruh.yigit@intel.com>; hemant.agrawal@nxp.com; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Subject: [PATCH v3 2/2] doc: add guidelines for stable tags
> 
>    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>
> Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

The commit message shouldn't be indented. Apart from that:

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Ferruh Yigit Feb. 13, 2018, 11:58 a.m. UTC | #2
On 1/16/2018 4:37 PM, Mcnamara, John wrote:
> 
> 
>> -----Original Message-----
>> From: Kovacevic, Marko
>> Sent: Tuesday, January 16, 2018 9:13 AM
>> To: dev@dpdk.org
>> Cc: Mcnamara, John <john.mcnamara@intel.com>; Yigit, Ferruh
>> <ferruh.yigit@intel.com>; hemant.agrawal@nxp.com; Kovacevic, Marko
>> <marko.kovacevic@intel.com>
>> Subject: [PATCH v3 2/2] doc: add guidelines for stable tags
>>
>>    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>
>> Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> 
> The commit message shouldn't be indented. Apart from that:
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 59d2aaf..cef9776 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -277,6 +277,23 @@  body of the commit message. For example::
 
      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 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>
+
+For further information on stable contribution you can go here :doc:`Stable Contribution<stable>`
 
 Creating Patches
 ----------------