[clang] [rtsan] NFC: Adding links to Disabling, adding a few ` marks (PR #119075)

Chris Apple via cfe-commits cfe-commits at lists.llvm.org
Sat Dec 7 07:52:46 PST 2024


https://github.com/cjappl created https://github.com/llvm/llvm-project/pull/119075

None

>From 94225043e5e60424bc10fa0b8d33a21228420866 Mon Sep 17 00:00:00 2001
From: Chris Apple <cja-private at pm.me>
Date: Sat, 7 Dec 2024 07:51:45 -0800
Subject: [PATCH] [rtsan] NFC: Very small fixes of docs, adding `, adding link
 to Disabling

---
 clang/docs/RealtimeSanitizer.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

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