1.. _ContributingToLibcxx:
2
3======================
4Contributing to libc++
5======================
6
7.. contents::
8  :local:
9
10Please read `this document <https://www.llvm.org/docs/Contributing.html>`__ on general rules to contribute to LLVM projects.
11
12Tasks and processes
13===================
14
15This file contains notes about various tasks and processes specific to libc++.
16
17Post-Release TODO
18=================
19
20After branching for an LLVM release:
21
221. Update ``_LIBCPP_VERSION`` in ``include/__config``
232. Update the ``include/__libcpp_version`` file
243. Update the version number in ``docs/conf.py``
25
26Adding a new header TODO
27========================
28
29When adding a new header to libc++:
30
311. Add a test under ``test/libcxx`` that the new header defines ``_LIBCPP_VERSION``. See ``test/libcxx/algorithms/version.pass.cpp`` for an example.
322. 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
383. Create a submodule in ``include/module.modulemap`` for the new header.
394. Update the ``include/CMakeLists.txt`` file to include the new header.
40
41Exporting new symbols from the library
42======================================
43
44When exporting new symbols from libc++, one must update the ABI lists located in ``lib/abi``.
45To test whether the lists are up-to-date, please run the target ``check-cxx-abilist``.
46To regenerate the lists, use the target ``generate-cxx-abilist``.
47