summaryrefslogtreecommitdiffstats
path: root/doc/developer
diff options
context:
space:
mode:
authorAcee Lindem <aceelindem@gmail.com>2023-06-13 22:10:48 +0200
committerAcee Lindem <aceelindem@gmail.com>2023-06-13 22:10:48 +0200
commit4d2fe4a4deaa7d62d5bace937b23296bd3f266c5 (patch)
treeb72487307f7dd048550351443e873a0a7c06e3f9 /doc/developer
parentMerge pull request #13745 from FRRouting/revert-13509-bgp_nht_other_if_cases (diff)
downloadfrr-4d2fe4a4deaa7d62d5bace937b23296bd3f266c5.tar.xz
frr-4d2fe4a4deaa7d62d5bace937b23296bd3f266c5.zip
doc: Update Coverity workflow in developer documentation.
Signed-off-by: Acee Lindem <aceelindem@gmail.com>
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/workflow.rst21
1 files changed, 17 insertions, 4 deletions
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst
index 65befaccb..0b386bf09 100644
--- a/doc/developer/workflow.rst
+++ b/doc/developer/workflow.rst
@@ -1331,10 +1331,23 @@ frr-format plugin
Using the plugin also changes the string for ``PRI[udx]64`` from the
system value to ``%L[udx]`` (normally ``%ll[udx]`` or ``%l[udx]``.)
-Additionally, the FRR codebase is regularly scanned with Coverity.
-Unfortunately Coverity does not have the ability to handle scanning pull
-requests, but after code is merged it will send an email notifying project
-members with Coverity access of newly introduced defects.
+Additionally, the FRR codebase is regularly scanned for static analysis
+errors with Coverity and pull request changes are scanned as part of the
+Continuous Integration (CI) process. Developers can scan their commits for
+Coverity static analysis errors prior to submission using the
+``scan-build`` command. To use this command, the ``clang-tools`` package must
+be installed. For example, this can be accomplished on Ubuntu with the
+``sudo apt-get install clang-tools`` command. Then, touch the files you want scanned and
+invoke the ``scan-file`` command. For example::
+
+ cd ~/GitHub/frr
+ touch ospfd/ospf_flood.c ospfd/ospf_vty.c ospfd/ospf_opaque.c
+ cd build
+ scan-file make -j32
+
+The results of the scan including any static analysis errors will appear inline.
+Additionally, there will a directory in the /tmp containing the Coverity
+reports (e.g., scan-build-2023-06-09-120100-473730-1).
Executing non-installed dynamic binaries
----------------------------------------