Added contribution guideline for adding tags when sending patches that have been raised by coverity
Signed-off-by: Marko Kovacevic <marko.kovace...@intel.com> Acked-by: Hemant Agrawal <hemant.agra...@nxp.com> --- 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 <https://scan.coverity.com/projects/dpdk-data-plane-development-kit>`_ 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: aut...@example.com + + Signed-off-by: Alex Smith <alex.sm...@example.com> + + Creating Patches ---------------- -- 2.9.5