d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add contribution guidelines for coverity tags

Browse Source 
Added contribution guideline for adding tags
when sending patches that have been raised by
coverity

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
This commit is contained in:
Marko Kovacevic 2018-01-16 09:12:46 +00:00 committed by Thomas Monjalon
parent 298ea2bb11
commit d687e0d0be
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/guides/contributing/patches.rst
View File

@ -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 <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: author@example.com
Signed-off-by: Alex Smith <alex.smith@example.com>
Creating Patches
----------------