[libc++][doc] Updates the release notes.

[Mordante]

Summary

This is a preparation for the upcoming LLVM 17 release.

[Mordante]

libcxx/docs/ReleaseNotes.rst

68

@var-const I noticed you did quite some work on ranges::to, will that be ready before LLVM 17, if not should we mention it.

68

@crtrott I read you expected to get <mdspan> done before LLVM 17, so I leave adding that to the release notes for you.

[ldionne]

Nice, thanks!

[philnik]

libcxx/docs/ReleaseNotes.rst

73–74

We also applied a similar optimization to find (D144394).

97

99

FreeBSD was officially supported before. We just have a CI runner now.

173

We've added the interface __asan_annotate_container_with_allocator . See https://libcxx.llvm.org/UsingLibcxx.html#turning-off-asan-annotation-in-containers. Not sure though whether we want to advertise that.

libcxx/docs/Status/PSTL.rst

1

What does this change do? We don't have an underscore in most status pages. zip, spaceship, ranges, pstl, parallelism TS, format. That's actually all the non cxxab status papers.

[Mordante]

Thanks for all the feedback! I wait a few more days before landing this. (We still have more than a week before branching.)

libcxx/docs/Status/PSTL.rst

1

This means most status pages can't be linked to. I added a link to this page from the release notes. I really like the progress made on the PSTL, so I think it is great to show the status page.

[var-const]

libcxx/docs/ReleaseNotes.rst

68

@Mordante Thanks a lot for updating the release notes and for checking re. ranges::to! I'm actively working on the last remaining two patches for ranges::to and hoping to get them in before the release. If that happens, I'll update the release notes accordingly.

[jloser]

Looks good - just left a comment on a minor typo. Thanks!

libcxx/docs/ReleaseNotes.rst

97

Quibble: typo. s/containters/containers

[pfusik]

libcxx/docs/ReleaseNotes.rst

68

[Mordante]

Thanks for all reviews. I'll land it now. When there are more remarks I can address them post-commit.

libcxx/docs/ReleaseNotes.rst

173

It can be useful, so let's document it.

[var-const]

libcxx/docs/ReleaseNotes.rst

68

