[libcxx-commits] [PATCH] D99290: [libc++] Update contributor documentation.

[Mark de Wever via Phabricator via libcxx-commits]

Mordante updated this revision to Diff 335140.
Mordante added a comment.

- Remove the documentation future-test script documentation. It's moved to the script in D99615 <https://reviews.llvm.org/D99615>.
- Replaced `one` with `you`.
- Addresses the review comments.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D99290/new/

https://reviews.llvm.org/D99290

Files:
  libcxx/docs/Contributing.rst


Index: libcxx/docs/Contributing.rst
===================================================================
--- libcxx/docs/Contributing.rst
+++ libcxx/docs/Contributing.rst
@@ -33,11 +33,16 @@
 2. Update the ``include/__libcpp_version`` file
 3. Update the version number in ``docs/conf.py``
 
-Modifying feature test macros
+Modifying feature-test macros
 =============================
 
-When adding or updating feature test macros, you should update the corresponding tests.
-To do that, modify ``feature_test_macros`` table in the script ``utils/generate_feature_test_macro_components.py``, run it, and commit updated files.
+When adding or updating feature-test macros, you should update the corresponding tests.
+To do that, modify ``feature_test_macros`` table in the script
+``utils/generate_feature_test_macro_components.py``, run it, and commit updated
+files. Running ``utils/generate_feature_test_macro_components.py`` should never
+generate diffs in a clean checkout; feel free to run it in your local checkout
+any time you want.
+
 
 Adding a new header TODO
 ========================
@@ -52,6 +57,15 @@
 Exporting new symbols from the library
 ======================================
 
-When exporting new symbols from libc++, one must update the ABI lists located in ``lib/abi``.
+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++20 for the Linux platform.
+* MacOS C++20 for the Apple platform.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D99290.335140.patch
Type: text/x-patch
Size: 1994 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libcxx-commits/attachments/20210404/2d493e95/attachment.bin>