From: Marko Kovacevic <marko.kovacevic@intel.com>
To: dev@dpdk.org
Cc: ferruh.yigit@intel.com, john.mcnamara@intel.com,
Marko Kovacevic <marko.kovacevic@intel.com>
Subject: [dpdk-dev] [PATCH v1] doc: add guides for patch fix issues
Date: Mon, 28 May 2018 16:23:42 +0100 [thread overview]
Message-ID: <20180528152342.22467-1-marko.kovacevic@intel.com> (raw)
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
next reply other threads:[~2018-05-28 15:23 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-28 15:23 Marko Kovacevic [this message]
2018-05-28 15:53 ` Ferruh Yigit
2018-05-29 10:32 ` Thomas Monjalon
2018-05-29 10:45 ` Kovacevic, Marko
2018-05-29 11:01 ` [dpdk-dev] [PATCH v2] " Marko Kovacevic
2018-05-29 15:24 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180528152342.22467-1-marko.kovacevic@intel.com \
--to=marko.kovacevic@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=john.mcnamara@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).