Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[libc++] Add details about string annotations #82730

Conversation

AdvenamTacet
Copy link
Member

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: #79536

Upstreamed in: 7661ade
Upstream PR: #80912


Co-authored-by: Mark de Wever zar-rpg@xs4all.nl

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: #79536

---------

Co-authored-by: Mark de Wever <zar-rpg@xs4all.nl>
@AdvenamTacet AdvenamTacet added documentation libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi. labels Feb 23, 2024
@AdvenamTacet AdvenamTacet requested a review from a team as a code owner February 23, 2024 03:50
@llvmbot
Copy link
Collaborator

llvmbot commented Feb 23, 2024

@llvm/pr-subscribers-libcxx

Author: Tacet (AdvenamTacet)

Changes

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: #79536

Upstreamed in: 7661ade
Upstream PR: #80912


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


Full diff: https://github.com/llvm/llvm-project/pull/82730.diff

1 Files Affected:

  • (modified) libcxx/docs/ReleaseNotes/18.rst (+2)
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>`_

@AdvenamTacet AdvenamTacet added this to the LLVM 18.X Release milestone Feb 23, 2024
@tstellar tstellar merged commit c65d48d into release/18.x Feb 23, 2024
19 of 21 checks passed
@tstellar tstellar deleted the users/AdvenamTacet/llvm18-release-note-string-annotations branch February 23, 2024 21:06
@pointhex pointhex mentioned this pull request May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi.
Projects
Development

Successfully merging this pull request may close these issues.

4 participants