]> granicus.if.org Git - clang/commitdiff
[docs] Clarify sanitizer flag behavior
authorVedant Kumar <vsk@apple.com>
Mon, 20 Mar 2017 21:40:58 +0000 (21:40 +0000)
committerVedant Kumar <vsk@apple.com>
Mon, 20 Mar 2017 21:40:58 +0000 (21:40 +0000)
PR32346 suggests that UBSan's docs about the -fsanitize,
-fno-sanitize-recover, and -fsanitize-trap options are not explicit
enough. Try to improve the wording.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@298310 91177308-0d34-0410-b5e6-96231b3b80d8

docs/UndefinedBehaviorSanitizer.rst

index f9111ee846d760983cefcf9cf1e8342f33fe7607..d6fdad2a0c0118ae70e820b2771ab3e295aa4f49 100644 (file)
@@ -50,9 +50,9 @@ instead of ``clang++`` if you're compiling/linking C code.
 You can enable only a subset of :ref:`checks <ubsan-checks>` offered by UBSan,
 and define the desired behavior for each kind of check:
 
-* print a verbose error report and continue execution (default);
-* print a verbose error report and exit the program;
-* execute a trap instruction (doesn't require UBSan run-time support).
+* ``-fsanitize=...``: print a verbose error report and continue execution (default);
+* ``-fno-sanitize-recover=...``: print a verbose error report and exit the program;
+* ``-fsanitize-trap=...``: execute a trap instruction (doesn't require UBSan run-time support).
 
 For example if you compile/link your program as: