[libcxx-commits] [libcxx] [libc++] Add details about string annotations (PR #80912)

[via libcxx-commits]

https://github.com/AdvenamTacet updated https://github.com/llvm/llvm-project/pull/80912

>From 954c312975cf548b77cca647be37bdf1c7d1d7f0 Mon Sep 17 00:00:00 2001
From: Advenam Tacet <advenam.tacet at trailofbits.com>
Date: Tue, 6 Feb 2024 23:53:23 +0100
Subject: [PATCH 1/3] [libc++] Add details about string annotations

This commit adds information that only long strings are annotated,
and with all allocators by default.

To read why short string annotations are not turned on yet, read
related PR: https://github.com/llvm/llvm-project/pull/79536
---
 libcxx/docs/ReleaseNotes/18.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/libcxx/docs/ReleaseNotes/18.rst b/libcxx/docs/ReleaseNotes/18.rst
index 80b42ad7f653aa..862284ce5494c9 100644
--- a/libcxx/docs/ReleaseNotes/18.rst
+++ b/libcxx/docs/ReleaseNotes/18.rst
@@ -124,7 +124,9 @@ Improvements and New Features
   ``-DLIBCXX_INSTALL_MODULE_DIR=<path>``. The default location is
   ``${PREFIX}/share/libc++/v1``.
 
-- AddressSanitizer annotations have been added to ``std::basic_string``.
+- AddressSanitizer annotations have been added to ``std::basic_string``
+  external buffers (long strings only).
+  Enabled with all allocators by default.
 
 - The libc++ source code has been formatted with ``clang-format``. This
   `discourse thread <https://discourse.llvm.org/t/rfc-clang-formatting-all-of-libc-once-and-for-all>`_

>From e42b9b68ae461904afe3d0823c263ebc84a65ca4 Mon Sep 17 00:00:00 2001
From: Tacet <4922191+AdvenamTacet at users.noreply.github.com>
Date: Sat, 17 Feb 2024 14:44:52 +0100
Subject: [PATCH 2/3] Rephrase

Co-authored-by: Mark de Wever <zar-rpg at xs4all.nl>
---
 libcxx/docs/ReleaseNotes/18.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/libcxx/docs/ReleaseNotes/18.rst b/libcxx/docs/ReleaseNotes/18.rst
index 862284ce5494c9..a213ecdda0d789 100644
--- a/libcxx/docs/ReleaseNotes/18.rst
+++ b/libcxx/docs/ReleaseNotes/18.rst
@@ -124,9 +124,9 @@ Improvements and New Features
   ``-DLIBCXX_INSTALL_MODULE_DIR=<path>``. The default location is
   ``${PREFIX}/share/libc++/v1``.
 
-- AddressSanitizer annotations have been added to ``std::basic_string``
-  external buffers (long strings only).
-  Enabled with all allocators by default.
+- AddressSanitizer annotations have been added to ``std::basic_string``.
+  These annotations are enabled for all allocators by default.
+  It's only enable for long string, string using the small buffer optimization are not annotated.
 
 - The libc++ source code has been formatted with ``clang-format``. This
   `discourse thread <https://discourse.llvm.org/t/rfc-clang-formatting-all-of-libc-once-and-for-all>`_

>From 8b1125ba3ab9aca52680aea41e9b7f3d64988fc3 Mon Sep 17 00:00:00 2001
From: Tacet <4922191+AdvenamTacet at users.noreply.github.com>
Date: Sat, 17 Feb 2024 14:46:45 +0100
Subject: [PATCH 3/3] Fix typos

---
 libcxx/docs/ReleaseNotes/18.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/libcxx/docs/ReleaseNotes/18.rst b/libcxx/docs/ReleaseNotes/18.rst
index a213ecdda0d789..fcd630e09b449f 100644
--- a/libcxx/docs/ReleaseNotes/18.rst
+++ b/libcxx/docs/ReleaseNotes/18.rst
@@ -126,7 +126,7 @@ Improvements and New Features
 
 - AddressSanitizer annotations have been added to ``std::basic_string``.
   These annotations are enabled for all allocators by default.
-  It's only enable for long string, string using the small buffer optimization are not annotated.
+  It's only enabled for long strings, strings using the small buffer optimization are not annotated.
 
 - The libc++ source code has been formatted with ``clang-format``. This
   `discourse thread <https://discourse.llvm.org/t/rfc-clang-formatting-all-of-libc-once-and-for-all>`_