[llvm-branch-commits] [Sanitizer][Doc][NFI] Update the doc for prefix:*=sanitize (PR #142701)
via llvm-branch-commits
llvm-branch-commits at lists.llvm.org
Tue Jun 3 17:11:14 PDT 2025
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-clang
Author: Qinkun Bao (qinkunbao)
<details>
<summary>Changes</summary>
---
Full diff: https://github.com/llvm/llvm-project/pull/142701.diff
2 Files Affected:
- (modified) clang/docs/ReleaseNotes.rst (+3-1)
- (modified) clang/docs/SanitizerSpecialCaseList.rst (+16-2)
``````````diff
diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst
index eccee1aeef846..49ce9ef938fe9 100644
--- a/clang/docs/ReleaseNotes.rst
+++ b/clang/docs/ReleaseNotes.rst
@@ -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
----------------------
diff --git a/clang/docs/SanitizerSpecialCaseList.rst b/clang/docs/SanitizerSpecialCaseList.rst
index 6f924cfa97a97..61b6c55d8e6e4 100644
--- a/clang/docs/SanitizerSpecialCaseList.rst
+++ b/clang/docs/SanitizerSpecialCaseList.rst
@@ -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
@@ -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
@@ -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
======
``````````
</details>
https://github.com/llvm/llvm-project/pull/142701
More information about the llvm-branch-commits
mailing list