doc: add guides for patch fix issues
PATCH 1/1 doc: add guides for patch fix issues
Added contribution guideline for adding tags
when sending patches that have been raised on
Bugzilla
--- doc/guides/contributing/patches.rst | 48 ++++++++++++++++++++++++++----------- 1 file changed, 34 insertions(+), 14 deletions(-)
doc/guides/contributing/patches.rst +34 -14
@@ -256,26 +256,46 @@ In addition to the ``Signed-off-by:`` name the commit messages can also have 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 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Patch Fix Related Issues +~~~~~~~~~~~~~~~~~~~~~~~~ -`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:: + `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 + 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]> + + + `Bugzilla <https://dpdk.org/tracker>`_ + is a bug- or issue-tracking system. Bug-tracking + systems allow individual or groups of developers effectively to keep track of outstanding + problems with their product. When fixing an issue raised in Bugzilla, the patch must contain + a Bugzilla issue ID in the body of the commit message. For example:: + + doc: fix some parameter description + + Update the docs, fixing description of some parameter. + + Bugzilla ID: 12345 + Fixes: abcdefgh1234 ("doc: add some parameter") + Cc: [email protected] + + Signed-off-by: Alex Smith <[email protected]> - 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]> Patch for Stable Releases ~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.9.5
Quoted 5 lines · Marko Kovacevic
Added contribution guideline for adding tags
when sending patches that have been raised on
BugzillaSigned-off-by Marko Kovacevic <[email protected]>
28/05/2018 17:23, Marko Kovacevic:
doc/guides/contributing/patches.rst In addition to the ``Signed-off-by:`` name the commit messages can also have · line 267
Quoted 12 lines
-
Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>_doc/guides/contributing/patches.rst +6
-5-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:: + `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::
Why the indentation is changed?
Quoted 10 lines
28/05/2018 17:23, Marko Kovacevic:
Quoted 8 lines
-`Coverity
<https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_(quoted diff) +0
-2-is a tool for static code analysis. -It is used as a cloud-based service used to scan the DPDK sourcecode, -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::
+ `Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_
Quoted 9 lines
doc/guides/contributing/patches.rst In addition to the ``Signed-off-by:`` name the commit messages can also have
Quoted 4 lines
doc/guides/contributing/patches.rst +4
-0+ 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 aCoverity issue ID
Quoted 1 line
+ in the body of the commit message. For example::
Why the indentation is changed?
My bad I tried doing it differently yesterday and saw the way you changed it And just kept it the same way because it looked good but forgot to bring the text back.
I'll send a v2 now.
Marko K
PATCH v2 1/1 doc: add guides for patch fix issues
In reply to Marko KovacevicAdded contribution guideline for adding tags
when sending patches that have been raised on
Bugzilla
---
V2: removed accidental indents (Thomas)
--- doc/guides/contributing/patches.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-)
doc/guides/contributing/patches.rst +19 -2
@@ -256,8 +256,8 @@ In addition to the ``Signed-off-by:`` name the commit messages can also have 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 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Patch Fix Related Issues +~~~~~~~~~~~~~~~~~~~~~~~~ `Coverity <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_ is a tool for static code analysis.
@@ -277,6 +277,23 @@ in the body of the commit message. For example:: Signed-off-by: Alex Smith <[email protected]> + +`Bugzilla <https://dpdk.org/tracker>`_ +is a bug- or issue-tracking system. Bug-tracking +systems allow individual or groups of developers effectively to keep track of outstanding +problems with their product. When fixing an issue raised in Bugzilla, the patch must contain +a Bugzilla issue ID in the body of the commit message. For example:: + + doc: fix some parameter description + + Update the docs, fixing description of some parameter. + + Bugzilla ID: 12345 + Fixes: abcdefgh1234 ("doc: add some parameter") + Cc: [email protected] + + Signed-off-by: Alex Smith <[email protected]> + Patch for Stable Releases ~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.9.5
Thomas Monjalon
Applied29/05/2018 13:01, Marko Kovacevic:
Quoted 6 lines
Added contribution guideline for adding tags
when sending patches that have been raised on
BugzillaSigned-off-by Marko Kovacevic <[email protected]>Acked-by Ferruh Yigit <[email protected]>
Applied, thanks.
Note: I have re-wrapped the text below:
doc/guides/contributing/patches.rst in the body of the commit message. For example:: · line 285
Quoted 5 lines
+
Bugzilla <https://dpdk.org/tracker>_doc/guides/contributing/patches.rst +4
-0+is a bug- or issue-tracking system. Bug-tracking +systems allow individual or groups of developers effectively to keep track of outstanding +problems with their product. When fixing an issue raised in Bugzilla, the patch must contain +a Bugzilla issue ID in the body of the commit message. For example::
to be more logically split:
+Bugzilla <https://dpdk.org/tracker>_
+is a bug- or issue-tracking system.
+Bug-tracking systems allow individual or groups of developers +effectively to keep track of outstanding problems with their product. +When fixing an issue raised in Bugzilla, the patch must contain +a Bugzilla issue ID in the body of the commit message. +For example::
It think such wrapping should be preferred because it allows to change or remove a sentence without disturbing the other ones.