diff options
| author | Alexey Samsonov <vonosmas@gmail.com> | 2015-12-04 23:13:14 +0000 |
|---|---|---|
| committer | Alexey Samsonov <vonosmas@gmail.com> | 2015-12-04 23:13:14 +0000 |
| commit | b6761c2e1e1b914dc695780792ffe86c29ce296f (patch) | |
| tree | 4961ec2fc3d840f5982b48c68c92a1a056460f97 /clang/docs/UsersManual.rst | |
| parent | 24423e9d03a105cc0d2273b2b5ecbdd0e00f9a46 (diff) | |
| download | bcm5719-llvm-b6761c2e1e1b914dc695780792ffe86c29ce296f.tar.gz bcm5719-llvm-b6761c2e1e1b914dc695780792ffe86c29ce296f.zip | |
[Docs] One more cleanup of -fsanitize= section.
Describe -fsanitize-blacklist flags in separate paragraphs, move
notes about importance of clang++ for vptr down to UBSan docs.
llvm-svn: 254798
Diffstat (limited to 'clang/docs/UsersManual.rst')
| -rw-r--r-- | clang/docs/UsersManual.rst | 31 |
1 files changed, 14 insertions, 17 deletions
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst index c103ef6c5b4..5e1a6cfad89 100644 --- a/clang/docs/UsersManual.rst +++ b/clang/docs/UsersManual.rst @@ -977,21 +977,8 @@ are listed below. undefined behavior that can be detected and the :ref:`list <cfi-schemes>` of control flow integrity schemes. - You can turn off or modify checks for certain source files, functions - or even variables by providing a special file: - - - ``-fsanitize-blacklist=/path/to/blacklist/file``: disable or modify - sanitizer checks for objects listed in the file. See - :doc:`SanitizerSpecialCaseList` for file format description. - - ``-fno-sanitize-blacklist``: don't use blacklist file, if it was - specified earlier in the command line. - The ``-fsanitize=`` argument must also be provided when linking, in - 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. + order to link to the appropriate runtime library. It is not possible to combine more than one of the ``-fsanitize=address``, ``-fsanitize=thread``, and ``-fsanitize=memory`` checkers in the same @@ -1028,14 +1015,24 @@ are listed below. be used (for instance, when building libc or a kernel module), or where the binary size increase caused by the sanitizer runtime is a concern. - This flag is only compatible with ``local-bounds``, - ``unsigned-integer-overflow``, sanitizers in the ``cfi`` group and - sanitizers in the ``undefined`` group other than ``vptr``. If this flag + This flag is only compatible with :doc:`control flow integrity + <ControlFlowIntegrity>` schemes and :doc:`UndefinedBehaviorSanitizer` + checks other than ``vptr``. If this flag is supplied together with ``-fsanitize=undefined``, the ``vptr`` sanitizer will be implicitly disabled. This flag is enabled by default for sanitizers in the ``cfi`` group. +.. option:: -fsanitize-blacklist=/path/to/blacklist/file + + Disable or modify sanitizer checks for objects (source files, functions, + variables, types) listed in the file. See + :doc:`SanitizerSpecialCaseList` for file format description. + +.. option:: -fno-sanitize-blacklist + + Don't use blacklist file, if it was specified earlier in the command line. + **-f[no-]sanitize-coverage=[type,features,...]** Enable simple code coverage in addition to certain sanitizers. |

