[libcxx-commits] [libcxx] 3326feb - [NFC] Fix release notes about ASan

[Advenam Tacet via libcxx-commits]

Author: Advenam Tacet
Date: 2023-07-25T04:50:09+02:00
New Revision: 3326feb39729e04b5bfdb9f87c8118573451b501

URL: https://github.com/llvm/llvm-project/commit/3326feb39729e04b5bfdb9f87c8118573451b501
DIFF: https://github.com/llvm/llvm-project/commit/3326feb39729e04b5bfdb9f87c8118573451b501.diff

LOG: [NFC] Fix release notes about ASan

Existing notes were not fully correct and were missing a detail:
- `std::vector` was annotated long time ago,
- `std::deque` annotations are new,
- now container annotations were extended to all allocators (support in ASan API exists since LLVM16).

Reviewed By: philnik, #libc

Differential Revision: https://reviews.llvm.org/D156162

Added: 
    

Modified: 
    libcxx/docs/ReleaseNotes/17.rst

Removed: 
    


################################################################################
diff  --git a/libcxx/docs/ReleaseNotes/17.rst b/libcxx/docs/ReleaseNotes/17.rst
index aa51e0ae124a1a..ba17911b045a30 100644
--- a/libcxx/docs/ReleaseNotes/17.rst
+++ b/libcxx/docs/ReleaseNotes/17.rst
@@ -107,8 +107,9 @@ Improvements and New Features
   Users can control whether the debug mode is enabled on a per translation unit basis using the
   ``-D_LIBCPP_ENABLE_DEBUG_MODE=1`` macro. See ``libcxx/docs/Hardening.rst`` for more details.
 
-- ASAN annotations to detect container overflow have been added to the
-  containers ``std::deque``, and ``std::vector``.
+- ASan container annotations have been extended to cover all allocators in ``std::vector``.
+
+- ASan annotations have been added to the ``std::deque`` container, to detect container overflows.
 
 Deprecations and Removals
 -------------------------
@@ -203,9 +204,9 @@ LLVM 18
 
 API Changes
 -----------
-- Added ``__asan_annotate_container_with_allocator``, which is is a
-  customization point to allow users to disable Address Sanitizer annotations
-  for containers for specific allocators. See :ref:`turning-off-asan` for more
+- Added ``__asan_annotate_container_with_allocator``, which is a
+  customization point to allow users to disable Address Sanitizer container annotations
+  for specific allocators. See :ref:`turning-off-asan` for more
   information.
 
 ABI Affecting Changes