Added contribution guideline for adding tags when sending patches that have been raised by coverity
Signed-off-by: Marko Kovacevic <marko.kovace...@intel.com> --- doc/guides/contributing/patches.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 64408e7..e6b6e80 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -257,6 +257,26 @@ 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 gratis +static-analysis cloud-based service for the open source community. It is a tool for +C,C++,C# and Java it is used for finding bugs through static analysis. If a patch +fix is being sent to the mailing list due to a Coverity related issue,a +Coverity issue tag should be inserted into the commit message body as so:: + + 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