File tree Expand file tree Collapse file tree 3 files changed +47
-28
lines changed Expand file tree Collapse file tree 3 files changed +47
-28
lines changed Load Diff This file was deleted.
Original file line number Diff line number Diff line change
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 ``.
Original file line number Diff line number Diff line change @@ -38,6 +38,7 @@ Getting Started with libc++
38
38
UsingLibcxx
39
39
BuildingLibcxx
40
40
TestingLibcxx
41
+ Contributing
41
42
Cxx1yStatus
42
43
Cxx1zStatus
43
44
Cxx2aStatus
You can’t perform that action at this time.
0 commit comments