[llvm-branch-commits] [libcxx] 1c656e9 - [libc++] [docs] Update and move NOTES.txt to docs/Contributing.rst.

[Marek Kurdej via llvm-branch-commits]

Author: Marek Kurdej
Date: 2020-12-02T08:54:11+01:00
New Revision: 1c656e9b64413535bb55259e03f2bc458c69e0de

URL: https://github.com/llvm/llvm-project/commit/1c656e9b64413535bb55259e03f2bc458c69e0de
DIFF: https://github.com/llvm/llvm-project/commit/1c656e9b64413535bb55259e03f2bc458c69e0de.diff

LOG: [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

Added: 
    libcxx/docs/Contributing.rst

Modified: 
    libcxx/docs/index.rst

Removed: 
    libcxx/NOTES.TXT


################################################################################
diff  --git a/libcxx/NOTES.TXT b/libcxx/NOTES.TXT
deleted file mode 100644
index 16366a580f18..000000000000
--- a/libcxx/NOTES.TXT
+++ /dev/null
@@ -1,28 +0,0 @@
-//===---------------------------------------------------------------------===//
-// Notes relating to various libc++ tasks
-//===---------------------------------------------------------------------===//
-
-This file contains notes about various libc++ tasks and processes.
-
-//===---------------------------------------------------------------------===//
-// Post-Release TODO
-//===---------------------------------------------------------------------===//
-
-These notes contain a list of things that must be done after branching for
-an LLVM release.
-
-1. Update _LIBCPP_VERSION in `__config`
-2. Update the __libcpp_version file.
-3. Update the version number in `docs/conf.py`
-
-//===---------------------------------------------------------------------===//
-// Adding a new header TODO
-//===---------------------------------------------------------------------===//
-
-These notes contain a list of things that must be done upon adding a new header
-to libc++.
-
-1. Add a test under `test/libcxx` that the header defines `_LIBCPP_VERSION`.
-2. Update `test/libcxx/double_include.sh.cpp` to include the new header.
-3. Create a submodule in `include/module.modulemap` for the new header.
-4. Update the include/CMakeLists.txt file to include the new header.

diff  --git a/libcxx/docs/Contributing.rst b/libcxx/docs/Contributing.rst
new file mode 100644
index 000000000000..abbf91fdd702
--- /dev/null
+++ b/libcxx/docs/Contributing.rst
@@ -0,0 +1,46 @@
+.. _ContributingToLibcxx:
+
+======================
+Contributing to libc++
+======================
+
+.. contents::
+  :local:
+
+Please read `this document <https://www.llvm.org/docs/Contributing.html>`__ on general rules to contribute to LLVM projects.
+
+Tasks and processes
+===================
+
+This file contains notes about various tasks and processes specific to libc++.
+
+Post-Release TODO
+=================
+
+After branching for an LLVM release:
+
+1. Update ``_LIBCPP_VERSION`` in ``include/__config``
+2. Update the ``include/__libcpp_version`` file
+3. Update the version number in ``docs/conf.py``
+
+Adding a new header TODO
+========================
+
+When adding a new header to libc++:
+
+1. Add a test under ``test/libcxx`` that the new header defines ``_LIBCPP_VERSION``. See ``test/libcxx/algorithms/version.pass.cpp`` for an example.
+2. Update the following test files to include the new header:
+
+  * ``test/libcxx/double_include.sh.cpp``
+  * ``test/libcxx/min_max_macros.compile.pass.cpp``
+  * ``test/libcxx/no_assert_include.compile.pass.cpp``
+
+3. Create a submodule in ``include/module.modulemap`` for the new header.
+4. Update the ``include/CMakeLists.txt`` file to include the new header.
+
+Exporting new symbols from the library
+======================================
+
+When exporting new symbols from libc++, one 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``.

diff  --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index 926cd102d71f..6b6c7735bf77 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -38,6 +38,7 @@ Getting Started with libc++
    UsingLibcxx
    BuildingLibcxx
    TestingLibcxx
+   Contributing
    Cxx1yStatus
    Cxx1zStatus
    Cxx2aStatus