Skip to content

[Sanitizer][Doc][NFC] Update the doc for prefix:*=sanitize #142701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion clang/docs/ReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1045,7 +1045,9 @@ Sanitizers
----------

- ``-fsanitize=vptr`` is no longer a part of ``-fsanitize=undefined``.
- Sanitizer ignorelists now support the syntax ``src:*=sanitize``.
- Sanitizer ignorelists now support the syntax ``src:*=sanitize``,
``type:*=sanitize``, ``fun:*=sanitize``, ``global:*=sanitize``,
and ``mainfile:*=sanitize``.

Python Binding Changes
----------------------
Expand Down
18 changes: 16 additions & 2 deletions clang/docs/SanitizerSpecialCaseList.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ instrumentation for arithmetic operations containing values of type ``int``.

The ``=sanitize`` category is also supported. Any ``=sanitize`` category
entries enable sanitizer instrumentation, even if it was ignored by entries
before.
before. Entries can be ``src``, ``type``, ``global``, ``fun``, and
``mainfile``.

With this, one may disable instrumentation for some or all types and
specifically allow instrumentation for one or many types -- including types
Expand All @@ -103,7 +104,7 @@ supported sanitizers.
}

If multiple entries match the source, then the latest entry takes the
precedence.
precedence. Here are a few examples.

.. code-block:: bash

Expand All @@ -119,6 +120,19 @@ precedence.
src:*/mylib/test.cc
src:*/mylib/*=sanitize

$ cat ignorelist3.txt
# Type T will not be instrumented.
type:*
type:T=sanitize
type:T

$ cat ignorelist4.txt
# Function `bad_bar`` will be instrumented.
# Function `good_bar` will not be instrumented.
fun:*
fun:*bar
fun:bad_bar=sanitize

Format
======

Expand Down
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.