From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id A8F3212001 for ; Tue, 16 Jan 2018 10:09:26 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 16 Jan 2018 01:09:25 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,367,1511856000"; d="scan'208";a="20167950" Received: from silpixa00399502.ir.intel.com (HELO silpixa00399502.ger.corp.intel.com) ([10.237.223.218]) by FMSMGA003.fm.intel.com with ESMTP; 16 Jan 2018 01:09:24 -0800 From: Marko Kovacevic To: dev@dpdk.org Cc: john.mcnamara@intel.com, ferruh.yigit@intel.com, hemant.agrawal@nxp.com, Marko Kovacevic Date: Tue, 16 Jan 2018 09:08:53 +0000 Message-Id: <20180116090854.20773-1-marko.kovacevic@intel.com> X-Mailer: git-send-email 2.9.5 In-Reply-To: <20180110145200.13895-1-marko.kovacevic@intel.com> References: <20180110145200.13895-1-marko.kovacevic@intel.com> Subject: [dpdk-dev] [PATCH v3 1/2] doc: add guidelines for coverity tags X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 16 Jan 2018 09:09:27 -0000 Added contribution guideline for adding tags when sending patches that have been raised by coverity Signed-off-by: Marko Kovacevic Acked-by: Hemant Agrawal --- 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 `_ 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 + + Creating Patches ---------------- -- 2.9.5