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

[via libcxx-commits]

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

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

>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] [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>`_