[dpdk-dev] [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 at 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 at example.com
+
+       Signed-off-by: Alex Smith <alex.smith at 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 at example.com
+
+       Signed-off-by: Alex Smith <alex.smith at example.com>
 
-     Update the docs, fixing description of some parameter.
 
-     Coverity issue: 12345
-     Fixes: abcdefgh1234 ("doc: add some parameter")
-     Cc: author at example.com
 
-     Signed-off-by: Alex Smith <alex.smith at example.com>
 
 Patch for Stable Releases
 ~~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.9.5