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

[via llvm-branch-commits]

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

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 comments in a related PR: https://github.com/llvm/llvm-project/pull/79536

Upstreamed in: 7661ade5d1ac4fc8e1e2339b2476cb8e45c24641
Upstream PR: #80912

---------

Co-authored-by: Mark de Wever <zar-rpg at xs4all.nl>

>From af13d9e09c045bdab71740584e5f54e83313e7b1 Mon Sep 17 00:00:00 2001
From: Tacet <advenam.tacet at trailofbits.com>
Date: Tue, 20 Feb 2024 07:20:21 +0100
Subject: [PATCH] [libc++] Add details about string annotations (#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 comments in a related
PR: https://github.com/llvm/llvm-project/pull/79536

---------

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

diff --git a/libcxx/docs/ReleaseNotes/18.rst b/libcxx/docs/ReleaseNotes/18.rst
index 391e0ebc52a428..7ea13e6943dd4c 100644
--- a/libcxx/docs/ReleaseNotes/18.rst
+++ b/libcxx/docs/ReleaseNotes/18.rst
@@ -125,6 +125,8 @@ Improvements and New Features
   ``${PREFIX}/share/libc++/v1``.
 
 - AddressSanitizer annotations have been added to ``std::basic_string``.
+  These annotations are enabled for all allocators by default.
+  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>`_