[clang] 63861d6 - [Sanitizer][Doc][NFC] Update the doc for prefix:*=sanitize (#142659)

[via cfe-commits]

Author: Qinkun Bao
Date: 2025-06-03T20:28:07-04:00
New Revision: 63861d69f0b59787cd8a288543b1434414a2b250

URL: https://github.com/llvm/llvm-project/commit/63861d69f0b59787cd8a288543b1434414a2b250
DIFF: https://github.com/llvm/llvm-project/commit/63861d69f0b59787cd8a288543b1434414a2b250.diff

LOG: [Sanitizer][Doc][NFC] Update the doc for prefix:*=sanitize (#142659)

See https://github.com/llvm/llvm-project/issues/139128

Added: 
    

Modified: 
    clang/docs/ReleaseNotes.rst
    clang/docs/SanitizerSpecialCaseList.rst

Removed: 
    


################################################################################
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
 ======