[dpdk-dev,v3,1/2] doc: add guidelines for coverity tags
Checks
Commit Message
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>
---
doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
Comments
> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Tuesday, January 16, 2018 9:13 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Yigit, Ferruh
> <ferruh.yigit@intel.com>; hemant.agrawal@nxp.com; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Subject: [PATCH v3 1/2] doc: add guidelines for coverity tags
>
> 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>
The commit message shouldn't be indented. Apart from that:
Acked-by: John McNamara <john.mcnamara@intel.com>
On 1/16/2018 4:37 PM, Mcnamara, John wrote:
>
>
>> -----Original Message-----
>> From: Kovacevic, Marko
>> Sent: Tuesday, January 16, 2018 9:13 AM
>> To: dev@dpdk.org
>> Cc: Mcnamara, John <john.mcnamara@intel.com>; Yigit, Ferruh
>> <ferruh.yigit@intel.com>; hemant.agrawal@nxp.com; Kovacevic, Marko
>> <marko.kovacevic@intel.com>
>> Subject: [PATCH v3 1/2] doc: add guidelines for coverity tags
>>
>> 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>
>
> The commit message shouldn't be indented. Apart from that:
>
> Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
13/02/2018 12:59, Ferruh Yigit:
> On 1/16/2018 4:37 PM, Mcnamara, John wrote:
> >
> >
> >> -----Original Message-----
> >> From: Kovacevic, Marko
> >> Sent: Tuesday, January 16, 2018 9:13 AM
> >> To: dev@dpdk.org
> >> Cc: Mcnamara, John <john.mcnamara@intel.com>; Yigit, Ferruh
> >> <ferruh.yigit@intel.com>; hemant.agrawal@nxp.com; Kovacevic, Marko
> >> <marko.kovacevic@intel.com>
> >> Subject: [PATCH v3 1/2] doc: add guidelines for coverity tags
> >>
> >> 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>
> >
> > The commit message shouldn't be indented. Apart from that:
> >
> > Acked-by: John McNamara <john.mcnamara@intel.com>
>
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Series Acked-by: Thomas Monjalon <thomas@monjalon.net>
Applied with minor formatting changes, thanks.
@@ -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: author@example.com
+
+ Signed-off-by: Alex Smith <alex.smith@example.com>
+
+
Creating Patches
----------------