[libcxx-commits] [libcxx] [libc++] Add base for LLVM 19 release notes (PR #78990)

Thu Jan 25 10:34:11 PST 2024

https://github.com/ldionne updated https://github.com/llvm/llvm-project/pull/78990

>From 7c0f0b7c35d39a74cf1f5f40c5eb66d0e5801694 Mon Sep 17 00:00:00 2001
From: Louis Dionne <ldionne.2 at gmail.com>
Date: Mon, 22 Jan 2024 09:57:17 -0500
Subject: [PATCH 1/4] [libc++] Add base for LLVM 19 release notes

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.
---
 libcxx/docs/ReleaseNotes/19.rst | 76 +++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 libcxx/docs/ReleaseNotes/19.rst

diff --git a/libcxx/docs/ReleaseNotes/19.rst b/libcxx/docs/ReleaseNotes/19.rst
new file mode 100644
index 00000000000000..440f6a894988b4
--- /dev/null
+++ b/libcxx/docs/ReleaseNotes/19.rst
@@ -0,0 +1,76 @@
+===========================================
+Libc++ 19.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++ 19.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 19.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++ 19.0.0?
+==============================
+
+TODO
+
+
+Implemented Papers
+------------------
+TODO
+
+
+Improvements and New Features
+-----------------------------
+TODO
+
+
+Deprecations and Removals
+-------------------------
+TODO
+
+
+Upcoming Deprecations and Removals
+----------------------------------
+
+LLVM 20
+~~~~~~~
+TODO
+
+LLVM 21
+~~~~~~~
+TODO
+
+
+ABI Affecting Changes
+---------------------
+TODO
+
+
+Build System Changes
+--------------------
+
+TODO

>From ecda122d5bee052d3d5671c0e4329b8d00d84ede Mon Sep 17 00:00:00 2001
From: Louis Dionne <ldionne.2 at gmail.com>
Date: Thu, 25 Jan 2024 13:15:00 -0500
Subject: [PATCH 2/4] Reference the right release notes from the main
 ReleaseNotes page

---
 libcxx/docs/ReleaseNotes.rst | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/libcxx/docs/ReleaseNotes.rst b/libcxx/docs/ReleaseNotes.rst
index 5c2c6114beb564..962c90c094968a 100644
--- a/libcxx/docs/ReleaseNotes.rst
+++ b/libcxx/docs/ReleaseNotes.rst
@@ -1,4 +1,10 @@
-.. include:: ReleaseNotes/18.rst
+.. include:: ReleaseNotes/19.rst
+
+.. Make sure to reference the 18 release notes in a toctree to avoid Sphinx errors.
+.. toctree::
+    :hidden:
+
+    ReleaseNotes/18
 
 .. The release notes are in versioned files, but we make sure to keep publishing
 .. them in an unversioned ReleaseNotes.html page for external sites to reference.

>From 68c2e834e5838c0834a896e7b4be1a965478ca87 Mon Sep 17 00:00:00 2001
From: Louis Dionne <ldionne.2 at gmail.com>
Date: Thu, 25 Jan 2024 13:32:50 -0500
Subject: [PATCH 3/4] Move upcoming deprecations and removals from the LLVM 18
 notes

---
 libcxx/docs/ReleaseNotes/19.rst | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/libcxx/docs/ReleaseNotes/19.rst b/libcxx/docs/ReleaseNotes/19.rst
index 440f6a894988b4..e081bc26d08097 100644
--- a/libcxx/docs/ReleaseNotes/19.rst
+++ b/libcxx/docs/ReleaseNotes/19.rst
@@ -50,7 +50,32 @@ TODO
 
 Deprecations and Removals
 -------------------------
-TODO
+
+- TODO: The ``LIBCXX_EXECUTOR`` CMake variables have been removed.
+
+- TODO: The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable that was used to enable the safe mode has been deprecated and setting
+  it triggers an error; use the ``LIBCXX_HARDENING_MODE`` CMake variable with the value ``extensive`` instead. Similarly,
+  the ``_LIBCPP_ENABLE_ASSERTIONS`` macro has been 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.
+
+- TODO: The base template for ``std::char_traits`` has been 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. 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.
+
+- TODO: The ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` macro that changed the behavior for narrowing conversions
+  in ``std::variant`` has been removed in LLVM 19.
+
+- TODO: The ``_LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS`` macro has been removed in LLVM 19.
+
+- TODO: The ``_LIBCPP_ENABLE_CXX17_REMOVED_FEATURES`` and ``_LIBCPP_ENABLE_CXX20_REMOVED_FEATURES`` macros have
+  been removed in LLVM 19. C++17 and C++20 removed features can still be re-enabled individually.
+
+- TODO: The macro ``_LIBCPP_INLINE_VISIBILITY`` has been removed in LLVM 19.
+
+- TODO: The macro ``_VSTD`` has been removed in LLVM 19.
 
 
 Upcoming Deprecations and Removals
@@ -58,7 +83,9 @@ Upcoming Deprecations and Removals
 
 LLVM 20
 ~~~~~~~
-TODO
+
+- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable and the ``_LIBCPP_ENABLE_ASSERTIONS`` macro that were used to enable
+  the safe mode will be removed in LLVM 20.
 
 LLVM 21
 ~~~~~~~

>From 8f0655dee042136e92dddf40f32c58c42f14636b Mon Sep 17 00:00:00 2001
From: Louis Dionne <ldionne.2 at gmail.com>
Date: Thu, 25 Jan 2024 13:33:59 -0500
Subject: [PATCH 4/4] Fix comment

---
 libcxx/docs/ReleaseNotes.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/libcxx/docs/ReleaseNotes.rst b/libcxx/docs/ReleaseNotes.rst
index 962c90c094968a..d25f2d06a56f3d 100644
--- a/libcxx/docs/ReleaseNotes.rst
+++ b/libcxx/docs/ReleaseNotes.rst
@@ -1,6 +1,6 @@
 .. include:: ReleaseNotes/19.rst
 
-.. Make sure to reference the 18 release notes in a toctree to avoid Sphinx errors.
+.. Make sure to reference the previous release notes in a toctree to avoid Sphinx errors.
 .. toctree::
     :hidden:
 