Just in case, I have merged ranges::to (https://reviews.llvm.org/D142335) and the release notes should be updated.

[Mordante]

libcxx/docs/ReleaseNotes.rst

68

Just in case, I have merged ranges::to (https://reviews.llvm.org/D142335) and the release notes should be updated.

Thanks! Nice to see it done before LLVM 17.

libcxx/docs/ReleaseNotes.rst

 Note that if you are reading this file from a Git checkout or the
 main Libc++ web page, this document applies to the *next* release, not
 the current one. To see the release notes for a specific release, please
 see the `releases page <https://llvm.org/releases/>`_.
 
 What's New in Libc++ 17.0.0?
 ============================
 
+The main focus of the libc++ team has been to implement new C++20 and C++23
+features. Work on the next C++ version, C++26, has started.
+
+The C++20 ``format`` library is marked as stable. The library is not complete since
+the C++20 ``chrono`` library lacks supports for time zones and some clocks.
+
+The C++20 spaceship operator is almost complete. It misses ``long double`` and
+time zone support.
+
 There is an experimental implementation of the C++23 ``std`` module. See
 :ref:`ModulesInLibcxx` for more information.
 
+An experimental implementation of the C++20 ``stop_token`` is available.
+
+Work has started on the C++17 Parallel STL. This feature is experimental, see
+:ref:`pstl-status` for the current status.
+
+
 Implemented Papers
 ------------------
 - P2520R0 - ``move_iterator<T*>`` should be a random access iterator
 - P1328R1 - ``constexpr type_info::operator==()``
 - P1413R3 - Formatting ``thread::id`` (the ``stacktrace`` is not done yet)
 - P2675R1 - ``format``'s width estimation is too approximate and not forward compatible
 - P2505R5 - Monadic operations for ``std::expected``
 - P2711R1 - Making Multi-Param Constructors Of views explicit (``join_with_view`` is not done yet)
 - P2572R1 - ``std::format`` fill character allowances
 - P2510R3 - Formatting pointers
+- P2136R3 - ``invoke_r``
+- P2494R2 - Relaxing range adaptors to allow for move only types
+- P2585R0 - Improving default container formatting
+- P0408R7 - Efficient Access to ``basic_stringbuf``'s Buffer
+
 
 Improvements and New Features
 -----------------------------
-- ``std::equal`` and ``std::ranges::equal`` are now forwarding to ``std::memcmp`` for integral types and pointers,
-  which can lead up to 40x performance improvements.
+- ``std::equal``, ``std::ranges::equal``, ``std::find``, and
+  ``std::ranges::find``  are now forwarding to ``std::memcmp`` for trivially
+  equality comparable types, which can lead up to 40x performance improvements.
 
 - ``std::string_view`` now provides iterators that check for out-of-bounds accesses when the safe
   libc++ mode is enabled.
 
 - The performance of ``dynamic_cast`` on its hot paths is greatly improved and is as efficient as the
   ``libsupc++`` implementation. Note that the performance improvements are shipped in ``libcxxabi``.
 
 - `D122780 <https://reviews.llvm.org/D122780>`_ Improved the performance of ``std::sort`` and ``std::ranges::sort``
   by up to 50% for arithmetic types and by approximately 10% for other types.
 
 - The ``<format>`` header is no longer considered experimental. Some
   ``std::formatter`` specializations are not yet available since the class used
   in the specialization has not been implemented in libc++. This prevents the
   feature-test macro to be set.
 
 - Platforms that don't have support for a filesystem can now still take advantage of some parts of ``<filesystem>``.
   Anything that does not rely on having an actual filesystem available will now work, such as ``std::filesystem::path``,
   ``std::filesystem::perms`` and similar classes.
 
 - The library now provides a hardened mode under which common cases of library undefined behavior will be turned into
   a reliable program termination. Vendors can configure whether the hardened mode is enabled by default with the
   ``LIBCXX_HARDENING_MODE`` variable at CMake configuration time. Users can control whether the hardened mode is
   enabled on a per translation unit basis using the ``-D_LIBCPP_ENABLE_HARDENED_MODE=1`` macro. See
   ``libcxx/docs/HardenedMode.rst`` for more details.
 
 - The library now provides a debug mode which is a superset of the hardened mode, additionally enabling more expensive
   checks that are not suitable to be used in production. This replaces the legacy debug mode that was removed in this
   release. Unlike the legacy debug mode, this doesn't affect the ABI and doesn't require locking. Vendors can configure
   whether the debug mode is enabled by default with the ``LIBCXX_HARDENING_MODE`` variable at CMake configuration time.
   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/HardenedMode.rst`` for more details.
 
+- ASAN annotations to detect container overflow have been added to the
+  containers ``std::deque``, and ``std::vector``.
+
 Deprecations and Removals
 -------------------------
 
 - The "safe" mode is replaced by the hardened mode in this release. The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable is
   deprecated and setting it will trigger an error; use ``LIBCXX_HARDENING_MODE`` instead. Similarly, the
   ``_LIBCPP_ENABLE_ASSERTIONS`` macro is deprecated and setting it to ``1`` now enables the hardened mode. See
   ``libcxx/docs/HardenedMode.rst`` for more details.
 
 - The legacy debug mode has been removed in this release. Setting the macro ``_LIBCPP_ENABLE_DEBUG_MODE`` to ``1`` now
   enables the new debug mode which is part of hardening (see the "Improvements and New Features" section above). The
   ``LIBCXX_ENABLE_DEBUG_MODE`` CMake variable has been removed. For additional context, refer to the `Discourse post
   <https://discourse.llvm.org/t/rfc-removing-the-legacy-debug-mode-from-libc/71026>`_.
 
 - The ``<experimental/coroutine>`` header has been removed in this release. The ``<coroutine>`` header
   has been shipping since LLVM 14, so the Coroutines TS implementation is being removed per our policy
   for removing TSes.
 
 - Several incidental transitive includes have been removed from libc++. Those
   includes are removed based on the language version used. Incidental transitive
   inclusions of the following headers have been removed:
 
   - C++23: ``atomic``, ``bit``, ``cstdint``, ``cstdlib``, ``cstring``, ``initializer_list``, ``limits``, ``new``,
            ``stdexcept``, ``system_error``, ``type_traits``, ``typeinfo``
 
   - ``<algorithm>`` no longer includes ``<chrono>`` in any C++ version (it was previously included in C++17 and earlier).
 
   - ``<string>`` no longer includes ``<vector>`` in any C++ version (it was previously included in C++20 and earlier).
 
   - ``<string>``, ``<string_view>``, and ``<mutex>`` no longer include ``<functional>``
     in any C++ version (it was previously included in C++20 and earlier).
 
 - ``<atomic>``, ``<barrier>``, ``<latch>``, ``<numeric>``, ``<semaphore>`` and ``<shared_mutex>`` no longer include ``<iosfwd>``
   (it was previously included in all Standard versions).
 
 - The headers ``<experimental/algorithm>`` and ``<experimental/functional>`` have been removed, since all the contents
   have been implemented in namespace ``std`` for at least two releases.
 
 - The formatter specialization ``template<size_t N> struct formatter<const charT[N], charT>``

 - The ``_LIBCPP_ABI_OLD_LOGNORMAL_DISTRIBUTION`` macro has been removed.
 
 - The classes ``strstreambuf`` , ``istrstream``, ``ostrstream``, and ``strstream`` have been deprecated.
   They have been deprecated in the Standard since C++98, but were never marked as deprecated in libc++.
 
 - LWG3631 ``basic_format_arg(T&&) should use remove_cvref_t<T> throughout`` removed
   support for ``volatile`` qualified formatters.
 
+- The unmaintained Solaris support has been removed.
+
 Upcoming Deprecations and Removals
 ----------------------------------
 
 LLVM 18
 ~~~~~~~
 
 - The base template for ``std::char_traits`` has been marked as deprecated and
   will be removed in LLVM 18. If you are using ``std::char_traits`` with types
- The ``_LIBCPP_AVAILABILITY_CUSTOM_VERBOSE_ABORT_PROVIDED`` macro will not be honored anymore in LLVM 18.
   macro for details.
 
 - The headers ``<experimental/deque>``, ``<experimental/forward_list>``, ``<experimental/list>``,
   ``<experimental/map>``, ``<experimental/memory_resource>``, ``<experimental/regex>``, ``<experimental/set>``,
   ``<experimental/string>``, ``<experimental/unordered_map>``, ``<experimental/unordered_set>``,
   and ``<experimental/vector>`` will be removed in LLVM 18, as all their contents will have been implemented in
   namespace ``std`` for at least two releases.
 
 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
+  information.
 
 ABI Affecting Changes
 ---------------------
 
 - Symbols for ``std::allocator_arg``, ``std::defer_lock``, ``std::try_to_lock``, ``std::adopt_lock``, and
   ``std::piecewise_construct`` have been removed from the built library. Under most circumstances, user code
   should not have been relying on those symbols anyway since those are empty classes and the compiler does
   not generate an undefined reference unless the address of the object is taken. However, this is an ABI break

libcxx/docs/Status/PSTL.rst

-.. pstl-status:
+.. _pstl-status:
 
 ==========================
 libc++ Parallel STL Status
 ==========================
 
 .. include:: ../Helpers/Styles.rst
 
 .. contents::

libcxx/docs/UsingLibcxx.rst

 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.
 
 In C++26 formatting pointers gained a type ``P`` and allows to use
 zero-padding. These options have been retroactively applied to C++20.
 
+.. _turning-off-asan:
+
 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.
 This customization point exists only when ``_LIBCPP_HAS_ASAN_CONTAINER_ANNOTATIONS_FOR_ALL_ALLOCATORS`` Feature Test Macro is defined.
 
 For allocators not running destructors, it is also possible to `bulk-unpoison memory <https://github.com/google/sanitizers/wiki/AddressSanitizerManualPoisoning>`_ instead of disabling annotations altogether.