[dpdk-dev] [PATCH v1 1/2] doc: add guidelines for coverity tags

[dpdk-dev] [PATCH v1 1/2] doc: add guidelines for coverity tags

[Marko Kovacevic]

     Added contribution guideline for adding tags
     when sending patches that have been raised by
     coverity

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

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 64408e7..e6b6e80 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -257,6 +257,26 @@ tags for who reported, suggested, tested and reviewed the patch being
 posted. Please refer to the `Tested, Acked and Reviewed by`_ section.
 
 
+Coverity Related Patch Fixes:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_ is a gratis
+static-analysis cloud-based service for the open source community. It is a tool for
+C,C++,C# and Java it is used for finding bugs through static analysis. If a patch
+fix is being sent to the mailing list due to a Coverity related issue,a
+Coverity issue tag should be inserted into the commit message body as so::
+
+     doc: fix some parameter description
+
+     Update the docs, fixing description of some parameter.
+
+     Coverity issue: 12345
+     Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: author@example.com
+
+     Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
 Creating Patches
 ----------------
 
-- 
2.9.5

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

[Marko Kovacevic]

   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>
 
 Creating Patches
 ----------------
-- 
2.9.5

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

[Hemant Agrawal]

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

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

[Kovacevic, Marko]

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

[dpdk-dev] [PATCH v2 1/2] doc: add guidelines for coverity tags

[Marko Kovacevic]

     Added contribution guideline for adding tags
     when sending patches that have been raised by
     coverity

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

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 64408e7..e6b6e80 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -257,6 +257,26 @@ tags for who reported, suggested, tested and reviewed the patch being
 posted. Please refer to the `Tested, Acked and Reviewed by`_ section.
 
 
+Coverity Related Patch Fixes:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_ is a gratis
+static-analysis cloud-based service for the open source community. It is a tool for
+C,C++,C# and Java it is used for finding bugs through static analysis. If a patch
+fix is being sent to the mailing list due to a Coverity related issue,a
+Coverity issue tag should be inserted into the commit message body as so::
+
+     doc: fix some parameter description
+
+     Update the docs, fixing description of some parameter.
+
+     Coverity issue: 12345
+     Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: author@example.com
+
+     Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
 Creating Patches
 ----------------
 
-- 
2.9.5

[dpdk-dev] [PATCH v2 2/2] doc: add guidelines for stable tags

[Marko Kovacevic]

   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 | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index e6b6e80..124dade 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -276,6 +276,23 @@ 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>
+
+For further information on stable contribution you can go here :doc:`Stable Contribution<stable>`
 
 Creating Patches
 ----------------
-- 
2.9.5

Re: [dpdk-dev] [PATCH v2 1/2] doc: add guidelines for coverity tags

[Hemant Agrawal]

On 1/10/2018 8:21 PM, Marko Kovacevic wrote:
>      Added contribution guideline for adding tags
>      when sending patches that have been raised by
>      coverity
>
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>

Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

Re: [dpdk-dev] [PATCH v2 2/2] doc: add guidelines for stable tags

[Hemant Agrawal]

On 1/10/2018 8:22 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>

Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

<snip>..

[dpdk-dev] [PATCH v3 1/2] doc: add guidelines for coverity tags

[Marko Kovacevic]

     Added contribution guideline for adding tags
     when sending patches that have been raised by
     coverity

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 64408e7..59d2aaf 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -257,6 +257,27 @@ tags for who reported, suggested, tested and reviewed the patch being
 posted. Please refer to the `Tested, Acked and Reviewed by`_ section.
 
 
+Coverity Related Patch Fixes:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_ is a tool for
+static code analysis. It is used as a cloud-based service used to scan the
+DPDK source code, and alert developers of any potential defects in the source code.
+When fixing an issue found by Coverity, the patch must contain a Coverity issue ID in the
+body of the commit message. For example::
+
+
+     doc: fix some parameter description
+
+     Update the docs, fixing description of some parameter.
+
+     Coverity issue: 12345
+     Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: author@example.com
+
+     Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
 Creating Patches
 ----------------
 
-- 
2.9.5

[dpdk-dev] [PATCH v3 1/2] doc: add guidelines for coverity tags

[Marko Kovacevic]

     Added contribution guideline for adding tags
     when sending patches that have been raised by
     coverity

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 64408e7..59d2aaf 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -257,6 +257,27 @@ tags for who reported, suggested, tested and reviewed the patch being
 posted. Please refer to the `Tested, Acked and Reviewed by`_ section.
 
 
+Coverity Related Patch Fixes:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_ is a tool for
+static code analysis. It is used as a cloud-based service used to scan the
+DPDK source code, and alert developers of any potential defects in the source code.
+When fixing an issue found by Coverity, the patch must contain a Coverity issue ID in the
+body of the commit message. For example::
+
+
+     doc: fix some parameter description
+
+     Update the docs, fixing description of some parameter.
+
+     Coverity issue: 12345
+     Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: author@example.com
+
+     Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
 Creating Patches
 ----------------
 
-- 
2.9.5

[dpdk-dev] [PATCH v3 1/2] doc: add guidelines for coverity tags

[Marko Kovacevic]

     Added contribution guideline for adding tags
     when sending patches that have been raised by
     coverity

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 64408e7..59d2aaf 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -257,6 +257,27 @@ tags for who reported, suggested, tested and reviewed the patch being
 posted. Please refer to the `Tested, Acked and Reviewed by`_ section.
 
 
+Coverity Related Patch Fixes:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_ is a tool for
+static code analysis. It is used as a cloud-based service used to scan the
+DPDK source code, and alert developers of any potential defects in the source code.
+When fixing an issue found by Coverity, the patch must contain a Coverity issue ID in the
+body of the commit message. For example::
+
+
+     doc: fix some parameter description
+
+     Update the docs, fixing description of some parameter.
+
+     Coverity issue: 12345
+     Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: author@example.com
+
+     Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
 Creating Patches
 ----------------
 
-- 
2.9.5

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

[Marko Kovacevic]

   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(+)

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

Re: [dpdk-dev] [PATCH v3 1/2] doc: add guidelines for coverity tags

[Mcnamara, John]

> -----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 1/2] doc: add guidelines for coverity tags
> 
>      Added contribution guideline for adding tags
>      when sending patches that have been raised by
>      coverity
> 
> 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>

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

[Mcnamara, John]

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

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

[Ferruh Yigit]

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>

Re: [dpdk-dev] [PATCH v3 1/2] doc: add guidelines for coverity tags

[Ferruh Yigit]

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 1/2] doc: add guidelines for coverity tags
>>
>>      Added contribution guideline for adding tags
>>      when sending patches that have been raised by
>>      coverity
>>
>> 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>

Re: [dpdk-dev] [PATCH v3 1/2] doc: add guidelines for coverity tags

[Thomas Monjalon]

13/02/2018 12:59, Ferruh Yigit:
> 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 1/2] doc: add guidelines for coverity tags
> >>
> >>      Added contribution guideline for adding tags
> >>      when sending patches that have been raised by
> >>      coverity
> >>
> >> 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>

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

Applied with minor formatting changes, thanks.