[clang] 342c8db - [rtsan] NFC: Docs update adding links to Disabling, adding a few ` marks (#119075)

via cfe-commits cfe-commits at lists.llvm.org
Sat Dec 7 08:25:12 PST 2024


Author: Chris Apple
Date: 2024-12-07T08:25:08-08:00
New Revision: 342c8db381129e908116f1059e97d235b62bcaf2

URL: https://github.com/llvm/llvm-project/commit/342c8db381129e908116f1059e97d235b62bcaf2
DIFF: https://github.com/llvm/llvm-project/commit/342c8db381129e908116f1059e97d235b62bcaf2.diff

LOG: [rtsan] NFC: Docs update adding links to Disabling, adding a few ` marks (#119075)

Added: 
    

Modified: 
    clang/docs/RealtimeSanitizer.rst

Removed: 
    


################################################################################
diff  --git a/clang/docs/RealtimeSanitizer.rst b/clang/docs/RealtimeSanitizer.rst
index 233a91f6684162..2aec728cfed583 100644
--- a/clang/docs/RealtimeSanitizer.rst
+++ b/clang/docs/RealtimeSanitizer.rst
@@ -187,15 +187,15 @@ A **partial** list of flags RealtimeSanitizer respects:
    * - ``abort_on_error``
      - OS dependent
      - boolean
-     - If true, the tool calls abort() instead of _exit() after printing the error report. On some OSes (OSX, for exmple) this is beneficial because a better stack trace is emitted on crash.
+     - If true, the tool calls ``abort()`` instead of ``_exit()`` after printing the error report. On some OSes (MacOS, for exmple) this is beneficial because a better stack trace is emitted on crash.
    * - ``symbolize``
      - ``true``
      - boolean
      - If set, use the symbolizer to turn virtual addresses to file/line locations. If false, can greatly speed up the error reporting.
    * - ``suppressions``
-     - ""
+     - ``""``
      - path
-     - If set to a valid suppressions file, will suppress issue reporting. See details in "Disabling", below.
+     - If set to a valid suppressions file, will suppress issue reporting. See details in `Disabling and Suppressing`_.
 
 
 Some issues with flags can be debugged using the ``verbosity=$NUM`` flag:
@@ -244,6 +244,7 @@ To register a callback which will be invoked before a RTSan kills the process:
     ...
   }
 
+.. _disabling-and-suppressing:
 
 Disabling and suppressing
 -------------------------


        


More information about the cfe-commits mailing list