[libcxx-commits] [libcxx] [libc++][NFC] Post-LLVM19-release docs cleanup (PR #99667)
Hristo Hristov via libcxx-commits
libcxx-commits at lists.llvm.org
Sun Aug 4 21:49:35 PDT 2024
https://github.com/Zingam updated https://github.com/llvm/llvm-project/pull/99667
>From 8cde04e2317bff4b0bb3fffe25f0465c0ad8a870 Mon Sep 17 00:00:00 2001
From: Hristo Hristov <hghristov.rmm at gmail.com>
Date: Fri, 19 Jul 2024 19:55:13 +0300
Subject: [PATCH 1/4] [libc++][ranges][NFC] Updated status pages with C++26
papers
---
libcxx/docs/Status/RangesMajorFeatures.csv | 1 +
libcxx/docs/Status/RangesViews.csv | 4 ++++
2 files changed, 5 insertions(+)
diff --git a/libcxx/docs/Status/RangesMajorFeatures.csv b/libcxx/docs/Status/RangesMajorFeatures.csv
index d00fbce9edf48..7bf9705e41ee2 100644
--- a/libcxx/docs/Status/RangesMajorFeatures.csv
+++ b/libcxx/docs/Status/RangesMajorFeatures.csv
@@ -1,4 +1,5 @@
Standard,Name,Assignee,CL,Status
+C++26,`Vector API for random number generation <https://wg21.link/P1068R10>`_,Unassigned,No patch yet,Not started
C++23,`ranges::to <https://wg21.link/P1206R7>`_,Konstantin Varlamov,`D142335 <https://reviews.llvm.org/D142335>`_,Complete
C++23,`Pipe support for user-defined range adaptors <https://wg21.link/P2387R3>`_,"Louis Dionne, Jakub Mazurkiewicz, and Xiaoyang Liu",Various,Complete
C++23,`Formatting Ranges <https://wg21.link/P2286R8>`_,Mark de Wever,Various,Complete
diff --git a/libcxx/docs/Status/RangesViews.csv b/libcxx/docs/Status/RangesViews.csv
index f141656eb131a..6f431caad9bfe 100644
--- a/libcxx/docs/Status/RangesViews.csv
+++ b/libcxx/docs/Status/RangesViews.csv
@@ -36,3 +36,7 @@ C++23,`as_const <https://wg21.link/P2278R4>`_,Unassigned,No patch yet,Not starte
C++23,`as_rvalue <https://wg21.link/P2446R2>`_,Nikolas Klauser,`D137637 <https://llvm.org/D137637>`_,✅
C++23,`stride <https://wg21.link/P1899R3>`_,Hristo Hristov and Will Hawkins,`D156924 <https://llvm.org/D156924>`_,In Progress
C++23,`enumerate <https://wg21.link/P2164R9>`_,Hristo Hristov,`D157193 <https://reviews.llvm.org/D157193>`_,In Progress
+,,,,
+,,,,
+,,,,
+C++26,`concat <https://wg21.link/P2542R7>`_,Unassigned,No patch yet,Not started
>From d6a80209e4b9ba1cf6523988a1d64ecf3dd65682 Mon Sep 17 00:00:00 2001
From: Hristo Hristov <hghristov.rmm at gmail.com>
Date: Fri, 19 Jul 2024 20:15:30 +0300
Subject: [PATCH 2/4] Removed Spaceship and Ranges status pages
---
libcxx/docs/Status/Ranges.rst | 48 --------------------
libcxx/docs/Status/RangesAlgorithms.csv | 18 --------
libcxx/docs/Status/RangesMajorFeatures.csv | 6 ---
libcxx/docs/Status/RangesViews.csv | 42 -----------------
libcxx/docs/Status/Spaceship.rst | 53 ----------------------
libcxx/docs/index.rst | 1 -
6 files changed, 168 deletions(-)
delete mode 100644 libcxx/docs/Status/Ranges.rst
delete mode 100644 libcxx/docs/Status/RangesAlgorithms.csv
delete mode 100644 libcxx/docs/Status/RangesMajorFeatures.csv
delete mode 100644 libcxx/docs/Status/RangesViews.csv
delete mode 100644 libcxx/docs/Status/Spaceship.rst
diff --git a/libcxx/docs/Status/Ranges.rst b/libcxx/docs/Status/Ranges.rst
deleted file mode 100644
index cdbf68393b739..0000000000000
--- a/libcxx/docs/Status/Ranges.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-.. _ranges-status:
-
-================================
-libc++ Ranges Status
-================================
-
-.. include:: ../Helpers/Styles.rst
-
-.. contents::
- :local:
-
-
-Overview
-================================
-
-This document contains the status of the Ranges library in libc++. It is used to track
-both the status of the sub-projects of the ranges library and who is assigned to these
-sub-projects. This is imperative to effective implementation so that work is not
-duplicated and implementors are not blocked by each other.
-
-If you are interested in contributing to the libc++ Ranges library, please send a message
-to the #libcxx channel in the LLVM discord. Please *do not* start working on any of the
-*assigned* items below.
-
-
-Major features
-=======================================
-
-.. csv-table::
- :file: RangesMajorFeatures.csv
- :header-rows: 1
- :widths: auto
-
-Views
-=======================================
-
-.. csv-table::
- :file: RangesViews.csv
- :header-rows: 1
- :widths: auto
-
-Algorithms
-=======================================
-
-.. csv-table::
- :file: RangesAlgorithms.csv
- :header-rows: 1
- :widths: auto
diff --git a/libcxx/docs/Status/RangesAlgorithms.csv b/libcxx/docs/Status/RangesAlgorithms.csv
deleted file mode 100644
index 469ea21a76aab..0000000000000
--- a/libcxx/docs/Status/RangesAlgorithms.csv
+++ /dev/null
@@ -1,18 +0,0 @@
-Standard,Algorithm,Assignee,CL,Status
-C++20,all C++20 algorithms,N/A,N/A,✅
-C++23,`find_last <https://wg21.link/P1223R5>`_,Nicole Mazzuca,`#99312 <https://github.com/llvm/llvm-project/pull/99312>`_,Complete
-C++23,`find_last_if <https://wg21.link/P1223R5>`_,Nicole Mazzuca,`#99312 <https://github.com/llvm/llvm-project/pull/99312>`_,Complete
-C++23,`find_last_if_not <https://wg21.link/P1223R5>`_,Nicole Mazzuca,`#99312 <https://github.com/llvm/llvm-project/pull/99312>`_,Complete
-C++23,`starts_with <https://wg21.link/P1659R3>`_,Zijun Zhao,`D150735 <https://llvm.org/D150735>`_,Complete
-C++23,`ends_with <https://wg21.link/P1659R3>`_,Zijun Zhao, `D150831 <https://llvm.org/D150831>`_,Complete
-C++23,`shift_left <https://wg21.link/p2440r1>`_,Unassigned,No patch yet,Not started
-C++23,`shift_right <https://wg21.link/p2440r1>`_,Unassigned,No patch yet,Not started
-C++23,`iota (algorithm) <https://wg21.link/p2440r1>`_,Unassigned,No patch yet,Not started
-C++23,`fold <https://wg21.link/p2322r5>`_,Unassigned,No patch yet,Not started
-C++23,`contains <https://wg21.link/p2302r2>`_,Zijun Zhao, `#65148 <https://github.com/llvm/llvm-project/pull/65148>`_,Complete
-C++23,`fold_left_with_iter <https://wg21.link/p2322r6>`_,Christopher Di Bella,N/A,Complete
-C++23,`fold_left <https://wg21.link/p2322r6>`_,Christopher Di Bella,N/A,Complete
-C++23,`fold_left_first_with_iter <https://wg21.link/p2322r6>`_,Christopher Di Bella,N/A,In progress
-C++23,`fold_left_first <https://wg21.link/p2322r6>`_,Christopher Di Bella,N/A,In progress
-C++23,`fold_right <https://wg21.link/p2322r6>`_,Christopher Di Bella,N/A,In progress
-C++23,`fold_right_last <https://wg21.link/p2322r6>`_,Christopher Di Bella,N/A,In progress
diff --git a/libcxx/docs/Status/RangesMajorFeatures.csv b/libcxx/docs/Status/RangesMajorFeatures.csv
deleted file mode 100644
index 7bf9705e41ee2..0000000000000
--- a/libcxx/docs/Status/RangesMajorFeatures.csv
+++ /dev/null
@@ -1,6 +0,0 @@
-Standard,Name,Assignee,CL,Status
-C++26,`Vector API for random number generation <https://wg21.link/P1068R10>`_,Unassigned,No patch yet,Not started
-C++23,`ranges::to <https://wg21.link/P1206R7>`_,Konstantin Varlamov,`D142335 <https://reviews.llvm.org/D142335>`_,Complete
-C++23,`Pipe support for user-defined range adaptors <https://wg21.link/P2387R3>`_,"Louis Dionne, Jakub Mazurkiewicz, and Xiaoyang Liu",Various,Complete
-C++23,`Formatting Ranges <https://wg21.link/P2286R8>`_,Mark de Wever,Various,Complete
-C++20,`Stashing stashing iterators for proper flattening <https://wg21.link/P2770R0>`_,Jakub Mazurkiewicz,Various,In progress
diff --git a/libcxx/docs/Status/RangesViews.csv b/libcxx/docs/Status/RangesViews.csv
deleted file mode 100644
index 6f431caad9bfe..0000000000000
--- a/libcxx/docs/Status/RangesViews.csv
+++ /dev/null
@@ -1,42 +0,0 @@
-Standard,View,Assignee,CL,Status
-C++20,`empty <https://wg21.link/P0896R4>`_,Zoe Carver,`D103208 <https://llvm.org/D103208>`_,✅
-C++20,`single <https://wg21.link/P0896R4>`_,Zoe Carver,`D106840 <https://llvm.org/D106840>`_,✅
-C++20,`iota (view) <https://wg21.link/P0896R4>`_,Zoe Carver,`D107396 <https://llvm.org/D107396>`_,✅
-C++20,`all <https://wg21.link/P0896R4>`_,Zoe Carver,`D102028 <https://llvm.org/D102028>`_,✅
-C++20,`ref_view <https://wg21.link/P0896R4>`_,Zoe Carver,`D102020 <https://llvm.org/D102020>`_,✅
-C++20,`owning_view <https://wg21.link/P0896R4>`_,Arthur O'Dwyer,`D116894 <https://llvm.org/D116894>`_,✅
-C++20,`filter <https://wg21.link/P0896R4>`_,Louis Dionne,`D109086 <https://llvm.org/D109086>`_,✅
-C++20,`transform <https://wg21.link/P0896R4>`_,Zoe Carver,`D103056 <https://llvm.org/D103056>`_,✅
-C++20,`take <https://wg21.link/P0896R4>`_,Zoe Carver,`D106507 <https://llvm.org/D106507>`_,✅
-C++20,`take_while <https://wg21.link/P1035R7>`_,Hui Xie,`D134952 <https://llvm.org/D134952>`_,✅
-C++20,`drop <https://wg21.link/P1035R7>`_,Zoe Carver,`D102037 <https://llvm.org/D102037>`_,✅
-C++20,`drop_while <https://wg21.link/P1035R7>`_,Hui Xie,`D135460 <https://llvm.org/D135460>`_,✅
-C++20,`join <https://wg21.link/P0896R4>`_,Zoe Carver,`D107671 <https://llvm.org/D107671>`_,✅
-C++20,`split <https://wg21.link/P2210R2>`_,Hui Xie,`D142063 <https://llvm.org/D142063>`_,✅
-C++20,`lazy_split <https://wg21.link/P0896R4>`_,Zoe Carver and Konstantin Varlamov,`D107500 <https://llvm.org/D107500>`_,✅
-C++20,`counted <https://wg21.link/P0896R4>`_,Zoe Carver,`D106923 <https://llvm.org/D106923>`_,✅
-C++20,`common <https://wg21.link/P0896R4>`_,Zoe Carver,`D105753 <https://llvm.org/D105753>`_,✅
-C++20,`reverse <https://wg21.link/P0896R4>`_,Zoe Carver,`D107096 <https://llvm.org/D107096>`_,✅
-C++20,`elements / keys / values <https://wg21.link/P1035R7>`_,Hui Xie,`D136268 <https://llvm.org/D136268>`_,✅
-C++20,`istream <https://wg21.link/P1035R7>`_,Hui Xie,`D133317 <https://llvm.org/D133317>`_,✅
-,,,,
-,,,,
-,,,,
-C++23,`repeat <https://wg21.link/P2474R2>`_,Yrong,`D141699 <https://llvm.org/D141699>`_,✅
-C++23,`cartesian_product <https://wg21.link/P2374R4>`_,Unassigned,No patch yet,Not started
-C++23,`zip <https://wg21.link/P2321R2>`_,Hui Xie,`D122806 <https://llvm.org/D122806>`_,✅
-C++23,`zip_transform <https://wg21.link/P2321R2>`_,Hui Xie,No patch yet,Not started
-C++23,`adjacent <https://wg21.link/P2321R2>`_,Hui Xie,No patch yet,Not started
-C++23,`adjacent_transform <https://wg21.link/P2321R2>`_,Hui Xie,No patch yet,Not started
-C++23,`join_with <https://wg21.link/P2441R2>`_,Jakub Mazurkiewicz,`65536 <https://github.com/llvm/llvm-project/pull/65536>`_,In progress
-C++23,`slide <https://wg21.link/P2442R1>`_,Will Hawkins,`67146 <https://github.com/llvm/llvm-project/pull/67146>`_,In Progress
-C++23,`chunk <https://wg21.link/P2442R1>`_,Unassigned,No patch yet,Not started
-C++23,`chunk_by <https://wg21.link/P2443R1>`_,Jakub Mazurkiewicz,`D144767 <https://llvm.org/D144767>`_,✅
-C++23,`as_const <https://wg21.link/P2278R4>`_,Unassigned,No patch yet,Not started
-C++23,`as_rvalue <https://wg21.link/P2446R2>`_,Nikolas Klauser,`D137637 <https://llvm.org/D137637>`_,✅
-C++23,`stride <https://wg21.link/P1899R3>`_,Hristo Hristov and Will Hawkins,`D156924 <https://llvm.org/D156924>`_,In Progress
-C++23,`enumerate <https://wg21.link/P2164R9>`_,Hristo Hristov,`D157193 <https://reviews.llvm.org/D157193>`_,In Progress
-,,,,
-,,,,
-,,,,
-C++26,`concat <https://wg21.link/P2542R7>`_,Unassigned,No patch yet,Not started
diff --git a/libcxx/docs/Status/Spaceship.rst b/libcxx/docs/Status/Spaceship.rst
deleted file mode 100644
index d596c1128dbf6..0000000000000
--- a/libcxx/docs/Status/Spaceship.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-.. spaceship-status:
-
-==============================================
-libc++ Spaceship Operator Status (operator<=>)
-==============================================
-
-.. include:: ../Helpers/Styles.rst
-
-.. contents::
- :local:
-
-
-Overview
-================================
-
-This document contains the status of the C++20 spaceship operator support
-in libc++. It is used to track both the status of the sub-projects of the effort
-and who is assigned to these sub-projects. This is imperative to effective
-implementation so that work is not duplicated and implementors are not blocked
-by each other.
-
-If you are interested in contributing to this effort, please send a message
-to the #libcxx channel in the LLVM discord. Please *do not* start working on any
-of the assigned items below.
-
-
-Sub-Projects in the Implementation Effort
-=========================================
-
-.. csv-table::
- :file: SpaceshipProjects.csv
- :header-rows: 1
- :widths: auto
-
-.. note::
-
- .. [#note-strongorder] ``std::strong_order(long double, long double)`` is not yet implemented.
-
-
-Misc. Items and TODOs
-====================================
-
-(Note: files with required updates will contain the TODO at the beginning of the
-list item so they can be easily found via global search.)
-
-
-Paper and Issue Status
-====================================
-
-.. csv-table::
- :file: SpaceshipPapers.csv
- :header-rows: 1
- :widths: auto
diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index 4bca3ccc8fa06..69a9e575cfe7c 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -53,7 +53,6 @@ Getting Started with libc++
Status/PSTL
Status/Ranges
Status/Spaceship
- Status/SpecialMath
Status/Zip
>From c4f1f85e1614efae0b6943639478108c3af1dde7 Mon Sep 17 00:00:00 2001
From: Hristo Hristov <hghristov.rmm at gmail.com>
Date: Sat, 3 Aug 2024 20:45:25 +0300
Subject: [PATCH 3/4] Removed Release Notes for LLVM18
---
libcxx/docs/ReleaseNotes.rst | 1 -
libcxx/docs/ReleaseNotes/18.rst | 345 --------------------------------
libcxx/docs/ReleaseNotes/19.rst | 3 +-
3 files changed, 1 insertion(+), 348 deletions(-)
delete mode 100644 libcxx/docs/ReleaseNotes/18.rst
diff --git a/libcxx/docs/ReleaseNotes.rst b/libcxx/docs/ReleaseNotes.rst
index 9a77a5c23f30b..47042c4af1649 100644
--- a/libcxx/docs/ReleaseNotes.rst
+++ b/libcxx/docs/ReleaseNotes.rst
@@ -4,7 +4,6 @@
.. toctree::
:hidden:
- ReleaseNotes/18
ReleaseNotes/19
.. The release notes are in versioned files, but we make sure to keep publishing
diff --git a/libcxx/docs/ReleaseNotes/18.rst b/libcxx/docs/ReleaseNotes/18.rst
deleted file mode 100644
index 4f7b9b362e5e6..0000000000000
--- a/libcxx/docs/ReleaseNotes/18.rst
+++ /dev/null
@@ -1,345 +0,0 @@
-===========================================
-Libc++ 18.0.0 (In-Progress) Release Notes
-===========================================
-
-.. contents::
- :local:
- :depth: 2
-
-Written by the `Libc++ Team <https://libcxx.llvm.org>`_
-
-.. warning::
-
- These are in-progress notes for the upcoming libc++ 18.0.0 release.
- Release notes for previous releases can be found on
- `the Download Page <https://releases.llvm.org/download.html>`_.
-
-Introduction
-============
-
-This document contains the release notes for the libc++ C++ Standard Library,
-part of the LLVM Compiler Infrastructure, release 18.0.0. Here we describe the
-status of libc++ in some detail, including major improvements from the previous
-release and new feature work. For the general LLVM release notes, see `the LLVM
-documentation <https://llvm.org/docs/ReleaseNotes.html>`_. All LLVM releases may
-be downloaded from the `LLVM releases web site <https://llvm.org/releases/>`_.
-
-For more information about libc++, please see the `Libc++ Web Site
-<https://libcxx.llvm.org>`_ or the `LLVM Web Site <https://llvm.org>`_.
-
-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++ 18.0.0?
-==============================
-
-The main focus of the libc++ team has been to implement new C++20, C++23,
-and C++26 features.
-
-New hardened modes for the library have been added, replacing the legacy debug mode that was
-removed in the LLVM 17 release. Unlike the legacy debug mode, some of these hardening modes are
-also intended to be used in production. See :ref:`hardening` for more details.
-
-Work on the ranges support has progressed. See
-:ref:`ranges-status` for the current status.
-
-Work on the experimental C++23 module support has progressed. The ``std.compat``
-module is available and the feature is retroactively available in C++20. See
-:ref:`ModulesInLibcxx` for more information.
-
-Work on the experimental C++17 Parallel STL has progressed. See
-:ref:`pstl-status` for the current status.
-
-Work on the experimental C++17 SIMD support has progressed. See
-:ref:`parallelism-status` for the current status.
-
-
-Implemented Papers
-------------------
-- P2093R14 - Formatted output
-- P2539R4 - Should the output of ``std::print`` to a terminal be synchronized with the underlying stream?
-- P2497R0 - Testing for success or failure of ``<charconv>`` functions
-- P2697R1 - Interfacing ``bitset`` with ``string_view``
-- P2443R1 - ``views::chunk_by``
-- P2538R1 - ADL-proof ``std::projected``
-- P2614R2 - Deprecate ``numeric_limits::has_denorm``
-- P0053R7 - C++ Synchronized Buffered Ostream (in the experimental library)
-- P2467R1 - Support exclusive mode for fstreams
-- P0020R6 - Floating Point Atomic
-- P2905R2 - Runtime format strings
-- P2918R2 - Runtime format strings II
-- P2871R3 - Remove Deprecated Unicode Conversion Facets from C++26
-- P2870R3 - Remove ``basic_string::reserve()``
-- P2909R4 - Fix formatting of code units as integers (Dude, where’s my ``char``?)
-- P2821R5 - ``span.at()``
-- P0521R0 - Proposed Resolution for CA 14 (``shared_ptr`` ``use_count/unique``)
-- P0543R3 - Saturation arithmetic
-- P1759R6 - Native handles and file streams
-- P2868R3 - Remove Deprecated ``std::allocator`` Typedef From C++26
-- P2517R1 - Add a conditional ``noexcept`` specification to ``std::apply``
-- P2447R6 - ``span`` over initializer list
-
-
-Improvements and New Features
------------------------------
-
-- ``std::ranges::count`` and ``std::ranges::find`` are now optimized for
- ``std::vector<bool>::iterator``, which can lead up to 350x performance
- improvements.
-
-- ``std::for_each`` has been optimized for segmented iterators like ``std::deque::iterator`` in C++23 and
- later, which can lead up to 40x performance improvements.
-
-- The library now provides several hardening modes under which common cases of library undefined behavior will be turned
- into a reliable program termination. The ``fast`` hardening mode enables a set of security-critical checks with
- minimal runtime overhead; the ``extensive`` hardening mode additionally enables relatively cheap checks that catch
- common logic errors but aren't necessarily security-critical; and the ``debug`` hardening mode enables all available
- checks, some of which might be very expensive. Vendors can configure which hardening mode is enabled by default with
- the ``LIBCXX_HARDENING_MODE`` variable at CMake configuration time. Users can control which hardening mode is enabled
- on a per translation unit basis using the ``_LIBCPP_HARDENING_MODE`` macro. See :ref:`the hardening documentation
- <using-hardening-modes>` for more details.
-
-- The ``_LIBCPP_ENABLE_CXX26_REMOVED_CODECVT`` macro has been added to make
- the declarations in ``<codecvt>`` available.
-
-- The ``_LIBCPP_ENABLE_CXX26_REMOVED_STRING_RESERVE`` macro has been added to make
- the function ``std::basic_string<...>::reserve()`` available.
-
-- The ``_LIBCPP_ENABLE_CXX26_REMOVED_ALLOCATOR_MEMBERS`` macro has been added to make
- the function ``allocator<T>::is_always_equal`` available.
-
-- The ``_LIBCPP_ENABLE_CXX20_REMOVED_SHARED_PTR_UNIQUE`` macro has been added to make
- the function ``std::shared_ptr<...>::unique()`` available.
-
-- The cmake option ``LIBCXX_ENABLE_STD_MODULES`` has been removed. The test
- infrastructure no longer depends on a modern CMake, it works with the minimal
- required LLVM version (3.20.0).
-
-- The ``.cppm`` files of experimental standard library modules can now be
- installed. By default, they are not installed. This can be enabled by
- configuring CMake with ``-DLIBCXX_INSTALL_MODULES=ON``. The installation
- directory can be configured with the CMake option
- ``-DLIBCXX_INSTALL_MODULE_DIR=<path>``. The default location is
- ``${PREFIX}/share/libc++/v1``.
-
-- AddressSanitizer annotations have been added to ``std::basic_string``.
- These annotations are enabled for all allocators by default.
- It's only enabled for long strings, strings using the small buffer optimization are not annotated.
-
-- The libc++ source code has been formatted with ``clang-format``. This
- `discourse thread <https://discourse.llvm.org/t/rfc-clang-formatting-all-of-libc-once-and-for-all>`_
- contains information how to rebase downstream patches.
-
-Deprecations and Removals
--------------------------
-
-- Availability macros which will never trigger an error have been removed. This includes anything that has been
- introduced before macOS 10.13, iOS 12, tvOS 12 and watchOS 4. This shouldn't affect anybody, since AppleClang 15
- doesn't support any older OSes. If you are a vendor and make use of these macros, please inform the libc++ team so we
- can re-introduce them and consider upstreaming support for your platform.
-
-- The non-conforming constructor ``std::future_error(std::error_code)`` has been removed. Please use the
- ``std::future_error(std::future_errc)`` constructor provided in C++17 instead.
-
-- `P1957 <https://wg21.link/P1957>`_ has been implemented in Clang and libc++ removed a code path that led to
- narrowing conversions in ``std::variant`` behaving in a non-standard way. This may change how some uses of
- ``std::variant``'s constructor behave in user code. The ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT``
- macro is provided to restore the previous behavior, and it will be supported in the LLVM 18 release only.
- In LLVM 19 and beyond, ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` will not be honored anymore.
-
-- Overriding ``__libcpp_verbose_abort`` no longer has any effect on library assertions. The only supported way
- to customize the assertion handler that gets invoked when a hardening assertion fails is now by setting the
- ``LIBCXX_ASSERTION_HANDLER_FILE`` CMake variable and providing a custom header. See the documentation on
- overriding the default assertion handler for details. The ability to override ``__libcpp_verbose_abort``
- will be removed in an upcoming release in favor of the new overriding mechanism.
-
-- In safe mode (which is now equivalent to the ``extensive`` hardening mode), a failed assertion will now
- generate a trap rather than a call to verbose abort.
-
-- The ``_LIBCPP_AVAILABILITY_CUSTOM_VERBOSE_ABORT_PROVIDED`` macro is not honored anymore in LLVM 18.
- Please see the updated documentation about the hardening modes in libc++ and in particular on
- overriding the default assertion handler.
-
-- 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>`` have been removed in LLVM 18, as all their contents will have been
- implemented in namespace ``std`` for at least two releases.
-
-- The macro ``_LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS`` has been deprecated and will be removed
- in LLVM 19. This macro used to re-enable redundant members of ``std::allocator<T>`` like ``pointer``,
- ``reference``, ``rebind``, ``address``, ``max_size``, ``construct``, ``destroy``, and the two-argument
- overload of ``allocate``. However, this led to the library being non-conforming due to incorrect
- constexpr-ness.
-
-- The macros ``_LIBCPP_ENABLE_CXX17_REMOVED_FEATURES`` and
- ``_LIBCPP_ENABLE_CXX20_REMOVED_FEATURES`` have been deprecated and
- will be removed in LLVM 19. These macros used to re-enable all features
- that were removed in the C++17 and C++20 standards. Instead of using these
- macros, please use the macros to re-enable individual features.
-
-- The macro ``_LIBCPP_INLINE_VISIBILITY`` has been deprecated in LLVM 18 and
- will be removed entirely in LLVM 19. The macro ``_LIBCPP_HIDE_FROM_ABI`` is
- the drop-in replacement.
-
-- The macro ``_VSTD`` has been deprecated in LLVM 18 and will be removed
- entirely in LLVM 19. The code ``std`` is the drop-in replacement.
-
-
-Upcoming Deprecations and Removals
-----------------------------------
-
-- The ability to override ``__libcpp_verbose_abort`` will be removed in an upcoming release.
-
-LLVM 19
-~~~~~~~
-
-- The ``LIBCXX_EXECUTOR`` CMake variable has been deprecated. LLVM 19 will
- completely remove support for the ``*_EXECUTOR`` variables.
-
-- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable that was used to enable the safe mode will be deprecated and setting
- it will trigger an error; use the ``LIBCXX_HARDENING_MODE`` variable with the value ``extensive`` instead. Similarly,
- the ``_LIBCPP_ENABLE_ASSERTIONS`` macro will be deprecated (setting it to ``1`` still enables the extensive mode in
- the LLVM 19 release while also issuing a deprecation warning). See :ref:`the hardening documentation
- <using-hardening-modes>` for more details.
-
-- The base template for ``std::char_traits`` has been marked as deprecated and will be removed in LLVM 19. If you
- are using ``std::char_traits`` with types other than ``char``, ``wchar_t``, ``char8_t``, ``char16_t``, ``char32_t``
- or a custom character type for which you specialized ``std::char_traits``, your code will stop working when we
- remove the base template. The Standard does not mandate that a base template is provided, and such a base template
- is bound to be incorrect for some types, which could currently cause unexpected behavior while going undetected.
- Note that the ``_LIBCPP_CHAR_TRAITS_REMOVE_BASE_SPECIALIZATION`` macro can be defined in LLVM 18 to eagerly remove
- the specialization and prepare code bases for the unconditional removal in LLVM 19.
-
-- The ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` macro that changed the behavior for narrowing conversions
- in ``std::variant`` will be removed in LLVM 19.
-
-- The ``_LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS`` macro has been deprecated in LLVM 18 and will be removed
- entirely in LLVM 19.
-
-- The ``_LIBCPP_ENABLE_CXX17_REMOVED_FEATURES`` and
- ``_LIBCPP_ENABLE_CXX20_REMOVED_FEATURES`` macros have been deprecated
- in LLVM 18 and will be removed entirely in LLVM 19.
-
-- The macro ``_LIBCPP_INLINE_VISIBILITY`` has been deprecated in LLVM 18 and
- will be removed entirely in LLVM 19.
-
-- The macro ``_VSTD`` has been deprecated in LLVM 18 and will be removed
- entirely in LLVM 19.
-
-LLVM 20
-~~~~~~~
-
-- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable and the ``_LIBCPP_ENABLE_ASSERTIONS`` macro that were used to enable
- the safe mode will be removed.
-
-
-ABI Affecting Changes
----------------------
-
-- When the shared/static library is built with ``-fno-exceptions``, the behavior of ``operator new`` was changed
- to make it standards-conforming. In LLVM 17 and before, the throwing versions of ``operator new`` would return
- ``nullptr`` upon failure to allocate, when the shared/static library was built with exceptions disabled. This
- was non-conforming, since the throwing versions of ``operator new`` are never expected to return ``nullptr``, and
- this non-conformance could actually lead to miscompiles in subtle cases.
-
- Starting in LLVM 18, the throwing versions of ``operator new`` will abort the program when they fail to allocate
- if the shared/static library has been built with ``-fno-exceptions``. This is consistent with the behavior of all
- other potentially-throwing functions in the library, which abort the program instead of throwing when ``-fno-exceptions``
- is used.
-
- Furthermore, when the shared/static library is built with ``-fno-exceptions``, users who override the throwing
- version of ``operator new`` will now need to also override the ``std::nothrow_t`` version of ``operator new`` if
- they want to use it. Indeed, this is because there is no way to implement a conforming ``operator new(nothrow)``
- from a conforming potentially-throwing ``operator new`` when compiled with ``-fno-exceptions``. In that case, using
- ``operator new(nothrow)`` without overriding it explicitly but after overriding the throwing ``operator new`` will
- result in an error.
-
- Note that this change only impacts vendors/users that build the shared/static library themselves and pass
- ``-DLIBCXX_ENABLE_EXCEPTIONS=OFF``, which is not the default configuration. If you are using the default
- configuration of the library, the libc++ shared/static library will be built with exceptions enabled, and
- there is no change between LLVM 17 and LLVM 18, even for users who build their own code using ``-fno-exceptions``.
-
-- The symbol of a non-visible function part of ``std::system_error`` was removed.
- This is not a breaking change as the private function ``__init`` was never referenced internally outside of the dylib.
-
-- This release of libc++ added missing visibility annotations on some types in the library. Users compiling with
- ``-fvisbility=hidden`` may notice that additional type infos from libc++ are being exported from their ABI. This is
- the correct behavior in almost all cases since exporting the RTTI is required for these types to work properly with
- ``dynamic_cast``, exceptions and other mechanisms across binaries. However, if you intend to use libc++ purely as an
- internal implementation detail (i.e. you use libc++ as a static archive and never export libc++ symbols from your ABI)
- and you notice changes to your exported symbols list, then this means that you were not properly preventing libc++
- symbols from being part of your ABI.
-
-- The name mangling for instantiations of ``std::projected`` has changed in order to implement P2538R1. This technically
- results in an ABI break, however in practice we expect uses of ``std::projected`` in ABI-sensitive places to be
- extremely rare. Any error resulting from this change should result in a link-time error.
-
-- The internal alignment requirements for heap allocations inside ``std::string`` has decreased from 16 to 8. This
- saves memory since string requests fewer additional bytes than it did previously. However, this also changes the
- return value of ``std::string::max_size`` and can cause code compiled against older libc++ versions but linked at
- runtime to a new version to throw a different exception when attempting allocations that are too large
- (``std::bad_alloc`` vs ``std::length_error``).
-
-- The layout of some range adaptors that use the ``movable-box`` exposition-only type as an implementation
- detail has changed in order to fix a `bug <https://github.com/llvm/llvm-project/issues/70506>`_ which could result in
- overwriting user data following the ``movable-box``.
- This bug was caused by incorrect usage of the ``[[no_unique_address]]`` attribute inside the implementation of ``movable-box``.
- This fix affects the layout of the following views: ``take_while_view``, ``filter_view``, ``single_view``, ``drop_while_view``,
- ``repeat_view``, ``transform_view``, ``chunk_by_view``. In order to avoid silent breakage as a result of this fix, an ABI tag has been added to
- these views such that their mangled name will be different starting in this version of libc++.
- As a result, attempting to call a function that expects one of these views will fail to link until the code has been rebuilt
- against a matching version of libc++. In practice, we believe it is unusual for these views to appear at ABI boundaries so this
- should not be a major problem for most users. However it is probably worth auditing ranges-heavy code for ABI boundaries that
- would contain these views, or for types that contain these views as members and which are passed across ABI boundaries.
-
-- Some properties of libc++ may cause ODR-violations when mixing multiple libc++
- instances. To avoid these, often benign, ODR-violations the ODR-affecting
- properties are now part of the ABI tag. The ODR-affecting properties are:
-
- - library version (This was part of the ABI tag prior to LLVM 18.)
- - exceptions vs no-exceptions
- - hardening mode
-
- This should not be ABI-affecting except that libc++ will be more robust
- against different configurations of it being used in different translation
- units.
-
-- The amount of padding bytes available for use at the end of certain ``std::expected`` instantiations has changed in this
- release. This is an ABI break for any code that held a ``std::expected`` member with ``[[no_unique_address]]`` in an
- ABI-facing type. In those cases, the layout of the enclosing type will change, breaking the ABI. However, the
- ``std::expected<T, E>`` member requires a few characteristics in order to be affected by this change:
-
- - A type equivalent to ``union {T ; E}`` needs to have more than one byte of padding available.
- - The ``std::expected<T, E>`` member must have been in a situation where its padding bytes were previously reused by
- another object, which can happen in a few cases (this is probably not exhaustive):
-
- - It is a member with ``[[no_unique_address]]`` applied to it, and it is followed by another data member, or
- - It is a member with ``[[no_unique_address]]`` applied to it, and it is the last member of the user-defined type,
- and that user-defined type is used in ways that its padding bytes can be reused, or
- - It is inherited from
-
- We expect that this will not be a very frequent occurrence. However, there is unfortunately no technique we can use
- in the library to catch such misuse. Indeed, even applying an ABI tag to ``std::expected`` would not help since ABI
- tags are not propagated to containing types. As a result, if you notice very difficult to explain bugs around the
- usage of a ``std::expected``, you should consider checking whether you are hitting this ABI break. This change was
- done to fix `#70494 <https://github.com/llvm/llvm-project/issues/70494>`_ and the vendor communication is handled
- in `#70820 <https://github.com/llvm/llvm-project/issues/70820>`_.
-
-
-Build System Changes
---------------------
-
-- The ``LIBCXX_EXECUTOR`` CMake variable has been deprecated. If you are relying on this, the new replacement is
- passing ``-Dexecutor=...`` to ``llvm-lit``. Alternatively, this flag can be made persistent in the generated test
- configuration file by passing ``-DLIBCXX_TEST_PARAMS=executor=...``. This also applies to the ``LIBUWIND_EXECTOR``
- and ``LIBCXXABI_EXECUTOR`` CMake variables. LLVM 19 will completely remove support for the ``*_EXECUTOR`` variables.
-
-- ``LIBCXXABI_USE_LLVM_UNWINDER`` and ``COMPILER_RT_USE_LLVM_UNWINDER`` switched defaults from ``OFF`` to ``ON``.
- This means that by default, libc++abi and compiler-rt will link against the LLVM provided ``libunwind`` library
- instead of the system-provided unwinding library. If you are building the LLVM runtimes with the goal of shipping
- them so that they can interoperate with other system-provided libraries that might be using a different unwinding
- library (such as ``libgcc_s``), you should pass ``LIBCXXABI_USE_LLVM_UNWINDER=OFF`` and ``COMPILER_RT_USE_LLVM_UNWINDER=OFF``
- to make sure the system-provided unwinding library is used by the LLVM runtimes.
diff --git a/libcxx/docs/ReleaseNotes/19.rst b/libcxx/docs/ReleaseNotes/19.rst
index 3d79def336a87..e167d21e39f93 100644
--- a/libcxx/docs/ReleaseNotes/19.rst
+++ b/libcxx/docs/ReleaseNotes/19.rst
@@ -40,8 +40,7 @@ and C++26 features.
Experimental support for the time zone database has progressed.
-Work on the ranges support has progressed. See
-:ref:`ranges-status` for the current status.
+Work on the ranges support has progressed.
Work on the experimental C++17 Parallel STL has progressed. See
:ref:`pstl-status` for the current status.
>From 4df6708689e15acaa4003dfe47956b24fdccd6b7 Mon Sep 17 00:00:00 2001
From: Hristo Hristov <hghristov.rmm at gmail.com>
Date: Sat, 3 Aug 2024 20:50:56 +0300
Subject: [PATCH 4/4] Fixed `index.rst`
---
libcxx/docs/index.rst | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index 69a9e575cfe7c..97bf297c82b90 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -51,8 +51,7 @@ Getting Started with libc++
Status/Format
Status/Parallelism
Status/PSTL
- Status/Ranges
- Status/Spaceship
+ Status/SpecialMath
Status/Zip
More information about the libcxx-commits
mailing list