[libcxx-commits] [libcxx] [libc++][docs] Use project-local links in release notes (PR #228624)

Reid Kleckner via libcxx-commits libcxx-commits at lists.llvm.org
Fri Oct 2 17:04:09 PDT 2026


https://github.com/rnk created https://github.com/llvm/llvm-project/pull/228624

Replace absolute libc++ homepage links with Sphinx document references in
release notes 20 through 24 and the release-note template.

I would leave these historical documents alone, but I have to fix these,
or the doc build will fail with warnings when I enable the absolute
self-link Sphinx doc build warning.

Validation: docs-libcxx-html, followed by a fresh Sphinx rebuild (-E), on
a merge of the three independent self-link fixes with the checker enabled
and warnings-as-errors disabled. No self-link warnings or new warning
messages compared with the audit baseline.

Part of #214861

Assisted-by: Codex


>From 2d6d050930b1358216d01612e159c5dc05890b9c Mon Sep 17 00:00:00 2001
From: Reid Kleckner <rkleckner at nvidia.com>
Date: Fri, 2 Oct 2026 23:37:19 +0000
Subject: [PATCH] [libc++][docs] Use project-local links in release notes

Replace absolute libc++ homepage links with Sphinx document references in
release notes 20 through 24 and the release-note template.

I would leave these historical documents alone, but I have to fix these,
or the doc build will fail with warnings when I enable the absolute
self-link Sphinx doc build warning.

Validation: docs-libcxx-html, followed by a fresh Sphinx rebuild (-E), on
a merge of the three independent self-link fixes with the checker enabled
and warnings-as-errors disabled. No self-link warnings or new warning
messages compared with the audit baseline.

Part of #214861

Assisted-by: Codex
---
 libcxx/docs/Helpers/ReleaseNotesTemplate.rst | 6 +++---
 libcxx/docs/ReleaseNotes/20.rst              | 6 +++---
 libcxx/docs/ReleaseNotes/21.rst              | 6 +++---
 libcxx/docs/ReleaseNotes/22.rst              | 6 +++---
 libcxx/docs/ReleaseNotes/23.rst              | 6 +++---
 libcxx/docs/ReleaseNotes/24.rst              | 6 +++---
 6 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/libcxx/docs/Helpers/ReleaseNotesTemplate.rst b/libcxx/docs/Helpers/ReleaseNotesTemplate.rst
index 395a5378b7105..cc4468cf3cc4f 100644
--- a/libcxx/docs/Helpers/ReleaseNotesTemplate.rst
+++ b/libcxx/docs/Helpers/ReleaseNotesTemplate.rst
@@ -6,7 +6,7 @@ Libc++ XX.YY.ZZ (In-Progress) Release Notes
    :local:
    :depth: 2
 
-Written by the `Libc++ Team <https://libcxx.llvm.org>`_
+Written by the :doc:`Libc++ Team </index>`
 
 .. warning::
 
@@ -24,8 +24,8 @@ 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>`_.
+For more information about libc++, please see the :doc:`Libc++ Web Site
+</index>` 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
diff --git a/libcxx/docs/ReleaseNotes/20.rst b/libcxx/docs/ReleaseNotes/20.rst
index 572d4321dc46f..541d8048b1cd2 100644
--- a/libcxx/docs/ReleaseNotes/20.rst
+++ b/libcxx/docs/ReleaseNotes/20.rst
@@ -6,7 +6,7 @@ Libc++ 20.0.0 (In-Progress) Release Notes
    :local:
    :depth: 2
 
-Written by the `Libc++ Team <https://libcxx.llvm.org>`_
+Written by the :doc:`Libc++ Team </index>`
 
 .. warning::
 
@@ -24,8 +24,8 @@ 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>`_.
+For more information about libc++, please see the :doc:`Libc++ Web Site
+</index>` 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
diff --git a/libcxx/docs/ReleaseNotes/21.rst b/libcxx/docs/ReleaseNotes/21.rst
index 2b1aa28b62090..716971e546982 100644
--- a/libcxx/docs/ReleaseNotes/21.rst
+++ b/libcxx/docs/ReleaseNotes/21.rst
@@ -6,7 +6,7 @@ Libc++ 21.0.0 (In-Progress) Release Notes
    :local:
    :depth: 2
 
-Written by the `Libc++ Team <https://libcxx.llvm.org>`_
+Written by the :doc:`Libc++ Team </index>`
 
 .. warning::
 
@@ -24,8 +24,8 @@ 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>`_.
+For more information about libc++, please see the :doc:`Libc++ Web Site
+</index>` 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
diff --git a/libcxx/docs/ReleaseNotes/22.rst b/libcxx/docs/ReleaseNotes/22.rst
index 9f9927095a61f..9b1b91acca187 100644
--- a/libcxx/docs/ReleaseNotes/22.rst
+++ b/libcxx/docs/ReleaseNotes/22.rst
@@ -6,7 +6,7 @@ Libc++ 22.0.0 (In-Progress) Release Notes
    :local:
    :depth: 2
 
-Written by the `Libc++ Team <https://libcxx.llvm.org>`_
+Written by the :doc:`Libc++ Team </index>`
 
 .. warning::
 
@@ -24,8 +24,8 @@ 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>`_.
+For more information about libc++, please see the :doc:`Libc++ Web Site
+</index>` 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
diff --git a/libcxx/docs/ReleaseNotes/23.rst b/libcxx/docs/ReleaseNotes/23.rst
index f7a8e5b04f1ea..f06cf7d4fd6e8 100644
--- a/libcxx/docs/ReleaseNotes/23.rst
+++ b/libcxx/docs/ReleaseNotes/23.rst
@@ -6,7 +6,7 @@ Libc++ 23.0.0 (In-Progress) Release Notes
    :local:
    :depth: 2
 
-Written by the `Libc++ Team <https://libcxx.llvm.org>`_
+Written by the :doc:`Libc++ Team </index>`
 
 .. warning::
 
@@ -24,8 +24,8 @@ 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>`_.
+For more information about libc++, please see the :doc:`Libc++ Web Site
+</index>` 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
diff --git a/libcxx/docs/ReleaseNotes/24.rst b/libcxx/docs/ReleaseNotes/24.rst
index 38d31eea96e4c..bd7919e66c5b9 100644
--- a/libcxx/docs/ReleaseNotes/24.rst
+++ b/libcxx/docs/ReleaseNotes/24.rst
@@ -6,7 +6,7 @@ Libc++ 24.0.0 Release Notes
    :local:
    :depth: 2
 
-Written by the `Libc++ Team <https://libcxx.llvm.org>`_
+Written by the :doc:`Libc++ Team </index>`
 
 .. warning::
 
@@ -24,8 +24,8 @@ 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>`_.
+For more information about libc++, please see the :doc:`Libc++ Web Site
+</index>` 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



More information about the libcxx-commits mailing list