[libcxx-commits] [PATCH] D156162: [NFC] Extend (and fix) release notes about ASan

[Tacet via Phabricator via libcxx-commits]

AdvenamTacet created this revision.
AdvenamTacet added a reviewer: philnik.
Herald added a project: All.
AdvenamTacet requested review of this revision.
Herald added a project: libc++.
Herald added a subscriber: libcxx-commits.
Herald added a reviewer: libc++.

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),
- but it's possible to turn them off for particular allocators.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D156162

Files:
  libcxx/docs/ReleaseNotes/17.rst


Index: libcxx/docs/ReleaseNotes/17.rst
===================================================================
--- libcxx/docs/ReleaseNotes/17.rst
+++ libcxx/docs/ReleaseNotes/17.rst
@@ -107,8 +107,10 @@
   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 annotations have been added to the ``std::deque`` container, to detect container overflows.
+  Additionally, container annotations have been extended to cover all allocators by default in ``std::vector``
+  (buffer alignment is no longer a requirement). If you wish to disable annotations
+  for a particular allocator, you can refer to the details in :ref:`turning-off-asan`.
 
 Deprecations and Removals
 -------------------------
@@ -203,9 +205,9 @@
 
 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


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D156162.543673.patch
Type: text/x-patch
Size: 1496 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libcxx-commits/attachments/20230724/089bf439/attachment.bin>