[libcxx-commits] [libcxx] [libcxx][docs] Update "Exporting new symbols" for the move to GitHub CI (PR #222533)

[via libcxx-commits]

llvmorg-github-actions[bot] wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-libcxx

Author: Cyrus Ding (dingcyrus)

<details>
<summary>Changes</summary>

The instructions for downloading regenerated ABI lists pointed exclusively at Buildkite and used artifact names that no longer exist. The Linux (x86-64) and Apple abilist checks now run on GitHub as part of the "[libc++] Conformance tests" workflow, which regenerates the lists on failure and uploads them as job artifacts. Buildkite only retains the AIX, Android, ARM and FreeBSD builders.

Update the section to explain where to download the regenerated lists from GitHub, use the actual artifact and abilist file names as examples, and note that the macOS jobs run on Apple silicon runners, so only the arm64 Apple list can be obtained from CI.

Fixes #<!-- -->222279

---
Full diff: https://github.com/llvm/llvm-project/pull/222533.diff


1 Files Affected:

- (modified) libcxx/docs/Contributing.rst (+25-9) 


``````````diff
diff --git a/libcxx/docs/Contributing.rst b/libcxx/docs/Contributing.rst
index 11f803b75b837..a5503390190f5 100644
--- a/libcxx/docs/Contributing.rst
+++ b/libcxx/docs/Contributing.rst
@@ -163,15 +163,31 @@ Exporting new symbols from the library
 When exporting new symbols from libc++, you must update the ABI lists located in ``lib/abi``.
 To test whether the lists are up-to-date, please run the target ``check-cxx-abilist``.
 To regenerate the lists, use the target ``generate-cxx-abilist``.
-The ABI lists must be updated for all supported platforms; currently Linux and
-Apple.  If you don't have access to one of these platforms, you can download an
-updated list from the failed build at
-`Buildkite <https://buildkite.com/llvm-project/libcxx-ci>`__.
-Look for the failed build and select the ``artifacts`` tab. There, download the
-abilist for the platform, e.g.:
-
-* C++<version>.
-* macOS X86_64 and macOS arm64 for the Apple platform.
+The ABI lists must be updated for all supported platforms. If you don't have
+access to one of these platforms, you can download an updated list from the
+failed CI build: when the ABI list check fails, CI regenerates the list and
+uploads it together with the other build artifacts.
+
+For Linux (x86-64) and the Apple platforms, the checks run on GitHub as part of
+the ``[libc++] Conformance tests`` workflow. From your pull request, open the
+failed workflow run, select the failed job, and download its artifact from the
+``Artifacts`` section (you must be logged into GitHub to download artifacts).
+The artifact is named after the job that produced it (e.g.
+``generic-cxx23-clang++-23-results`` or ``macos-generic-cxx23-results``) and
+contains the regenerated ``.abilist`` files. Those files are named after the
+configuration they were generated for, e.g.:
+
+* ``x86_64-unknown-linux-gnu.libcxxabi.v1.stable.exceptions.nonew.abilist``
+  for Linux with exceptions enabled (from the ``generic-cxx<version>`` jobs).
+* ``x86_64-unknown-linux-gnu.libcxxabi.v1.stable.noexceptions.nonew.abilist``
+  for Linux with exceptions disabled (from the ``generic-no-exceptions`` job).
+* ``arm64-apple-darwin.libcxxabi.v1.stable.exceptions.nonew.abilist`` for
+  Apple silicon (from the ``macos`` jobs, which run on Apple silicon runners).
+
+For the other platforms (such as AIX, Android and FreeBSD), the checks
+still run on `Buildkite <https://buildkite.com/llvm-project/libcxx-ci>`__.
+Look for the failed build and select the ``Artifacts`` tab. There, download the
+abilist for the platform.
 
 
 Pre-commit CI

``````````

</details>


https://github.com/llvm/llvm-project/pull/222533