[libcxx-commits] [libcxx] 7da669d - [libc++][doc] Fixes header formatting.
Mark de Wever via libcxx-commits
libcxx-commits at lists.llvm.org
Tue Jun 27 09:43:06 PDT 2023
Author: Mark de Wever
Date: 2023-06-27T18:42:51+02:00
New Revision: 7da669d9e53ec7ba42e382788f976c8f2decb116
URL: https://github.com/llvm/llvm-project/commit/7da669d9e53ec7ba42e382788f976c8f2decb116
DIFF: https://github.com/llvm/llvm-project/commit/7da669d9e53ec7ba42e382788f976c8f2decb116.diff
LOG: [libc++][doc] Fixes header formatting.
This was broken in D145628; it caused the new header not to be displayed
as a header at all and show part of the markup as text.
Added:
Modified:
libcxx/docs/UsingLibcxx.rst
Removed:
################################################################################
diff --git a/libcxx/docs/UsingLibcxx.rst b/libcxx/docs/UsingLibcxx.rst
index 27a836122976e..96fee66557e5b 100644
--- a/libcxx/docs/UsingLibcxx.rst
+++ b/libcxx/docs/UsingLibcxx.rst
@@ -536,9 +536,9 @@ Standard. Libc++ retroactively updates the Unicode Standard in older C++
versions. This allows the library to have better estimates for newly introduced
Unicode code points, without requiring the user to use the latest C++ version
in their code base.
-=======
+
Turning off ASan annotation in containers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------------
``__asan_annotate_container_with_allocator`` is a customization point to allow users to disable
`Address Sanitizer annotations for containers <https://github.com/google/sanitizers/wiki/AddressSanitizerContainerOverflow>`_ for specific allocators. This may be necessary for allocators that access allocated memory.
@@ -558,7 +558,7 @@ The annotations for a ``user_allocator`` can be disabled like this:
#endif
Why may I want to turn it off?
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are a few reasons why you may want to turn off annotations for an allocator.
Unpoisoning may not be an option, if (for example) you are not maintaining the allocator.
More information about the libcxx-commits
mailing list