[libcxx-commits] [libcxx] 90af11e - [libc++] Make sure to publish release notes at ReleaseNotes.html

Louis Dionne via libcxx-commits libcxx-commits at lists.llvm.org
Mon Jan 22 06:39:23 PST 2024


Author: Louis Dionne
Date: 2024-01-22T09:39:16-05:00
New Revision: 90af11ea97cf9ab34677720c5b7848eb5e9d4efe

URL: https://github.com/llvm/llvm-project/commit/90af11ea97cf9ab34677720c5b7848eb5e9d4efe
DIFF: https://github.com/llvm/llvm-project/commit/90af11ea97cf9ab34677720c5b7848eb5e9d4efe.diff

LOG: [libc++] Make sure to publish release notes at ReleaseNotes.html

In LLVM 17, we switched to numbered RST files for release notes, which
makes it easier to deal with cherry-picks around release points. However,
we stopped publishing `libcxx/docs/ReleaseNotes.html`, which was
referenced by external sites.

This patch ensures that we keep publishing `ReleaseNotes.html` by simply
including the versioned RST file in the unversioned RST file.

Fixes #77955

Added: 
    libcxx/docs/ReleaseNotes.rst

Modified: 
    libcxx/docs/index.rst

Removed: 
    


################################################################################
diff  --git a/libcxx/docs/ReleaseNotes.rst b/libcxx/docs/ReleaseNotes.rst
new file mode 100644
index 000000000000000..5c2c6114beb5647
--- /dev/null
+++ b/libcxx/docs/ReleaseNotes.rst
@@ -0,0 +1,4 @@
+.. include:: ReleaseNotes/18.rst
+
+.. 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.

diff  --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index 066d8d87e5526e6..ab7472071ebb913 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -34,7 +34,7 @@ Getting Started with libc++
 .. toctree::
    :maxdepth: 1
 
-   ReleaseNotes/18
+   ReleaseNotes
    UsingLibcxx
    BuildingLibcxx
    TestingLibcxx


        


More information about the libcxx-commits mailing list