doc: add guidelines for coverity tags
PATCH 1/2 doc: add guidelines for coverity tags
Added contribution guideline for adding tags when sending patches that have been raised by coverity
--- doc/guides/contributing/patches.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+)
doc/guides/contributing/patches.rst +20 -0
@@ -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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + + Creating Patches ----------------
Signature · 1 line
2.9.5
PATCH 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
--- doc/guides/contributing/patches.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
doc/guides/contributing/patches.rst +15 -0
@@ -276,6 +276,21 @@ Coverity issue tag should be inserted into the commit message body as so:: Signed-off-by: Alex Smith <[email protected]> +Patch for Stable Releases: +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All fix patches to the master branch that are candidates for backporting +should also be CCed to the `[email protected] <http://dpdk.org/ml/listinfo/stable>`_ +mailing list. In the commit message body the Cc: [email protected] 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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> Creating Patches ----------------
Signature · 1 line
2.9.5
Re: [PATCH v1 2/2] doc: add guidelines for stable tags
Quoted 23 lines · 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 <[email protected]>--- doc/guides/contributing/patches.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+)doc/guides/contributing/patches.rst +6
-0@@ -276,6 +276,21 @@ Coverity issue tag should be inserted into the commit message body as so:: Signed-off-by: Alex Smith <[email protected]> +Patch for Stable Releases: +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All fix patches to the master branch that are candidates for backporting +should also be CCed to the `[email protected] <http://dpdk.org/ml/listinfo/stable>`_ +mailing list. In the commit message body the Cc: [email protected] should be inserted as so::
doc/guides/contributing/patches.rst Coverity issue tag should be inserted into the commit message body as so:: · line 294
Quoted 10 lines
doc/guides/contributing/patches.rst +9
-0+ + doc: fix some parameter description + + Update the docs, fixing description of some parameter. + + Fixes: abcdefgh1234 ("doc: add some parameter") + Cc: [email protected] + + Signed-off-by: Alex Smith <[email protected]>
you may also give reference to http://dpdk.org/doc/guides/contributing/stable.html
Quoted 3 lines
doc/guides/contributing/patches.rst +0
-0Creating Patches ----------------
Re: [PATCH v1 2/2] doc: add guidelines for stable tags
Sure thing will do.
<...>
Quoted 26 lines
Review
Quoted 7 lines
(quoted diff) +7
-0+Patch for Stable Releases: +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All fix patches to the master branch that are candidates for +backporting should also be CCed to the `[email protected] +<http://dpdk.org/ml/listinfo/stable>`_ +mailing list. In the commit message body the Cc: [email protected] should beinserted as so::
doc/guides/contributing/patches.rst Coverity issue tag should be inserted into the commit message body as so:: · line 293
Quoted 10 lines
doc/guides/contributing/patches.rst +9
-0+ + doc: fix some parameter description + + Update the docs, fixing description of some parameter. + + Fixes: abcdefgh1234 ("doc: add some parameter") + Cc: [email protected] + + Signed-off-by: Alex Smith <[email protected]>you may also give reference to
http://dpdk.org/doc/guides/contributing/stable.htmlQuoted 3 lines
Creating Patches
----------------
PATCH v2 1/2 doc: add guidelines for coverity tags
In reply to Marko KovacevicAdded contribution guideline for adding tags when sending patches that have been raised by coverity
--- doc/guides/contributing/patches.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+)
doc/guides/contributing/patches.rst +20 -0
@@ -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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + + Creating Patches ----------------
Signature · 1 line
2.9.5
PATCH v2 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
--- doc/guides/contributing/patches.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
doc/guides/contributing/patches.rst +17 -0
@@ -276,6 +276,23 @@ Coverity issue tag should be inserted into the commit message body as so:: Signed-off-by: Alex Smith <[email protected]> +Patch for Stable Releases: +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All fix patches to the master branch that are candidates for backporting +should also be CCed to the `[email protected] <http://dpdk.org/ml/listinfo/stable>`_ +mailing list. In the commit message body the Cc: [email protected] 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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + +For further information on stable contribution you can go here :doc:`Stable Contribution<stable>` Creating Patches ----------------
Signature · 1 line
2.9.5
Re: [PATCH v2 2/2] doc: add guidelines for stable tags
Quoted 5 lines · 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 <[email protected]>
<snip>..
Quoted 5 lines · Marko Kovacevic
Added contribution guideline for adding tags when sending patches that have been raised by coverity
Signed-off-by Marko Kovacevic <[email protected]>
PATCH v3 1/2 doc: add guidelines for coverity tags
In reply to Marko KovacevicAdded contribution guideline for adding tags when sending patches that have been raised by coverity
--- doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)
doc/guides/contributing/patches.rst +21 -0
@@ -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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + + Creating Patches ----------------
Signature · 1 line
2.9.5
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
--- doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)
doc/guides/contributing/patches.rst +21 -0
@@ -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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + + Creating Patches ----------------
Signature · 1 line
2.9.5
PATCH v3 1/2 doc: add guidelines for coverity tags
In reply to Marko KovacevicAdded contribution guideline for adding tags when sending patches that have been raised by coverity
--- doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)
doc/guides/contributing/patches.rst +21 -0
@@ -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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + + Creating Patches ----------------
Signature · 1 line
2.9.5
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
--- doc/guides/contributing/patches.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
doc/guides/contributing/patches.rst +17 -0
@@ -277,6 +277,23 @@ body of the commit message. For example:: Signed-off-by: Alex Smith <[email protected]> +Patch for Stable Releases: +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All fix patches to the master branch that are candidates for backporting +should also be CCed to the `[email protected] <http://dpdk.org/ml/listinfo/stable>`_ +mailing list. In the commit message body the Cc: [email protected] 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: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + +For further information on stable contribution you can go here :doc:`Stable Contribution<stable>` Creating Patches ----------------
Signature · 1 line
2.9.5
Re: [PATCH v3 2/2] doc: add guidelines for stable tags
Quoted 11 lines
-----Original Message-----
From: Kovacevic, Marko
Sent: Tuesday, January 16, 2018 9:13 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Yigit, Ferruh <[email protected]>; [email protected]; Kovacevic, Marko <[email protected]>
Subject: [PATCH v3 2/2] doc: add guidelines for stable tags
Quoted 6 lines
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 <[email protected]>Acked-by Hemant Agrawal <[email protected]>
The commit message shouldn't be indented. Apart from that:
Ferruh Yigit
Acked-byRe: [PATCH v3 2/2] doc: add guidelines for stable tags
Quoted 15 lines · John
Quoted 15 lines
-----Original Message-----
From: Kovacevic, Marko
Sent: Tuesday, January 16, 2018 9:13 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Yigit, Ferruh <[email protected]>; [email protected]; Kovacevic, Marko <[email protected]>
Subject: [PATCH v3 2/2] doc: add guidelines for stable tagsAdded contribution guideline for adding stable tags when sending patches all fix patches to the master branch that are candidates for backporting
Quoted 6 lines
Quoted 2 lines
Signed-off-by Marko Kovacevic <[email protected]>Acked-by Hemant Agrawal <[email protected]>The commit message shouldn't be indented. Apart from that:
Acked-by John McNamara <[email protected]>
Quoted 11 lines
-----Original Message-----
From: Kovacevic, Marko
Sent: Tuesday, January 16, 2018 9:13 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Yigit, Ferruh <[email protected]>; [email protected]; Kovacevic, Marko <[email protected]>
Subject: [PATCH v3 1/2] doc: add guidelines for coverity tags
Quoted 6 lines
Added contribution guideline for adding tags when sending patches that have been raised by coverity
Signed-off-by Marko Kovacevic <[email protected]>Acked-by Hemant Agrawal <[email protected]>
The commit message shouldn't be indented. Apart from that:
Ferruh Yigit
Acked-byQuoted 15 lines · John
Quoted 15 lines
-----Original Message-----
From: Kovacevic, Marko
Sent: Tuesday, January 16, 2018 9:13 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Yigit, Ferruh <[email protected]>; [email protected]; Kovacevic, Marko <[email protected]>
Subject: [PATCH v3 1/2] doc: add guidelines for coverity tagsAdded contribution guideline for adding tags when sending patches that have been raised by coverity
Quoted 6 lines
Quoted 2 lines
Signed-off-by Marko Kovacevic <[email protected]>Acked-by Hemant Agrawal <[email protected]>The commit message shouldn't be indented. Apart from that:
Acked-by John McNamara <[email protected]>
13/02/2018 12:59, Ferruh Yigit:
Quoted 16 lines · John
Quoted 15 lines
Quoted 15 lines
-----Original Message-----
From: Kovacevic, Marko
Sent: Tuesday, January 16, 2018 9:13 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Yigit, Ferruh <[email protected]>; [email protected]; Kovacevic, Marko <[email protected]>
Subject: [PATCH v3 1/2] doc: add guidelines for coverity tagsAdded contribution guideline for adding tags when sending patches that have been raised by coverity
Quoted 8 lines
Quoted 6 lines
Quoted 2 lines
Signed-off-by Marko Kovacevic <[email protected]>Acked-by Hemant Agrawal <[email protected]>The commit message shouldn't be indented. Apart from that:
Acked-by John McNamara <[email protected]>Acked-by Ferruh Yigit <[email protected]>
Series Acked-by: Thomas Monjalon <[email protected]>
Applied with minor formatting changes, thanks.