aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d40ea3a59d..072da69b85 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,7 +8,8 @@ low-risk/isolated tasks:
- Merge a [Vim patch].
- Try a [complexity:low] issue.
-- Fix bugs found by [clang-scan], [coverity](#coverity), and [PVS](#pvs-studio).
+- Fix bugs found by [clang scan-build](#clang-scan-build),
+ [coverity](#coverity), and [PVS](#pvs-studio).
Developer guidelines
--------------------
@@ -112,6 +113,15 @@ QuickBuild uses this invocation:
VERBOSE=1 nvim unittest-prereqs functionaltest-prereqs
+### Clang scan-build
+
+The auto-generated [clang-scan] report presents walk-throughs of bugs found by
+Clang's [scan-build](https://clang-analyzer.llvm.org/scan-build.html) static
+analyzer. To verify a fix locally, run `scan-build` like this:
+
+ rm -rf build/
+ scan-build --use-analyzer=/usr/bin/clang make
+
### Coverity
[Coverity](https://scan.coverity.com/projects/neovim-neovim) runs against the