[clang] [docs][msan] List common cases reported by msan (PR #101105)

[Vitaly Buka via cfe-commits]

https://github.com/vitalybuka updated https://github.com/llvm/llvm-project/pull/101105

>From 0cc4d622752005ff3c615d0d4eafe1c366665d9c Mon Sep 17 00:00:00 2001
From: Vitaly Buka <vitalybuka at google.com>
Date: Mon, 29 Jul 2024 17:06:32 -0700
Subject: [PATCH 1/3] =?UTF-8?q?[=F0=9D=98=80=F0=9D=97=BD=F0=9D=97=BF]=20in?=
 =?UTF-8?q?itial=20version?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Created using spr 1.3.4
---
 clang/docs/MemorySanitizer.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/clang/docs/MemorySanitizer.rst b/clang/docs/MemorySanitizer.rst
index bcc6cc808e8ba..024bed25243b9 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 list cases when MemorySanitizer will report an error:
+
+* Conditional branches controlled by uninitialized values.
+* Using uninitalized pointers for memory accesses.
+* Passing and returning uninitialized values to/from function calls. Can be disabled with ``-fno-sanitize-memory-param-retval``.
+* Passing uninitialized data into libc calls.
+
 How to build
 ============
 

>From 7f4089f5c0271545bce8ccd4a31c9e3cf8b2eb9c Mon Sep 17 00:00:00 2001
From: Vitaly Buka <vitalybuka at google.com>
Date: Mon, 29 Jul 2024 17:16:22 -0700
Subject: [PATCH 2/3] update

Created using spr 1.3.4
---
 clang/docs/MemorySanitizer.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/clang/docs/MemorySanitizer.rst b/clang/docs/MemorySanitizer.rst
index 024bed25243b9..118177840add6 100644
--- a/clang/docs/MemorySanitizer.rst
+++ b/clang/docs/MemorySanitizer.rst
@@ -15,10 +15,10 @@ Typical slowdown introduced by MemorySanitizer is **3x**.
 
 Here is a not comprehensive list cases when MemorySanitizer will report an error:
 
-* Conditional branches controlled by uninitialized values.
-* Using uninitalized pointers for memory accesses.
-* Passing and returning uninitialized values to/from function calls. Can be disabled with ``-fno-sanitize-memory-param-retval``.
-* Passing uninitialized data into libc calls.
+* A code uses uninitialized value in a conditional branch.
+* Uninitialized pointer was used for memory accesses.
+* Uninitialized value passed or returned from a function call, when it 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
 ============

>From 016e6fb760ce37d0541b4e7f33b5d2def9ee055f Mon Sep 17 00:00:00 2001
From: Vitaly Buka <vitalybuka at google.com>
Date: Tue, 30 Jul 2024 10:13:13 -0700
Subject: [PATCH 3/3] Update MemorySanitizer.rst

---
 clang/docs/MemorySanitizer.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/clang/docs/MemorySanitizer.rst b/clang/docs/MemorySanitizer.rst
index 118177840add6..9775080360d49 100644
--- a/clang/docs/MemorySanitizer.rst
+++ b/clang/docs/MemorySanitizer.rst
@@ -13,11 +13,11 @@ compiler instrumentation module and a run-time library.
 
 Typical slowdown introduced by MemorySanitizer is **3x**.
 
-Here is a not comprehensive list cases when MemorySanitizer will report an error:
+Here is a not comprehensive of list cases when MemorySanitizer will report an error:
 
-* A code uses uninitialized value in a conditional branch.
+* Uninitialized value was used in a conditional branch.
 * Uninitialized pointer was used for memory accesses.
-* Uninitialized value passed or returned from a function call, when it considered an undefined behavior. The check can be disabled with ``-fno-sanitize-memory-param-retval``.
+* 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