[clang] 1f3b0f4 - [docs][msan] List common cases reported by msan (#101105)

[via cfe-commits]

Author: Vitaly Buka
Date: 2024-07-30T10:14:09-07:00
New Revision: 1f3b0f4da0aa5142d7de3e6723538d35c34c9008

URL: https://github.com/llvm/llvm-project/commit/1f3b0f4da0aa5142d7de3e6723538d35c34c9008
DIFF: https://github.com/llvm/llvm-project/commit/1f3b0f4da0aa5142d7de3e6723538d35c34c9008.diff

LOG: [docs][msan] List common cases reported by msan (#101105)

Fixes https://github.com/google/sanitizers/issues/1755.

Added: 
    

Modified: 
    clang/docs/MemorySanitizer.rst

Removed: 
    


################################################################################
diff  --git a/clang/docs/MemorySanitizer.rst b/clang/docs/MemorySanitizer.rst
index bcc6cc808e8ba..9775080360d49 100644
--- a/clang/docs/MemorySanitizer.rst
+++ b/clang/docs/MemorySanitizer.rst
@@ -8,11 +8,18 @@ MemorySanitizer
 Introduction
 ============
 
-MemorySanitizer is a detector of uninitialized reads. It consists of a
+MemorySanitizer is a detector of uninitialized memory use. It consists of a
 compiler instrumentation module and a run-time library.
 
 Typical slowdown introduced by MemorySanitizer is **3x**.
 
+Here is a not comprehensive of list cases when MemorySanitizer will report an error:
+
+* Uninitialized value was used in a conditional branch.
+* Uninitialized pointer was used for memory accesses.
+* Uninitialized value passed or returned from a function call, which is considered an undefined behavior. The check can be disabled with ``-fno-sanitize-memory-param-retval``.
+* Uninitialized data was passed into some libc calls.
+
 How to build
 ============