[libc++] Add details about string annotations #80912
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: llvm#79536
AdvenamTacet
added
documentation
libc++
|
@llvm/pr-subscribers-libcxx Author: Tacet (AdvenamTacet) ChangesThis 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: #79536 Full diff: https://github.com/llvm/llvm-project/pull/80912.diff 1 Files Affected:
diff --git a/libcxx/docs/ReleaseNotes/18.rst b/libcxx/docs/ReleaseNotes/18.rst
index 80b42ad7f653a..862284ce5494c 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>`_
|
|
Short string annotations are not merged and we did not figure out why short string annotations are problematic, yet. Therefore I won't suggest backporting them, but it would be good to update release notes to reflect that. |
vitalybuka
approved these changes
Feb 16, 2024
mordante
reviewed
Feb 17, 2024
Co-authored-by: Mark de Wever <[email protected]>
AdvenamTacet
commented
Feb 17, 2024
mordante
approved these changes
Feb 17, 2024
|
Does this need to be backported to the release/18.x branch? |
|
It's an update to a release note, so I think it should be for consistency. I can take care of it by the end of today. |
AdvenamTacet
pushed a commit
that referenced
this pull request
Feb 23, 2024
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 <[email protected]>
tstellar
pushed a commit
that referenced
this pull request
Feb 23, 2024
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 <[email protected]> Co-authored-by: Mark de Wever <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: #79536