[dpdk-dev] [PATCH v2] doc: add guides for patch fix issues

Marko Kovacevic marko.kovacevic at intel.com
Tue May 29 13:01:24 CEST 2018


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>
Acked-by: Ferruh Yigit <ferruh.yigit at 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 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>
+
 Patch for Stable Releases
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.9.5



More information about the dev mailing list