From mboxrd@z Thu Jan 1 00:00:00 1970 From: Marko Kovacevic Subject: [PATCH v2] doc: add guides for patch fix issues Date: Tue, 29 May 2018 12:01:24 +0100 Message-ID: <20180529110124.35666-1-marko.kovacevic@intel.com> References: <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 mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 69C322B96 for ; Tue, 29 May 2018 13:00:45 +0200 (CEST) In-Reply-To: <20180528152342.22467-1-marko.kovacevic@intel.com> 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 Acked-by: Ferruh Yigit --- V2: removed accidental indents (Thomas) --- doc/guides/contributing/patches.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 7bb5710..3707711 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -256,8 +256,8 @@ 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. @@ -277,6 +277,23 @@ in the body of the commit message. For example:: 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 + Patch for Stable Releases ~~~~~~~~~~~~~~~~~~~~~~~~~ -- 2.9.5