summaryrefslogtreecommitdiff
path: root/docs/UsersManual.rst
diff options
context:
space:
mode:
authorRichard Smith <richard-llvm@metafoo.co.uk>2013-07-19 19:06:48 +0000
committerRichard Smith <richard-llvm@metafoo.co.uk>2013-07-19 19:06:48 +0000
commit635c1dca0fbe6d42646582c012e00eee5eb0af11 (patch)
tree86016b1d567cb8df1654d56f081462b49088fdb6 /docs/UsersManual.rst
parentcdbc3b36bd6167fcb1e2de080e0d9bcd35b166ea (diff)
downloadclang-635c1dca0fbe6d42646582c012e00eee5eb0af11.tar.gz
clang-635c1dca0fbe6d42646582c012e00eee5eb0af11.tar.bz2
clang-635c1dca0fbe6d42646582c012e00eee5eb0af11.tar.xz
Update users manual to indicate:
1) clang++ must be used when linking C++ programs using -fsanitize=undefined, and 2) MSan can't be combined with TSan or ASan. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@186711 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/UsersManual.rst')
-rw-r--r--docs/UsersManual.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/UsersManual.rst b/docs/UsersManual.rst
index 9037047463..daa90b64e4 100644
--- a/docs/UsersManual.rst
+++ b/docs/UsersManual.rst
@@ -971,9 +971,17 @@ are listed below.
group.
The ``-fsanitize=`` argument must also be provided when linking, in
- order to link to the appropriate runtime library. It is not possible
- to combine the ``-fsanitize=address`` and ``-fsanitize=thread``
- checkers in the same program.
+ order to link to the appropriate runtime library. When using
+ ``-fsanitize=vptr`` (or a group that includes it, such as
+ ``-fsanitize=undefined``) with a C++ program, the link must be
+ performed by ``clang++``, not ``clang``, in order to link against the
+ C++-specific parts of the runtime library.
+
+ It is not possible to combine more than one of the ``-fsanitize=address``,
+ ``-fsanitize=thread``, and ``-fsanitize=memory`` checkers in the same
+ program. The ``-fsanitize=undefined`` checks can be combined with other
+ sanitizers.
+
**-f[no-]address-sanitizer**
Deprecated synonym for :ref:`-f[no-]sanitize=address
<opt_fsanitize_address>`.