From mboxrd@z Thu Jan  1 00:00:00 1970
From: Marko Kovacevic <marko.kovacevic@intel.com>
Subject: [PATCH v2 1/2] doc: add guidelines for coverity tags
Date: Wed, 10 Jan 2018 14:51:59 +0000
Message-ID: <20180110145200.13895-1-marko.kovacevic@intel.com>
References: <20180109155101.12165-2-marko.kovacevic@intel.com>
Cc: john.mcnamara@intel.com, ferruh.yigit@intel.com, hemant.agrawal@nxp.com,
 Marko Kovacevic <marko.kovacevic@intel.com>
To: dev@dpdk.org
Return-path: <dev-bounces@dpdk.org>
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
 by dpdk.org (Postfix) with ESMTP id 3050F1B25C
 for <dev@dpdk.org>; Wed, 10 Jan 2018 15:52:36 +0100 (CET)
In-Reply-To: <20180109155101.12165-2-marko.kovacevic@intel.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
---
 doc/guides/contributing/patches.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 64408e7..e6b6e80 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -257,6 +257,26 @@ 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 gratis
+static-analysis cloud-based service for the open source community. It is a tool for
+C,C++,C# and Java it is used for finding bugs through static analysis. If a patch
+fix is being sent to the mailing list due to a Coverity related issue,a
+Coverity issue tag should be inserted into the commit message body as so::
+
+     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