Skip to content

Commit 3581f71

Browse files
committed
[PR] dtraev - Suppresses->ignored
1 parent b6e37a6 commit 3581f71

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

clang/docs/RealtimeSanitizer.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,15 +201,15 @@ Some issues with flags can be debugged using the ``verbosity=$NUM`` flag:
201201
Disabling and suppressing
202202
-------------------------
203203

204-
There are multiple ways to suppress error reporting when using RealtimeSanitizer.
204+
There are multiple ways to disable error reporting when using RealtimeSanitizer.
205205

206206
In general, ``ScopedDisabler`` should be preferred, as it is the most performant.
207207

208208
.. list-table:: Suppression methods
209209
:widths: 30 15 15 10 70
210210
:header-rows: 1
211211

212-
* - Suppression method
212+
* - Method
213213
- Specified at?
214214
- Scope
215215
- Run-time cost
@@ -218,7 +218,7 @@ In general, ``ScopedDisabler`` should be preferred, as it is the most performant
218218
- Compile-time
219219
- Stack
220220
- 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.
222222
* - ``function-name-matches`` suppression
223223
- Run-time
224224
- Single function
@@ -234,7 +234,7 @@ In general, ``ScopedDisabler`` should be preferred, as it is the most performant
234234
``ScopedDisabler``
235235
##################
236236

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.
238238

239239
.. code-block:: c++
240240

@@ -291,6 +291,8 @@ Suppressions specified in this file are one of two flavors.
291291

292292
Patterns may be exact matches or are "regex-light" patterns, containing special characters such as ``^$*``.
293293

294+
The number of potential errors suppressed via this method may be seen on exit when using the ``print_stats_on_exit`` flag.
295+
294296
Compile-time sanitizer detection
295297
--------------------------------
296298

0 commit comments

Comments
 (0)