diff --git a/libcxx/docs/Helpers/ReleaseNotesTemplate.rst b/libcxx/docs/Helpers/ReleaseNotesTemplate.rst new file mode 100644 --- /dev/null +++ b/libcxx/docs/Helpers/ReleaseNotesTemplate.rst @@ -0,0 +1,61 @@ +=========================================== +Libc++ XX.YY.ZZ (In-Progress) Release Notes +=========================================== + +.. contents:: + :local: + :depth: 2 + +Written by the `Libc++ Team `_ + +.. warning:: + + These are in-progress notes for the upcoming libc++ XX.YY.ZZ release. + Release notes for previous releases can be found on + `the Download Page `_. + +Introduction +============ + +This document contains the release notes for the libc++ C++ Standard Library, +part of the LLVM Compiler Infrastructure, release XX.YY.ZZ. 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 `_. All LLVM releases may +be downloaded from the `LLVM releases web site `_. + +For more information about libc++, please see the `Libc++ Web Site +`_ or the `LLVM Web Site `_. + +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 `_. + +What's New in Libc++ XX.YY.ZZ? +============================== + + +Implemented Papers +------------------ + + +Improvements and New Features +----------------------------- + + +Deprecations and Removals +------------------------- + + +Upcoming Deprecations and Removals +---------------------------------- + + +ABI Affecting Changes +--------------------- + + +Build System Changes +-------------------- + diff --git a/libcxx/docs/ReleaseNotes.rst b/libcxx/docs/ReleaseNotes/17.rst rename from libcxx/docs/ReleaseNotes.rst rename to libcxx/docs/ReleaseNotes/17.rst diff --git a/libcxx/docs/ReleaseProcedure.rst b/libcxx/docs/ReleaseProcedure.rst --- a/libcxx/docs/ReleaseProcedure.rst +++ b/libcxx/docs/ReleaseProcedure.rst @@ -16,7 +16,7 @@ It should be finished before the Release managers start branching the new release: -* Make sure the ``libcxx/docs/ReleaseNotes.rst`` is up to date. Typically +* Make sure ``libcxx/docs/ReleaseNotes/.rst`` is up to date. Typically this file is updated when contributing patches. Still there might be some information added regarding the general improvements of larger projects. @@ -48,7 +48,8 @@ 2. Update the version number in ``libcxx/docs/conf.py`` 3. Update ``_LIBCPPABI_VERSION`` in ``libcxxabi/include/cxxabi.h`` 4. Update ``_LIBUNWIND_VERSION`` in ``libunwind/include/__libunwind_config.h`` -5. Remove the in-progress warning from ``libcxx/docs/ReleaseNotes.rst`` +5. Create a release notes file for the next release from the template +6. Point to the new release notes file from ``libcxx/docs/index.rst`` Post branching ============== diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst --- a/libcxx/docs/index.rst +++ b/libcxx/docs/index.rst @@ -34,7 +34,7 @@ .. toctree:: :maxdepth: 1 - ReleaseNotes + ReleaseNotes/17 UsingLibcxx BuildingLibcxx TestingLibcxx