summaryrefslogtreecommitdiffstats
path: root/doc/developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md
diff options
context:
space:
mode:
authorHumble Devassy Chirammal <hchiramm@redhat.com>2015-09-24 14:53:52 +0530
committerHumble Devassy Chirammal <humble.devassy@gmail.com>2015-10-10 05:49:01 -0700
commita4f982be9b21323038704069a56fb2448369d6a0 (patch)
tree1daf99ef973b95b004938bb0e76b544907180b84 /doc/developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md
parentbad9539437ca1d69e470159277bbb6b5675cbae3 (diff)
Porting developer guide to source code repo from glusterdocs project
Change-Id: Ib8d9c668ebb05863918e6ec2b89908f206626f38 BUG: 1206539 Signed-off-by: Humble Devassy Chirammal <hchiramm@redhat.com> Reviewed-on: http://review.gluster.org/12227 Tested-by: NetBSD Build System <jenkins@build.gluster.org> Reviewed-by: Prashanth Pai <ppai@redhat.com> Reviewed-by: Humble Devassy Chirammal <humble.devassy@gmail.com> Tested-by: Humble Devassy Chirammal <humble.devassy@gmail.com> Tested-by: Raghavendra Talur <rtalur@redhat.com>
Diffstat (limited to 'doc/developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md')
-rw-r--r--doc/developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md b/doc/developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md
new file mode 100644
index 00000000000..5a3dceb7d0e
--- /dev/null
+++ b/doc/developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md
@@ -0,0 +1,66 @@
+Static Code Analysis Tools
+--------------------------
+
+Bug fixes for issues reported by *Static Code Analysis Tools* should
+follow [Development Work Flow](./Development Workflow.md)
+
+### Coverity
+
+GlusterFS is part of [Coverity's](https://scan.coverity.com/) scan
+program.
+
+- To see Coverity issues you have to be a member of the GlusterFS
+ project in Coverity scan website.
+- Here is the link to [Coverity scan
+ website](https://scan.coverity.com/projects/987)
+- Go to above link and subscribe to GlusterFS project (as
+ contributor). It will send a request to Admin for including you in
+ the Project.
+- Once admins for the GlusterFS Coverity scan approve your request,
+ you will be able to see the defects raised by Coverity.
+- [BZ 789278](https://bugzilla.redhat.com/show_bug.cgi?id=789278)
+ should be used as a umbrella bug for Coverity issues in master
+ branch unless you are trying to fix a specific bug in Bugzilla.
+ - While sending patches for fixing Coverity issues please use the
+ same bug number.
+ - For 3.6 branch the Coverity tracking bug is
+ [1122834](https://bugzilla.redhat.com/show_bug.cgi?id=1122834)
+- When you decide to work on some issue, please assign it to your name
+ in the same Coverity website. So that we don't step on each others
+ work.
+- When marking a bug intentional in Coverity scan website, please put
+ an explanation for the same. So that it will help others to
+ understand the reasoning behind it.
+
+*If you have more questions please send it to
+[gluster-devel](http://www.gluster.org/interact/mailinglists) mailing
+list*
+
+### CPP Check
+
+Cppcheck is available in Fedora and EL's EPEL repo
+
+- Install Cppcheck
+
+ yum install cppcheck
+
+- Clone GlusterFS code
+
+ git clone https://github.com/gluster/glusterfs) glusterfs
+
+- Run Cpp check
+
+ cppcheck glusterfs/ 2>cppcheck.log
+
+- [BZ 1091677](https://bugzilla.redhat.com/show_bug.cgi?id=1091677)
+ should be used for submitting patches to master branch for Cppcheck
+ reported issues.
+
+### Daily Runs
+
+We now have daily runs of various static source code analysis tools on
+the glusterfs sources. There are daily analyses of the master,
+release-3.6, and release-3.5 branches.
+
+Results are posted at
+<http://download.gluster.org/pub/gluster/glusterfs/static-analysis/>