From d687e0d0be62bd339a34f64a25f48ce397c7e02f Mon Sep 17 00:00:00 2001 From: Marko Kovacevic Date: Tue, 16 Jan 2018 09:12:46 +0000 Subject: [PATCH] doc: add contribution guidelines for coverity tags Added contribution guideline for adding tags when sending patches that have been raised by coverity Signed-off-by: Marko Kovacevic Acked-by: Hemant Agrawal Acked-by: John McNamara Acked-by: Ferruh Yigit Acked-by: Thomas Monjalon --- 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 2287835f91..24fd671222 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -256,6 +256,27 @@ 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 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`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.20.1