aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-07-29 18:51:31 +0200
committerJustin M. Keyes <justinkz@gmail.com>2017-07-29 18:51:54 +0200
commitdc3c06e73dfd04948c59ea029daef1626e0386f8 (patch)
treea2ddee6739ac2383aec3deca1d1399c26e64d70c
parent8ae16aa92c2b583fa390bc00f6987a9e5ef45a41 (diff)
downloadrneovim-dc3c06e73dfd04948c59ea029daef1626e0386f8.tar.gz
rneovim-dc3c06e73dfd04948c59ea029daef1626e0386f8.tar.bz2
rneovim-dc3c06e73dfd04948c59ea029daef1626e0386f8.zip
doc: how to enable ASan/UBSan
-rw-r--r--CONTRIBUTING.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 46e92a7329..20bce8ca62 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -95,8 +95,9 @@ and [AppVeyor].
See [Building Neovim#running-tests][wiki-run-tests] to run tests locally.
Passing locally doesn't guarantee passing the CI build, because of the
different compilers and platforms tested against.
-- CI runs [ASan] and other analyzers. To run valgrind locally:
- `VALGRIND=1 make test`
+- CI runs [ASan] and other analyzers.
+ - To run valgrind locally: `VALGRIND=1 make test`
+ - To run Clang ASan/UBSan locally: `CC=clang make CMAKE_FLAGS="-DCLANG_ASAN_UBSAN=ON"`
- The `lint` build ([#3174][3174]) checks modified lines _and their immediate
neighbors_. This is to encourage incrementally updating the legacy style to
meet our style guidelines.