[libcxx-commits] [libcxx] [libcxx] Update testing documentation about CI container images. (PR #149192)

[via libcxx-commits]

https://github.com/cmtice updated https://github.com/llvm/llvm-project/pull/149192

>From a15e371d74248aae2e422eee4c3b794673894616 Mon Sep 17 00:00:00 2001
From: Caroline Tice <cmtice at google.com>
Date: Wed, 16 Jul 2025 14:41:51 -0700
Subject: [PATCH 1/4] [libcxx] Update testing documentation about CI container
 images.

Add information to the libcxx testing documentation, about the names
of the for the new CI libcxx runner sets, their current values, and
how to change the values or the runner set being used.
---
 libcxx/docs/TestingLibcxx.rst | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/libcxx/docs/TestingLibcxx.rst b/libcxx/docs/TestingLibcxx.rst
index 56cf4aca236f9..2be6739e6f4a6 100644
--- a/libcxx/docs/TestingLibcxx.rst
+++ b/libcxx/docs/TestingLibcxx.rst
@@ -139,6 +139,37 @@ Also note that the Docker container shares the same filesystem as your local mac
 modifying files on your local machine will also modify what the Docker container sees.
 This is useful for editing source files as you're testing your code in the Docker container.
 
+Updating the CI testing container images
+----------------------------------------
+
+The libcxx linux premerge testing can run on one of three sets of
+runner groups. The three runner group names are
+"llvm-permerge-libcxx-runners", "llvm-premerge-libcxx-release-runners"
+or "llvm-premerge-libcxx-next-runners".  Which one of these sets is
+used, is controled by the contents of https://github.com/llvm/llvm-project/blob/main/.github/workflows/libcxx-build-and-test.yaml . By default, it
+uses "llvm-premerge-libcxx-runners".
+
+Which container image is used by these three runner sets is controlled
+and set by the variable values in
+https://github.com/llvm/llvm-zorg/blob/main/premerge/premerge_resources/variables.tf
+. The table below shows the variable names, their current values, and
+the runner sets to which they correspond.
+
+|Runner Set|Variable|Image Value|
++==========+========+===========+
+|llvm-premerge-libcxx-runners|libcxx_runner_image|ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
+|llvm-premerge-libcxx-release-runners|libcxx_release_runner_image|ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
+|llvm-premerge-libcxx-next-runners|libcxx_next_runner_image|ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
+
+Note: The three runner images are (temporarily) all the same, but that
+will not normally be the case.
+
+To change the container image, the variable.tf file in llvm-zorg must
+be changed. Once that change has been merged, an llvm-zorg
+administrator must use terraform to apply the change to the running
+GKE cluster.
+
+
 Writing Tests
 =============
 

>From 757baec2b2952caa3f5e8da092a9a5ff305811a6 Mon Sep 17 00:00:00 2001
From: Caroline Tice <cmtice at google.com>
Date: Wed, 16 Jul 2025 14:54:18 -0700
Subject: [PATCH 2/4] Fix table format.

---
 libcxx/docs/TestingLibcxx.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/libcxx/docs/TestingLibcxx.rst b/libcxx/docs/TestingLibcxx.rst
index 2be6739e6f4a6..b944889614b51 100644
--- a/libcxx/docs/TestingLibcxx.rst
+++ b/libcxx/docs/TestingLibcxx.rst
@@ -155,11 +155,13 @@ https://github.com/llvm/llvm-zorg/blob/main/premerge/premerge_resources/variable
 . The table below shows the variable names, their current values, and
 the runner sets to which they correspond.
 
-|Runner Set|Variable|Image Value|
-+==========+========+===========+
-|llvm-premerge-libcxx-runners|libcxx_runner_image|ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
++------------------------------------+---------------------------+--------------------------------------------------------------------------+
+|Runner Set                          |Variable                   |Image Value                                                               |
++====================================+===========================+==========================================================================+
+|llvm-premerge-libcxx-runners        |libcxx_runner_image        |ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
 |llvm-premerge-libcxx-release-runners|libcxx_release_runner_image|ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
-|llvm-premerge-libcxx-next-runners|libcxx_next_runner_image|ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
+|llvm-premerge-libcxx-next-runners   |libcxx_next_runner_image   |ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
++------------------------------------+---------------------------+--------------------------------------------------------------------------+
 
 Note: The three runner images are (temporarily) all the same, but that
 will not normally be the case.

>From 18f213fa4cc423e99fddfa64fa7862abaaf09bfd Mon Sep 17 00:00:00 2001
From: Caroline Tice <cmtice at google.com>
Date: Wed, 16 Jul 2025 14:57:13 -0700
Subject: [PATCH 3/4] More table format fixes.

---
 libcxx/docs/TestingLibcxx.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/libcxx/docs/TestingLibcxx.rst b/libcxx/docs/TestingLibcxx.rst
index b944889614b51..1ef2be81fdea5 100644
--- a/libcxx/docs/TestingLibcxx.rst
+++ b/libcxx/docs/TestingLibcxx.rst
@@ -159,7 +159,9 @@ the runner sets to which they correspond.
 |Runner Set                          |Variable                   |Image Value                                                               |
 +====================================+===========================+==========================================================================+
 |llvm-premerge-libcxx-runners        |libcxx_runner_image        |ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
++------------------------------------+---------------------------+--------------------------------------------------------------------------+
 |llvm-premerge-libcxx-release-runners|libcxx_release_runner_image|ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
++------------------------------------+---------------------------+--------------------------------------------------------------------------+
 |llvm-premerge-libcxx-next-runners   |libcxx_next_runner_image   |ghcr.io/llvm/libcxx-linux-builder:16f046281bf1a11d344eac1bc44d11f3e50e3b5d|
 +------------------------------------+---------------------------+--------------------------------------------------------------------------+
 

>From bf0596a473cd82ae40d6679e5081e867ef8f259e Mon Sep 17 00:00:00 2001
From: Caroline Tice <cmtice at google.com>
Date: Wed, 16 Jul 2025 15:02:55 -0700
Subject: [PATCH 4/4] Fix typos and other wording issues.

---
 libcxx/docs/TestingLibcxx.rst | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/libcxx/docs/TestingLibcxx.rst b/libcxx/docs/TestingLibcxx.rst
index 1ef2be81fdea5..d278e18093e87 100644
--- a/libcxx/docs/TestingLibcxx.rst
+++ b/libcxx/docs/TestingLibcxx.rst
@@ -144,15 +144,17 @@ Updating the CI testing container images
 
 The libcxx linux premerge testing can run on one of three sets of
 runner groups. The three runner group names are
-"llvm-permerge-libcxx-runners", "llvm-premerge-libcxx-release-runners"
-or "llvm-premerge-libcxx-next-runners".  Which one of these sets is
-used, is controled by the contents of https://github.com/llvm/llvm-project/blob/main/.github/workflows/libcxx-build-and-test.yaml . By default, it
-uses "llvm-premerge-libcxx-runners".
+"llvm-premerge-libcxx-runners", "llvm-premerge-libcxx-release-runners"
+or "llvm-premerge-libcxx-next-runners".  Which runner set to use is
+controlled by the contents of https://github.com/llvm/llvm-project/blob/main/.github/workflows/libcxx-build-and-test.yaml . By default, it uses
+"llvm-premerge-libcxx-runners". To switch to one of the other runner
+sets, just replace all uses of "llvm-premerge-libcxx-runners" in the yaml
+file with the desired runner set.
 
 Which container image is used by these three runner sets is controlled
 and set by the variable values in
-https://github.com/llvm/llvm-zorg/blob/main/premerge/premerge_resources/variables.tf
-. The table below shows the variable names, their current values, and
+https://github.com/llvm/llvm-zorg/blob/main/premerge/premerge_resources/variables.tf.
+The table below shows the variable names, their current values, and
 the runner sets to which they correspond.
 
 +------------------------------------+---------------------------+--------------------------------------------------------------------------+