[PATCH v1] doc: add guides for patch fix issues

[PATCH v1] doc: add guides for patch fix issues

[Marko Kovacevic]

Added contribution guideline for adding tags
when sending patches that have been raised on
Bugzilla

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

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 7bb5710..0033fd4 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -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: author@example.com
+
+       Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
+  `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: author@example.com
+
+       Signed-off-by: Alex Smith <alex.smith@example.com>
 
-     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>
 
 Patch for Stable Releases
 ~~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.9.5

Re: [PATCH v1] doc: add guides for patch fix issues

[Ferruh Yigit]

On 5/28/2018 4:23 PM, Marko Kovacevic wrote:
> Added contribution guideline for adding tags
> when sending patches that have been raised on
> Bugzilla
> 
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>

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

Re: [PATCH v1] doc: add guides for patch fix issues

[Thomas Monjalon]

28/05/2018 17:23, Marko Kovacevic:
> -`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::

Why the indentation is changed?

Re: [PATCH v1] doc: add guides for patch fix issues

[Kovacevic, Marko]

> 28/05/2018 17:23, Marko Kovacevic:
> > -`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::
> 
> 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] doc: add guides for patch fix issues

[Marko Kovacevic]

Added contribution guideline for adding tags
when sending patches that have been raised on
Bugzilla

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

---

V2: removed accidental indents  (Thomas)
---
 doc/guides/contributing/patches.rst | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 7bb5710..3707711 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -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 <alex.smith@example.com>
 
+
+`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: author@example.com
+
+    Signed-off-by: Alex Smith <alex.smith@example.com>
+
 Patch for Stable Releases
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.9.5

Re: [PATCH v2] doc: add guides for patch fix issues

[Thomas Monjalon]

29/05/2018 13:01, Marko Kovacevic:
> Added contribution guideline for adding tags
> when sending patches that have been raised on
> Bugzilla
> 
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied, thanks.

Note: I have re-wrapped the text below:

> +`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::

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.