r298310 - [docs] Clarify sanitizer flag behavior

Vedant Kumar via cfe-commits cfe-commits at lists.llvm.org
Mon Mar 20 14:40:58 PDT 2017


Author: vedantk
Date: Mon Mar 20 16:40:58 2017
New Revision: 298310

URL: http://llvm.org/viewvc/llvm-project?rev=298310&view=rev
Log:
[docs] Clarify sanitizer flag behavior

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.

Modified:
    cfe/trunk/docs/UndefinedBehaviorSanitizer.rst

Modified: cfe/trunk/docs/UndefinedBehaviorSanitizer.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/UndefinedBehaviorSanitizer.rst?rev=298310&r1=298309&r2=298310&view=diff
==============================================================================
--- cfe/trunk/docs/UndefinedBehaviorSanitizer.rst (original)
+++ cfe/trunk/docs/UndefinedBehaviorSanitizer.rst Mon Mar 20 16:40:58 2017
@@ -50,9 +50,9 @@ instead of ``clang++`` if you're compili
 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:
 




More information about the cfe-commits mailing list