maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/libcxx/docs/Contributing.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

69 lines
3.3 KiB
ReStructuredText
Raw Normal View History

[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
2020-12-02 15:52:35 +08:00
.. _ContributingToLibcxx:
======================
Contributing to libc++
======================
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
This file contains notes about various tasks and processes specific to contributing
to libc++. If this is your first time contributing, please also read `this document
<https://www.llvm.org/docs/Contributing.html>`__ on general rules for contributing to LLVM.
[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
2020-12-02 15:52:35 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
For libc++, please make sure you follow `these instructions <https://www.llvm.org/docs/Phabricator.html#requesting-a-review-via-the-command-line>`_
for submitting a code review from the command-line using ``arc``, since we have some
automation (e.g. CI) that depends on the review being submitted that way.
[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
2020-12-02 15:52:35 +08:00
[libc++] NFC: Document the Differential queries to avoid duplicating work Differential Revision: https://reviews.llvm.org/D94343
2021-01-09 06:23:16 +08:00
Looking for pre-existing reviews
================================
Before you start working on any feature, please take a look at the open reviews
to avoid duplicating someone else's work. You can do that by going to the website
where code reviews are held, `Differential <https://reviews.llvm.org/differential>`__,
and clicking on ``Libc++ Open Reviews`` in the sidebar to the left. If you see
that your feature is already being worked on, please consider chiming in instead
of duplicating work!
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
Pre-commit check list
=====================
[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
2020-12-02 15:52:35 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
Before committing or creating a review, please go through this check-list to make
sure you don't forget anything:
[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
2020-12-02 15:52:35 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
- Do you have tests for every public class and/or function you're adding or modifying?
- Did you update the synopsis of the relevant headers?
- Did you update the relevant files to track implementation status (in ``docs/Status/``)?
[libc++] Add a bunch of missing _LIBCPP_HIDE_FROM_ABI in <ranges> We've been forgetting to add those to most of the <ranges> review. To avoid forgetting in the future, I added an item in the pre-commit checklist. Differential Revision: https://reviews.llvm.org/D106287
2021-07-20 00:34:56 +08:00
- Did you mark all functions and type declarations with the :ref:`proper visibility macro <visibility-macros>`?
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
- If you added a header:
[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
2020-12-02 15:52:35 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
- Did you add it to ``include/module.modulemap``?
- Did you add it to ``include/CMakeLists.txt``?
- If it's a public header, did you add a test under ``test/libcxx`` that the new header defines ``_LIBCPP_VERSION``? See ``test/libcxx/algorithms/version.pass.cpp`` for an example. NOTE: This should be automated.
- If it's a public header, did you update ``utils/generate_header_inclusion_tests.py``?
[libc++] Add a script to automatize updating test for a new header. Idea from D92525. This script globs include/ directory and updates the tests in test/libcxx. This patch does not generate module.modulemap nor CMakeLists.txt. Reviewed By: ldionne, #libc Differential Revision: https://reviews.llvm.org/D92656
2020-12-10 15:37:21 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
- Did you add the relevant feature test macro(s) for your feature? Did you update the ``generate_feature_test_macro_components.py`` script with it?
- Did you run the ``libcxx-generate-files`` target and verify its output?
[libc++] Update contributor documentation. The document has the following updates: - Rename 'feature test' to 'feature-test', the latter is the spelling used in the Standard. - Add information how an ABI list can be downloaded from Buildkite. Differential Revision: https://reviews.llvm.org/D99290
2021-03-25 02:54:40 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
Post-release check list
=======================
[libc++] Add a script to automatize updating test for a new header. Idea from D92525. This script globs include/ directory and updates the tests in test/libcxx. This patch does not generate module.modulemap nor CMakeLists.txt. Reviewed By: ldionne, #libc Differential Revision: https://reviews.llvm.org/D92656
2020-12-10 15:37:21 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
After branching for an LLVM release:
[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
2020-12-02 15:52:35 +08:00
[libc++] Add a CMake target to re-generate files and revamp CONTRIBUTING.rst As we automate more and more things in the library, it becomes useful for contributors to have a single target for running all the automation as part of their workflow. This commit adds a new `libcxx-generate-files` target that should re-generate all the auto-generated files in the library. As a fly-by, I also revamped the documentation on Contributing to account for this new target and present it as a bullet list of things to check before committing. I also added a few things that are often overlooked to that list, such as updating the synopsis and the status files. Differential Revision: https://reviews.llvm.org/D106067
2021-07-15 22:19:39 +08:00
1. Update ``_LIBCPP_VERSION`` in ``include/__config``
2. Update the ``include/__libcpp_version`` file
3. Update the version number in ``docs/conf.py``
[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
2020-12-02 15:52:35 +08:00
Exporting new symbols from the library
======================================
[libc++] Update contributor documentation. The document has the following updates: - Rename 'feature test' to 'feature-test', the latter is the spelling used in the Standard. - Add information how an ABI list can be downloaded from Buildkite. Differential Revision: https://reviews.llvm.org/D99290
2021-03-25 02:54:40 +08:00
When exporting new symbols from libc++, you must update the ABI lists located in ``lib/abi``.
[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
2020-12-02 15:52:35 +08:00
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``.
[libc++] Update contributor documentation. The document has the following updates: - Rename 'feature test' to 'feature-test', the latter is the spelling used in the Standard. - Add information how an ABI list can be downloaded from Buildkite. Differential Revision: https://reviews.llvm.org/D99290
2021-03-25 02:54:40 +08:00
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.