Skip to content

Commit

Permalink
[libc++][doc] Updates the release notes.
Browse files Browse the repository at this point in the history
This is a preparation for the upcoming LLVM 17 release.

Reviewed By: ldionne, jloser, H-G-Hristov, #libc

Differential Revision: https://reviews.llvm.org/D154874
  • Loading branch information
mordante committed Jul 17, 2023
1 parent ba9a7f7 commit 44d17cd
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 7 deletions.
42 changes: 36 additions & 6 deletions libcxx/docs/ReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,24 @@ 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
Expand All @@ -48,11 +63,17 @@ Implemented Papers
- 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.
Expand Down Expand Up @@ -85,6 +106,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/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
-------------------------

Expand All @@ -109,12 +133,12 @@ Deprecations and Removals
- 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).
- ``<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>`` 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).
- ``<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).
Expand Down Expand Up @@ -145,6 +169,8 @@ Deprecations and Removals
- 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
----------------------------------

Expand Down Expand Up @@ -172,6 +198,10 @@ 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
information.

ABI Affecting Changes
---------------------
Expand Down
2 changes: 1 addition & 1 deletion libcxx/docs/Status/PSTL.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. pstl-status:
.. _pstl-status:

==========================
libc++ Parallel STL Status
Expand Down
2 changes: 2 additions & 0 deletions libcxx/docs/UsingLibcxx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,8 @@ 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
-----------------------------------------

Expand Down

0 comments on commit 44d17cd

Please sign in to comment.