diff mbox

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

Message ID 20180529110124.35666-1-marko.kovacevic@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK

Commit Message

Kovacevic, Marko May 29, 2018, 11:01 a.m. UTC 
  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(-)

Comments

Thomas Monjalon May 29, 2018, 3:24 p.m. UTC | #1 
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.
diff mbox

Patch

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
 ~~~~~~~~~~~~~~~~~~~~~~~~~