[clang] [Docs] Fix and update TySan docs (PR #198331)
Matthew Nagy via cfe-commits
cfe-commits at lists.llvm.org
Mon May 18 08:55:00 PDT 2026
https://github.com/gbMattN created https://github.com/llvm/llvm-project/pull/198331
None
>From 87a15aa285e4b9df0bdc220bbcace6d5b7f00bed Mon Sep 17 00:00:00 2001
From: gbMattN <matthew.nagy at sony.com>
Date: Mon, 18 May 2026 16:51:51 +0100
Subject: [PATCH] [Docs] Fix and update TySan docs
---
clang/docs/TypeSanitizer.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/clang/docs/TypeSanitizer.rst b/clang/docs/TypeSanitizer.rst
index 08cb247aefe3a..ce0aaaf62ac98 100644
--- a/clang/docs/TypeSanitizer.rst
+++ b/clang/docs/TypeSanitizer.rst
@@ -93,7 +93,7 @@ to print the full trace. To get nicer stack traces in error messages add ``-fno-
}
# Compile and link
- % clang++ -g -fsanitize=type example_AliasViolation.cc
+ % clang++ -g -fsanitize=type example_AliasViolation.c
The program will print an error message to ``stderr`` each time a strict aliasing violation is detected.
The program won't terminate, which will allow you to detect many strict aliasing violations in one
@@ -114,7 +114,7 @@ Error terminology
------------------
There are some terms that may appear in TypeSanitizer errors that are derived from
-`TBAA Metadata <https://llvm.org/docs/LangRef.html#tbaa-metadata>`. This section hopes to provide a
+`TBAA Metadata <https://llvm.org/docs/LangRef.html#tbaa-metadata>`_. This section hopes to provide a
brief dictionary of these terms.
* ``omnipotent char``: This is a special type which can alias with anything. Its name comes from the C/C++
@@ -207,7 +207,7 @@ Limitations
does at least mean that TypeSanitizer will catch any aliasing violations that
would cause bugs when compiling with Clang & LLVM.
* TypeSanitizer cannot currently be run alongside other sanitizers such as
- AddressSanitizer, ThreadSanitizer or UndefinedBehaviourSanitizer.
+ AddressSanitizer or ThreadSanitizer.
Current Status
--------------
More information about the cfe-commits
mailing list