Skip to content

Commit 1c656e9

Browse files
committed
[libc++] [docs] Update and move NOTES.txt to docs/Contributing.rst.
Also, add notes about exporting ABI symbols. Later, we can add notes about using git-clang-format before sending a patch for review. Reviewed By: ldionne, #libc Differential Revision: https://reviews.llvm.org/D92300
1 parent 9126ba2 commit 1c656e9

File tree

3 files changed

+47
-28
lines changed

3 files changed

+47
-28
lines changed

libcxx/NOTES.TXT

Lines changed: 0 additions & 28 deletions
This file was deleted.

libcxx/docs/Contributing.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _ContributingToLibcxx:
2+
3+
======================
4+
Contributing to libc++
5+
======================
6+
7+
.. contents::
8+
:local:
9+
10+
Please read `this document <https://www.llvm.org/docs/Contributing.html>`__ on general rules to contribute to LLVM projects.
11+
12+
Tasks and processes
13+
===================
14+
15+
This file contains notes about various tasks and processes specific to libc++.
16+
17+
Post-Release TODO
18+
=================
19+
20+
After branching for an LLVM release:
21+
22+
1. Update ``_LIBCPP_VERSION`` in ``include/__config``
23+
2. Update the ``include/__libcpp_version`` file
24+
3. Update the version number in ``docs/conf.py``
25+
26+
Adding a new header TODO
27+
========================
28+
29+
When adding a new header to libc++:
30+
31+
1. Add a test under ``test/libcxx`` that the new header defines ``_LIBCPP_VERSION``. See ``test/libcxx/algorithms/version.pass.cpp`` for an example.
32+
2. Update the following test files to include the new header:
33+
34+
* ``test/libcxx/double_include.sh.cpp``
35+
* ``test/libcxx/min_max_macros.compile.pass.cpp``
36+
* ``test/libcxx/no_assert_include.compile.pass.cpp``
37+
38+
3. Create a submodule in ``include/module.modulemap`` for the new header.
39+
4. Update the ``include/CMakeLists.txt`` file to include the new header.
40+
41+
Exporting new symbols from the library
42+
======================================
43+
44+
When exporting new symbols from libc++, one must update the ABI lists located in ``lib/abi``.
45+
To test whether the lists are up-to-date, please run the target ``check-cxx-abilist``.
46+
To regenerate the lists, use the target ``generate-cxx-abilist``.

libcxx/docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Getting Started with libc++
3838
UsingLibcxx
3939
BuildingLibcxx
4040
TestingLibcxx
41+
Contributing
4142
Cxx1yStatus
4243
Cxx1zStatus
4344
Cxx2aStatus

0 commit comments

Comments
 (0)