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

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

224 lines
8.2 KiB
ReStructuredText
Raw Normal View History

[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
.. _index:
=============================
"libc++" C++ Standard Library
=============================
Overview
========
[libcxx] Mentions "targeting C++11 and above" instead of "targeting C++11" in the doc llvm-svn: 293071
2017-01-26 01:00:30 +08:00
libc++ is a new implementation of the C++ standard library, targeting C++11 and
above.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
* Features and Goals
* Correctness as defined by the C++11 standard.
* Fast execution.
* Minimal memory use.
* Fast compile times.
* ABI compatibility with gcc's libstdc++ for some low-level features
such as exception objects, rtti and memory allocation.
* Extensive unit tests.
* Design and Implementation:
* Extensive unit tests
* Internal linker model can be dumped/read to textual format
* Additional linking features can be plugged in as "passes"
* OS specific and CPU specific code factored out
Getting Started with libc++
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
===========================
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
.. toctree::
[libc++][docs] Overhaul the documentation for building and using libc++ This patch overhauls the documentation around building libc++ for vendors, and using libc++ for end-users. It also: - Removes mention of the standalone build, which we've been trying to get rid of for a long time. - Removes mention of using a local ABI installation, which we don't do and is documented as "not recommended". - Removes mention of the separate libc++filesystem.a library, which isn't relevant anymore since filesystem support is in the main library. - Adds mention of the GDB pretty printers and how to use them.
2021-07-06 22:39:01 +08:00
:maxdepth: 1
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
[libc++] Add a link to the Release notes from the main libc++ documentation llvm-svn: 341551
2018-09-06 23:05:43 +08:00
ReleaseNotes
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
UsingLibcxx
BuildingLibcxx
TestingLibcxx
[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
Contributing
[libc++] NFC: Move the status docs to their own subdirectory This cleans up the libcxx/doc directory quite a bit and will avoid the proliferation of status files in that directory as new standards are voted.
2021-07-06 21:46:29 +08:00
Status/Cxx14
Status/Cxx17
Status/Cxx20
Status/Cxx2b
Status/Format
[libc++] [doc] Add issue tracking for spaceship operator<=> implementation Add issue tracking and assignment for the implementation of P1614R2: The Mothership has Landed. Reviewed By: cjdb, #libc, Mordante, Quuxplusone Differential Revision: https://reviews.llvm.org/D107877
2021-08-20 07:10:47 +08:00
Status/Ranges
Status/Spaceship
[libc++] Add Status page for P2321R2 (Zip) Add a status page for P2321R2 Reviewed By: ldionne, Mordante, #libc Spies: jloser, libcxx-commits, arphaman Differential Revision: https://reviews.llvm.org/D116691
2022-01-07 06:12:55 +08:00
Status/Zip
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
Test commit for builder llvm-svn: 246910
2015-09-05 13:29:23 +08:00
Implement feature test macros using a script. Summary: This patch implements all the feature test macros libc++ currently supports, as specified by the standard or cppreference prior to C++2a. The tests and `<version>` header are generated using a script. The script contains a table of each feature test macro, the headers it should be accessible from, and its values of each dialect of C++. When a new feature test macro is added or needed, the table should be updated and the script re-run. Reviewers: mclow.lists, jfb, serge-sans-paille Reviewed By: mclow.lists Subscribers: arphaman, jfb, ldionne, libcxx-commits Differential Revision: https://reviews.llvm.org/D56750 llvm-svn: 351286
2019-01-16 09:37:43 +08:00
.. toctree::
:hidden:
[libc++] Add documentation for setting up new CI jobs
2020-11-20 03:22:28 +08:00
AddingNewCIJobs
Implement feature test macros using a script. Summary: This patch implements all the feature test macros libc++ currently supports, as specified by the standard or cppreference prior to C++2a. The tests and `<version>` header are generated using a script. The script contains a table of each feature test macro, the headers it should be accessible from, and its values of each dialect of C++. When a new feature test macro is added or needed, the table should be updated and the script re-run. Reviewers: mclow.lists, jfb, serge-sans-paille Reviewed By: mclow.lists Subscribers: arphaman, jfb, ldionne, libcxx-commits Differential Revision: https://reviews.llvm.org/D56750 llvm-svn: 351286
2019-01-16 09:37:43 +08:00
FeatureTestMacroTable
[libc++] Add documentation for setting up new CI jobs
2020-11-20 03:22:28 +08:00
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
Current Status
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
==============
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
After its initial introduction, many people have asked "why start a new
library instead of contributing to an existing library?" (like Apache's
libstdcxx, GNU's libstdc++, STLport, etc). There are many contributing
reasons, but some of the major ones are:
Cleanup new documentation index and transfer more information from www/index.html llvm-svn: 246913
2015-09-05 14:50:03 +08:00
* From years of experience (including having implemented the standard
library before), we've learned many things about implementing
the standard containers which require ABI breakage and fundamental changes
to how they are implemented. For example, it is generally accepted that
building std::string using the "short string optimization" instead of
using Copy On Write (COW) is a superior approach for multicore
machines (particularly in C++11, which has rvalue references). Breaking
ABI compatibility with old versions of the library was
determined to be critical to achieving the performance goals of
libc++.
* Mainline libstdc++ has switched to GPL3, a license which the developers
of libc++ cannot use. libstdc++ 4.2 (the last GPL2 version) could be
independently extended to support C++11, but this would be a fork of the
codebase (which is often seen as worse for a project than starting a new
independent one). Another problem with libstdc++ is that it is tightly
integrated with G++ development, tending to be tied fairly closely to the
matching version of G++.
* STLport and the Apache libstdcxx library are two other popular
candidates, but both lack C++11 support. Our experience (and the
experience of libstdc++ developers) is that adding support for C++11 (in
particular rvalue references and move-only types) requires changes to
almost every class and function, essentially amounting to a rewrite.
Faced with a rewrite, we decided to start from scratch and evaluate every
design decision from first principles based on experience.
Further, both projects are apparently abandoned: STLport 5.2.1 was
released in Oct'08, and STDCXX 4.2.1 in May'08.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
Platform and Compiler Support
=============================
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
Libc++ aims to support common compilers that implement the C++11 Standard. In order to strike a
good balance between stability for users and maintenance cost, testing coverage and development
velocity, libc++ drops support for older compilers as newer ones are released.
============ =============== ========================== =====================
Compiler Versions Restrictions Support policy
============ =============== ========================== =====================
[libc++] Bump minimum compiler requirements Now that we've branched for the LLVM 14 release, our support window moves to clang-13 and clang-14. Similarly, AppleClang 13 has been released for some time now, so that should be the oldest compiler we support, per our policy. A possible follow-up would be to remove _LIBCPP_HAS_NO_CONCEPTS, since I don't think we support any compiler that doesn't support concepts anymore. Differential Revision: https://reviews.llvm.org/D118831
2022-02-03 02:08:52 +08:00
Clang 13, 14 latest two stable releases per `LLVM's release page <https://releases.llvm.org>`_
AppleClang 13 latest stable release per `Xcode's release page <https://developer.apple.com/documentation/xcode-release-notes>`_
[libc++][CI] Add AIX pipeline config This changes adds the pipeline config for both 32-bit and 64-bit AIX targets. As well, we add a lit feature `LIBCXX-AIX-FIXME` which is used to mark the failing tests which remain to be investigated on AIX, so that the CI produces a clean build. Reviewed By: #libc, ldionne Differential Revision: https://reviews.llvm.org/D111359
2021-10-20 02:09:46 +08:00
Open XL 17.1 (AIX) latest stable release per `Open XL's documentation page <https://www.ibm.com/docs/en/openxl-c-and-cpp-aix>`_
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
GCC 11 In C++11 or later only latest stable release per `GCC's release page <https://gcc.gnu.org/releases.html>`_
============ =============== ========================== =====================
Libc++ also supports common platforms and architectures:
=============== ========================= ============================
Target platform Target architecture Notes
=============== ========================= ============================
macOS 10.9+ i386, x86_64, arm64 Building the shared library itself requires targetting macOS 10.11+
FreeBSD 10+ i386, x86_64, arm
Linux i386, x86_64, arm, arm64
[libcxx] [ci] Add CI configurations for MinGW Mention support for MinGW in the docs. Rename the existing windows CI jobs to Clang-cl, as both Clang-cl and MinGW are equally much "Windows", just different toolchain environments. Add an XFAIL for a recently added test that fails in the MinGW DLL configuration (with an explanation of what's causing the failure). Differential Revision: https://reviews.llvm.org/D112215
2021-10-02 04:08:57 +08:00
Windows x86_64 Both MSVC and MinGW style environments
[libc++][CI] Add AIX pipeline config This changes adds the pipeline config for both 32-bit and 64-bit AIX targets. As well, we add a lit feature `LIBCXX-AIX-FIXME` which is used to mark the failing tests which remain to be investigated on AIX, so that the CI produces a clean build. Reviewed By: #libc, ldionne Differential Revision: https://reviews.llvm.org/D111359
2021-10-20 02:09:46 +08:00
AIX powerpc, powerpc64
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
=============== ========================= ============================
Generally speaking, libc++ should work on any platform that provides a fairly complete
C Standard Library. It is also possible to turn off parts of the library for use on
systems that provide incomplete support.
However, libc++ aims to provide a high-quality implementation of the C++ Standard
Library, especially when it comes to correctness. As such, we aim to have test coverage
for all the platforms and compilers that we claim to support. If a platform or compiler
[libcxx] [docs] Acknowledge that the library is known to work in some configs outside of what's tested in CI Differential Revision: https://reviews.llvm.org/D105888
2021-07-13 19:24:51 +08:00
is not listed here, it is not officially supported. It may happen to work, and
in practice the library is known to work on some platforms not listed here, but
we don't make any guarantees. If you would like your compiler and/or platform
[libc++][NFC] Fix indentation of documentation
2021-08-17 22:52:12 +08:00
to be formally supported and listed here, please work with the libc++ team to set
up testing for your configuration.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
C++ Dialect Support
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
===================
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
* C++11 - Complete
[libc++] NFC: Move the status docs to their own subdirectory This cleans up the libcxx/doc directory quite a bit and will avoid the proliferation of status files in that directory as new standards are voted.
2021-07-06 21:46:29 +08:00
* :ref:`C++14 - Complete <cxx14-status>`
* :ref:`C++17 - In Progress <cxx17-status>`
* :ref:`C++20 - In Progress <cxx20-status>`
[libc++][doc] Update the release notes. Updates the libc++ release notes with the changes since the last release. Differential Revision: https://reviews.llvm.org/D95248
2021-01-23 02:03:14 +08:00
* :ref:`C++2b - In Progress <cxx2b-status>`
Implement feature test macros using a script. Summary: This patch implements all the feature test macros libc++ currently supports, as specified by the standard or cppreference prior to C++2a. The tests and `<version>` header are generated using a script. The script contains a table of each feature test macro, the headers it should be accessible from, and its values of each dialect of C++. When a new feature test macro is added or needed, the table should be updated and the script re-run. Reviewers: mclow.lists, jfb, serge-sans-paille Reviewed By: mclow.lists Subscribers: arphaman, jfb, ldionne, libcxx-commits Differential Revision: https://reviews.llvm.org/D56750 llvm-svn: 351286
2019-01-16 09:37:43 +08:00
* :ref:`C++ Feature Test Macro Status <feature-status>`
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
Notes and Known Issues
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
======================
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
This list contains known issues with libc++
* Building libc++ with ``-fno-rtti`` is not supported. However
linking against it with ``-fno-rtti`` is supported.
Fix another bad link in the new docs llvm-svn: 246951
2015-09-07 07:22:02 +08:00
A full list of currently open libc++ bugs can be `found here`__.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
[libc++] Fix link to bug tracker
2022-01-10 21:33:14 +08:00
.. __: https://github.com/llvm/llvm-project/labels/libc%2B%2B
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
Design Documents
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
================
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
[libcxx] Capture configuration information when installing the libc++ headers Summary: Hi all, This patch is a successor to D11963. However it has changed dramatically and I felt it would be best to start a new review thread. Please read the design documentation added in this patch for a description of how it works. Reviewers: mclow.lists, danalbert, jroelofs, EricWF Subscribers: vkalintiris, rnk, ed, espositofulvio, asl, eugenis, cfe-commits Differential Revision: http://reviews.llvm.org/D13407 llvm-svn: 250235
2015-10-14 06:12:02 +08:00
.. toctree::
:maxdepth: 1
Use __config_site when building libc++. Also cleanup ABI versioning doc llvm-svn: 250261
2015-10-14 08:22:05 +08:00
DesignDocs/ABIVersioning
[libc++] Remove the old HTML documentation This commit finishes moving the <atomic> design documents to the RST documentation and removes the old documentation. https://libcxx.llvm.org is already pointing to the new documentation only now, so the removal of the old documentation is really a NFC. I went over the old documentation and I don't think we're leaving anything important behind - I think everything important was mentionned in the RST documentation anyway.
2021-06-08 23:15:27 +08:00
DesignDocs/AtomicDesign
DesignDocs/CapturingConfigInfo
DesignDocs/DebugMode
[libcxx] Slightly improved policy for handling experimental features Summary: Following the discussion on the libcxx-dev mailing list (http://lists.llvm.org/pipermail/libcxx-dev/2019-May/000358.html), this implements the new policy for handling experimental features and their deprecation. We basically add a deprecation warning for std::experimental::filesystem, and we remove a bunch of <experimental/*> headers that were now empty. Reviewers: mclow.lists, EricWF Subscribers: mgorny, christof, jkorous, dexonsmith, arphaman, libcxx-commits, jfb Tags: #libc Differential Revision: https://reviews.llvm.org/D62428 llvm-svn: 363072
2019-06-11 22:48:40 +08:00
DesignDocs/ExperimentalFeatures
Add documentation and tests for Clangs C++11 extensions in C++03. As we gear up to drop support for GCC in C++03, we should make clear what our C++03 mode is, the C++11 extensions it provides, and the C++11 extensions it depends on. The section of this document discussing user-facing extensions has been left blank while the community discusses new directions. For now it's just a warning to users. Additionally, the document contains examples of how these extensions should be used and why. For example, using alias templates over class templates. llvm-svn: 363110
2019-06-12 06:53:49 +08:00
DesignDocs/ExtendedCXX03Support
[libc++] Remove the old HTML documentation This commit finishes moving the <atomic> design documents to the RST documentation and removes the old documentation. https://libcxx.llvm.org is already pointing to the new documentation only now, so the removal of the old documentation is really a NFC. I went over the old documentation and I don't think we're leaving anything important behind - I think everything important was mentionned in the RST documentation anyway.
2021-06-08 23:15:27 +08:00
DesignDocs/FeatureTestMacros
DesignDocs/FileTimeType
[lic++][docs] Explain noexcept policy for narrow contracts. Adds documentation around libc++'s policy to add noexcept to things that cannot throw but aren't marked as noexcept. Refs LWG 3518 and D95251. Differential Revision: https://reviews.llvm.org/D95821
2021-02-06 03:24:38 +08:00
DesignDocs/NoexceptPolicy
[libc++] Remove the old HTML documentation This commit finishes moving the <atomic> design documents to the RST documentation and removes the old documentation. https://libcxx.llvm.org is already pointing to the new documentation only now, so the removal of the old documentation is really a NFC. I went over the old documentation and I don't think we're leaving anything important behind - I think everything important was mentionned in the RST documentation anyway.
2021-06-08 23:15:27 +08:00
DesignDocs/ThreadingSupportAPI
DesignDocs/UniquePtrTrivialAbi
[libc++] Unspecified behavior randomization in libc++ This effort is dedicated to deflake the tests of the users which depend on the unspecified behavior of algorithms and containers. This also might help updating the sorting algorithm in libcxx which has the quadratic worst case in the future or at least create a new one under flag. For detailed design, please see the design doc I provide in the patch. Differential Revision: https://reviews.llvm.org/D96946
2021-11-17 04:48:59 +08:00
DesignDocs/UnspecifiedBehaviorRandomization
[libc++] Remove the old HTML documentation This commit finishes moving the <atomic> design documents to the RST documentation and removes the old documentation. https://libcxx.llvm.org is already pointing to the new documentation only now, so the removal of the old documentation is really a NFC. I went over the old documentation and I don't think we're leaving anything important behind - I think everything important was mentionned in the RST documentation anyway.
2021-06-08 23:15:27 +08:00
DesignDocs/VisibilityMacros
[libcxx] Capture configuration information when installing the libc++ headers Summary: Hi all, This patch is a successor to D11963. However it has changed dramatically and I felt it would be best to start a new review thread. Please read the design documentation added in this patch for a description of how it works. Reviewers: mclow.lists, danalbert, jroelofs, EricWF Subscribers: vkalintiris, rnk, ed, espositofulvio, asl, eugenis, cfe-commits Differential Revision: http://reviews.llvm.org/D13407 llvm-svn: 250235
2015-10-14 06:12:02 +08:00
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
Add links to libc++ code coverage and builders llvm-svn: 250361
2015-10-15 11:27:02 +08:00
Build Bots and Test Coverage
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
============================
Cleanup new documentation index and transfer more information from www/index.html llvm-svn: 246913
2015-09-05 14:50:03 +08:00
[libc++] Add documentation for setting up new CI jobs
2020-11-20 03:22:28 +08:00
* `Buildkite CI pipeline <https://buildkite.com/llvm-project/libcxx-ci>`_
* `LLVM Buildbot Builders <http://lab.llvm.org:8011>`_
* :ref:`Adding New CI Jobs <AddingNewCIJobs>`
Cleanup new documentation index and transfer more information from www/index.html llvm-svn: 246913
2015-09-05 14:50:03 +08:00
[libc++][docs] Update documentation to reflect libc++'s compiler support policy In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we discussed updating the compiler support policy for libc++ to match more closely what we do actually support. This commit enshrines that policy decision in libc++'s documentation. Differential Revision: https://reviews.llvm.org/D105563
2021-07-07 03:47:29 +08:00
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
Getting Involved
================
Doc: Links should use https
2020-03-23 05:42:03 +08:00
First please review our `Developer's Policy <https://llvm.org/docs/DeveloperPolicy.html>`__
and `Getting started with LLVM <https://llvm.org/docs/GettingStarted.html>`__.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
**Bug Reports**
If you think you've found a bug in libc++, please report it using
[libc++] Fix the documentation and re-enable documentation CI The documentation CI job is very cheap, so we can afford to keep it around even with reduced capacity. This commit fixes the documentation (which had an invalid reference in it) and re-enables that CI step. Differential Revision: https://reviews.llvm.org/D116897
2022-01-10 03:40:10 +08:00
the `LLVM bug tracker`_. If you're not sure, you
Replace links to archived mailing lists by links to Discourse forums
2022-03-23 22:10:20 +08:00
can ask for support on the `libcxx forum`_ or on IRC.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
**Patches**
If you want to contribute a patch to libc++, the best place for that is
Doc: Links should use https
2020-03-23 05:42:03 +08:00
`Phabricator <https://llvm.org/docs/Phabricator.html>`_. Please add `libcxx-commits` as a subscriber.
Replace links to archived mailing lists by links to Discourse forums
2022-03-23 22:10:20 +08:00
Also make sure you are subscribed to the `libcxx-commits mailing list`_.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
**Discussion and Questions**
Replace links to archived mailing lists by links to Discourse forums
2022-03-23 22:10:20 +08:00
Send discussions and questions to the `libcxx forum`_.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788
2015-08-23 03:40:49 +08:00
Cleanup new documentation index and transfer more information from www/index.html llvm-svn: 246913
2015-09-05 14:50:03 +08:00
Quick Links
===========
Doc: Links should use https
2020-03-23 05:42:03 +08:00
* `LLVM Homepage <https://llvm.org/>`_
Try to fix links for libcxx.llvm.org/docs again. llvm-svn: 246950
2015-09-07 07:09:54 +08:00
* `libc++abi Homepage <http://libcxxabi.llvm.org/>`_
Replace links to archived mailing lists by links to Discourse forums
2022-03-23 22:10:20 +08:00
* `LLVM Bug Tracker <https://github.com/llvm/llvm-project/labels/libc++/>`_
* `libcxx-commits Mailing List <http://lists.llvm.org/mailman/listinfo/libcxx-commits>`_
* `libcxx Forum <https://discourse.llvm.org/c/runtimes/libcxx/>`_
[Branch-Rename] Fix some links According to the [[ https://foundation.llvm.org/docs/branch-rename/ | status of branch rename ]], the master branch of the LLVM repository is removed on 28 Jan 2021. Reviewed By: mehdi_amini Differential Revision: https://reviews.llvm.org/D95766
2021-02-01 15:24:21 +08:00
* `Browse libc++ Sources <https://github.com/llvm/llvm-project/tree/main/libcxx/>`_