[clang] [rtsan][NFC] Documentation of suppression flag (PR #112727)
Florian Mayer via cfe-commits
cfe-commits at lists.llvm.org
Thu Oct 17 10:06:20 PDT 2024
================
@@ -194,12 +198,43 @@ Some issues with flags can be debugged using the ``verbosity=$NUM`` flag:
misspelled_flag
...
-Disabling
----------
+Disabling and suppressing
+-------------------------
-In some circumstances, you may want to suppress error reporting in a specific scope.
+There are multiple ways to suppress error reporting when using RealtimeSanitizer.
-In C++, this is achieved via ``__rtsan::ScopedDisabler``. Within the scope where the ``ScopedDisabler`` object is instantiated, all sanitizer error reports are suppressed. This suppression applies to the current scope as well as all invoked functions, including any functions called transitively.
+In general, ``ScopedDisabler`` should be preferred, as it is the most performant.
+
+.. list-table:: Suppression methods
+ :widths: 30 15 15 10 70
+ :header-rows: 1
+
+ * - Suppression method
+ - Specified at?
+ - Scope
+ - Run-time cost
+ - Description
+ * - ``ScopedDisabler``
+ - Compile-time
+ - Stack
+ - Very low
----------------
fmayer wrote:
I would also not add too many implementation details into the public documentation. It's unlikely to be useful, not unlikely to be wrong at some point in the future when the implementation changes.
https://github.com/llvm/llvm-project/pull/112727
More information about the cfe-commits
mailing list