All of lore.kernel.org
 help / color / mirror / Atom feed
From: Marko Kovacevic <marko.kovacevic@intel.com>
To: dev@dpdk.org
Cc: john.mcnamara@intel.com, ferruh.yigit@intel.com,
	hemant.agrawal@nxp.com,
	Marko Kovacevic <marko.kovacevic@intel.com>
Subject: [PATCH v3 1/2] doc: add guidelines for coverity tags
Date: Tue, 16 Jan 2018 09:08:53 +0000	[thread overview]
Message-ID: <20180116090854.20773-1-marko.kovacevic@intel.com> (raw)
In-Reply-To: <20180110145200.13895-1-marko.kovacevic@intel.com>

     Added contribution guideline for adding tags
     when sending patches that have been raised by
     coverity

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 64408e7..59d2aaf 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -257,6 +257,27 @@ 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:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`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
+
+     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>
+
+
 Creating Patches
 ----------------
 
-- 
2.9.5

  parent reply	other threads:[~2018-01-16  9:09 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-09 15:51 [PATCH v1 1/2] doc: add guidelines for coverity tags Marko Kovacevic
2018-01-09 15:51 ` [PATCH v1 2/2] doc: add guidelines for stable tags Marko Kovacevic
2018-01-10 12:34   ` Hemant Agrawal
2018-01-10 13:34     ` Kovacevic, Marko
2018-01-10 14:51   ` [PATCH v2 1/2] doc: add guidelines for coverity tags Marko Kovacevic
2018-01-10 14:52     ` [PATCH v2 2/2] doc: add guidelines for stable tags Marko Kovacevic
2018-01-15 15:26       ` Hemant Agrawal
2018-01-15 15:26     ` [PATCH v2 1/2] doc: add guidelines for coverity tags Hemant Agrawal
2018-01-16  9:08     ` Marko Kovacevic [this message]
2018-01-16  9:08       ` [PATCH v3 " Marko Kovacevic
2018-01-16  9:12     ` Marko Kovacevic
2018-01-16  9:12       ` [PATCH v3 2/2] doc: add guidelines for stable tags Marko Kovacevic
2018-01-16 16:37         ` Mcnamara, John
2018-02-13 11:58           ` Ferruh Yigit
2018-01-16 16:37       ` [PATCH v3 1/2] doc: add guidelines for coverity tags Mcnamara, John
2018-02-13 11:59         ` Ferruh Yigit
2018-05-24 16:49           ` 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=20180116090854.20773-1-marko.kovacevic@intel.com \
    --to=marko.kovacevic@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=hemant.agrawal@nxp.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.