You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clang/docs/RealtimeSanitizer.rst
+6-4Lines changed: 6 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -201,15 +201,15 @@ Some issues with flags can be debugged using the ``verbosity=$NUM`` flag:
201
201
Disabling and suppressing
202
202
-------------------------
203
203
204
-
There are multiple ways to suppress error reporting when using RealtimeSanitizer.
204
+
There are multiple ways to disable error reporting when using RealtimeSanitizer.
205
205
206
206
In general, ``ScopedDisabler`` should be preferred, as it is the most performant.
207
207
208
208
.. list-table:: Suppression methods
209
209
:widths: 30 15 15 10 70
210
210
:header-rows: 1
211
211
212
-
* - Suppression method
212
+
* - Method
213
213
- Specified at?
214
214
- Scope
215
215
- Run-time cost
@@ -218,7 +218,7 @@ In general, ``ScopedDisabler`` should be preferred, as it is the most performant
218
218
- Compile-time
219
219
- Stack
220
220
- Very low
221
-
- Suppresses all RTSan error reports in the current scope and all invoked functions.
221
+
- Violations are ignored for the lifetime of the ``ScopedDisabler`` object.
222
222
* - ``function-name-matches`` suppression
223
223
- Run-time
224
224
- Single function
@@ -234,7 +234,7 @@ In general, ``ScopedDisabler`` should be preferred, as it is the most performant
234
234
``ScopedDisabler``
235
235
##################
236
236
237
-
At compile time, RealtimeSanitizer may be disabled for a scope using ``__rtsan::ScopedDisabler``. Within the scope where the ``ScopedDisabler`` object is instantiated, all RTSan error reports are suppressed for that thread. This suppression applies to the current scope as well as all invoked functions, including any functions called transitively.
237
+
At compile time, RealtimeSanitizer may be disabled using ``__rtsan::ScopedDisabler``. Within the scope where the ``ScopedDisabler`` object is instantiated, all potential RTSan errors are ignored for that thread including all invoked functions, and any functions called transitively.
238
238
239
239
.. code-block:: c++
240
240
@@ -291,6 +291,8 @@ Suppressions specified in this file are one of two flavors.
291
291
292
292
Patterns may be exact matches or are "regex-light" patterns, containing special characters such as ``^$*``.
293
293
294
+
The number of potential errors suppressed via this method may be seen on exit when using the ``print_stats_on_exit`` flag.
0 commit comments