[llvm] 5f17ba1 - [sanitizers] Simplify Explainer about dyld and weak overrides on Darwin. (NFC)

[Roy Sundahl via llvm-commits]

Author: Roy Sundahl
Date: 2023-04-05T10:04:29-07:00
New Revision: 5f17ba1a3832450eee9c3b85ab862f73712184a4

URL: https://github.com/llvm/llvm-project/commit/5f17ba1a3832450eee9c3b85ab862f73712184a4
DIFF: https://github.com/llvm/llvm-project/commit/5f17ba1a3832450eee9c3b85ab862f73712184a4.diff

LOG: [sanitizers] Simplify Explainer about dyld and weak overrides on Darwin. (NFC)

Presenting more than one way to satisfy the single-weak-ref requirement leads to
confusing messaging for the end user. Use the introduction of a single unused
weak variable as the preferred solution. This differential modifies D146745.

rdar://103453678

Reviewed By: yln, thetruestblue

Differential Revision: https://reviews.llvm.org/D147526

Added: 
    

Modified: 
    llvm/docs/ReleaseNotes.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/ReleaseNotes.rst b/llvm/docs/ReleaseNotes.rst
index 98582b369db4..052a8501a754 100644
--- a/llvm/docs/ReleaseNotes.rst
+++ b/llvm/docs/ReleaseNotes.rst
@@ -245,16 +245,14 @@ Changes to Sanitizers
   only consider symbols in other mach-o modules which themselves contain at
   least one weak symbol. A consequence is that if your program or dylib contains
   an intended override of a weak symbol, then it must contain at least one weak
-  symbol as well for the override to be effective. That weak symbol may be the
-  intended override itself, an otherwise usused weak symbol added solely to meet
-  the requirement, or an existing but unrelated weak symbol.
-
-    Examples:
-      __attribute__((weak)) const char * __asan_default_options(void) {...}
+  symbol as well for the override to take effect.
 
+    Example:
+      // Add this to make sure your override takes effect
       __attribute__((weak,unused)) unsigned __enableOverrides;
-      
-      __attribute__((weak)) bool unrelatedWeakFlag;
+
+      // Example override
+      extern "C" const char *__asan_default_options() { ... }
 
 Other Changes
 -------------