xref: /llvm-project/libcxx/docs/Helpers/ReleaseNotesTemplate.rst (revision b88db47bd2085c2c8a246751feb63a3ac20a3665)
1*b88db47bSLouis Dionne===========================================
2*b88db47bSLouis DionneLibc++ XX.YY.ZZ (In-Progress) Release Notes
3*b88db47bSLouis Dionne===========================================
4*b88db47bSLouis Dionne
5*b88db47bSLouis Dionne.. contents::
6*b88db47bSLouis Dionne   :local:
7*b88db47bSLouis Dionne   :depth: 2
8*b88db47bSLouis Dionne
9*b88db47bSLouis DionneWritten by the `Libc++ Team <https://libcxx.llvm.org>`_
10*b88db47bSLouis Dionne
11*b88db47bSLouis Dionne.. warning::
12*b88db47bSLouis Dionne
13*b88db47bSLouis Dionne   These are in-progress notes for the upcoming libc++ XX.YY.ZZ release.
14*b88db47bSLouis Dionne   Release notes for previous releases can be found on
15*b88db47bSLouis Dionne   `the Download Page <https://releases.llvm.org/download.html>`_.
16*b88db47bSLouis Dionne
17*b88db47bSLouis DionneIntroduction
18*b88db47bSLouis Dionne============
19*b88db47bSLouis Dionne
20*b88db47bSLouis DionneThis document contains the release notes for the libc++ C++ Standard Library,
21*b88db47bSLouis Dionnepart of the LLVM Compiler Infrastructure, release XX.YY.ZZ. Here we describe the
22*b88db47bSLouis Dionnestatus of libc++ in some detail, including major improvements from the previous
23*b88db47bSLouis Dionnerelease and new feature work. For the general LLVM release notes, see `the LLVM
24*b88db47bSLouis Dionnedocumentation <https://llvm.org/docs/ReleaseNotes.html>`_. All LLVM releases may
25*b88db47bSLouis Dionnebe downloaded from the `LLVM releases web site <https://llvm.org/releases/>`_.
26*b88db47bSLouis Dionne
27*b88db47bSLouis DionneFor more information about libc++, please see the `Libc++ Web Site
28*b88db47bSLouis Dionne<https://libcxx.llvm.org>`_ or the `LLVM Web Site <https://llvm.org>`_.
29*b88db47bSLouis Dionne
30*b88db47bSLouis DionneNote that if you are reading this file from a Git checkout or the
31*b88db47bSLouis Dionnemain Libc++ web page, this document applies to the *next* release, not
32*b88db47bSLouis Dionnethe current one. To see the release notes for a specific release, please
33*b88db47bSLouis Dionnesee the `releases page <https://llvm.org/releases/>`_.
34*b88db47bSLouis Dionne
35*b88db47bSLouis DionneWhat's New in Libc++ XX.YY.ZZ?
36*b88db47bSLouis Dionne==============================
37*b88db47bSLouis Dionne
38*b88db47bSLouis Dionne
39*b88db47bSLouis DionneImplemented Papers
40*b88db47bSLouis Dionne------------------
41*b88db47bSLouis Dionne
42*b88db47bSLouis Dionne
43*b88db47bSLouis DionneImprovements and New Features
44*b88db47bSLouis Dionne-----------------------------
45*b88db47bSLouis Dionne
46*b88db47bSLouis Dionne
47*b88db47bSLouis DionneDeprecations and Removals
48*b88db47bSLouis Dionne-------------------------
49*b88db47bSLouis Dionne
50*b88db47bSLouis Dionne
51*b88db47bSLouis DionneUpcoming Deprecations and Removals
52*b88db47bSLouis Dionne----------------------------------
53*b88db47bSLouis Dionne
54*b88db47bSLouis DionneNOTE: THIS SHOULD BE POPULATED FROM THE PREVIOUS RELEASE'S UPCOMING DEPRECATIONS AND REMOVALS FOR THE NEXT-NEXT RELEASE (IF ANY)
55*b88db47bSLouis Dionne
56*b88db47bSLouis DionneABI Affecting Changes
57*b88db47bSLouis Dionne---------------------
58*b88db47bSLouis Dionne
59*b88db47bSLouis Dionne
60*b88db47bSLouis DionneBuild System Changes
61*b88db47bSLouis Dionne--------------------
62*b88db47bSLouis Dionne
63