Skip to content

Commit 2550ce4

Browse files
authored
[libc++] Add base for LLVM 19 release notes (#78990)
This will make it easier for folks who have patches that are not targeting LLVM 18 -- they can write the release notes in the LLVM 19 release notes immediately.
1 parent eb678d8 commit 2550ce4

File tree

2 files changed

+110
-1
lines changed

2 files changed

+110
-1
lines changed

libcxx/docs/ReleaseNotes.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
.. include:: ReleaseNotes/18.rst
1+
.. include:: ReleaseNotes/19.rst
2+
3+
.. Make sure to reference the previous release notes in a toctree to avoid Sphinx errors.
4+
.. toctree::
5+
:hidden:
6+
7+
ReleaseNotes/18
28

39
.. The release notes are in versioned files, but we make sure to keep publishing
410
.. them in an unversioned ReleaseNotes.html page for external sites to reference.

libcxx/docs/ReleaseNotes/19.rst

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
===========================================
2+
Libc++ 19.0.0 (In-Progress) Release Notes
3+
===========================================
4+
5+
.. contents::
6+
:local:
7+
:depth: 2
8+
9+
Written by the `Libc++ Team <https://libcxx.llvm.org>`_
10+
11+
.. warning::
12+
13+
These are in-progress notes for the upcoming libc++ 19.0.0 release.
14+
Release notes for previous releases can be found on
15+
`the Download Page <https://releases.llvm.org/download.html>`_.
16+
17+
Introduction
18+
============
19+
20+
This document contains the release notes for the libc++ C++ Standard Library,
21+
part of the LLVM Compiler Infrastructure, release 19.0.0. Here we describe the
22+
status of libc++ in some detail, including major improvements from the previous
23+
release and new feature work. For the general LLVM release notes, see `the LLVM
24+
documentation <https://llvm.org/docs/ReleaseNotes.html>`_. All LLVM releases may
25+
be downloaded from the `LLVM releases web site <https://llvm.org/releases/>`_.
26+
27+
For more information about libc++, please see the `Libc++ Web Site
28+
<https://libcxx.llvm.org>`_ or the `LLVM Web Site <https://llvm.org>`_.
29+
30+
Note that if you are reading this file from a Git checkout or the
31+
main Libc++ web page, this document applies to the *next* release, not
32+
the current one. To see the release notes for a specific release, please
33+
see the `releases page <https://llvm.org/releases/>`_.
34+
35+
What's New in Libc++ 19.0.0?
36+
==============================
37+
38+
TODO
39+
40+
41+
Implemented Papers
42+
------------------
43+
TODO
44+
45+
46+
Improvements and New Features
47+
-----------------------------
48+
TODO
49+
50+
51+
Deprecations and Removals
52+
-------------------------
53+
54+
- TODO: The ``LIBCXX_EXECUTOR`` CMake variables have been removed.
55+
56+
- TODO: The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable that was used to enable the safe mode has been deprecated and setting
57+
it triggers an error; use the ``LIBCXX_HARDENING_MODE`` CMake variable with the value ``extensive`` instead. Similarly,
58+
the ``_LIBCPP_ENABLE_ASSERTIONS`` macro has been deprecated (setting it to ``1`` still enables the extensive mode in
59+
the LLVM 19 release while also issuing a deprecation warning). See :ref:`the hardening documentation
60+
<using-hardening-modes>` for more details.
61+
62+
- TODO: The base template for ``std::char_traits`` has been removed in LLVM 19. If you are using ``std::char_traits`` with
63+
types other than ``char``, ``wchar_t``, ``char8_t``, ``char16_t``, ``char32_t`` or a custom character type for which you
64+
specialized ``std::char_traits``, your code will stop working. The Standard does not mandate that a base template is
65+
provided, and such a base template is bound to be incorrect for some types, which could currently cause unexpected behavior
66+
while going undetected.
67+
68+
- TODO: The ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` macro that changed the behavior for narrowing conversions
69+
in ``std::variant`` has been removed in LLVM 19.
70+
71+
- TODO: The ``_LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS`` macro has been removed in LLVM 19.
72+
73+
- TODO: The ``_LIBCPP_ENABLE_CXX17_REMOVED_FEATURES`` and ``_LIBCPP_ENABLE_CXX20_REMOVED_FEATURES`` macros have
74+
been removed in LLVM 19. C++17 and C++20 removed features can still be re-enabled individually.
75+
76+
- TODO: The macro ``_LIBCPP_INLINE_VISIBILITY`` has been removed in LLVM 19.
77+
78+
- TODO: The macro ``_VSTD`` has been removed in LLVM 19.
79+
80+
81+
Upcoming Deprecations and Removals
82+
----------------------------------
83+
84+
LLVM 20
85+
~~~~~~~
86+
87+
- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable and the ``_LIBCPP_ENABLE_ASSERTIONS`` macro that were used to enable
88+
the safe mode will be removed in LLVM 20.
89+
90+
LLVM 21
91+
~~~~~~~
92+
TODO
93+
94+
95+
ABI Affecting Changes
96+
---------------------
97+
TODO
98+
99+
100+
Build System Changes
101+
--------------------
102+
103+
TODO

0 commit comments

Comments
 (0)