From: Marko Kovacevic Date: Tue, 29 May 2018 11:01:24 +0000 (+0100) Subject: doc: add guidelines for bugzilla reference in patch X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=6561392c617a9bbc256c0ebe74b036441fed97da;p=dpdk.git doc: add guidelines for bugzilla reference in patch Added contribution guideline for adding tags when sending patches that have been raised on Bugzilla Signed-off-by: Marko Kovacevic Acked-by: Ferruh Yigit --- diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 7bb5710c8c..e4e0cb5915 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,25 @@ 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 ~~~~~~~~~~~~~~~~~~~~~~~~~