From mboxrd@z Thu Jan 1 00:00:00 1970 From: Marko Kovacevic Subject: [PATCH v1] doc: add guides for patch fix issues Date: Mon, 28 May 2018 16:23:42 +0100 Message-ID: <20180528152342.22467-1-marko.kovacevic@intel.com> Cc: ferruh.yigit@intel.com, john.mcnamara@intel.com, Marko Kovacevic To: dev@dpdk.org Return-path: Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id B035B14EC for ; Mon, 28 May 2018 17:23:04 +0200 (CEST) List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Added contribution guideline for adding tags when sending patches that have been raised on Bugzilla Signed-off-by: Marko Kovacevic --- 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 `_ -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 `_ + 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 + + + `Bugzilla `_ + 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 - 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 Patch for Stable Releases ~~~~~~~~~~~~~~~~~~~~~~~~~ -- 2.9.5