yggdrasil/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Projects 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.

261 lines
10 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-22 19:40:49 +00: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-25 17:00:30 +00: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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00: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 10:39:01 -04: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-22 19:40:49 +00:00
[libc++] Make sure to publish release notes at ReleaseNotes.html In LLVM 17, we switched to numbered RST files for release notes, which makes it easier to deal with cherry-picks around release points. However, we stopped publishing `libcxx/docs/ReleaseNotes.html`, which was referenced by external sites. This patch ensures that we keep publishing `ReleaseNotes.html` by simply including the versioned RST file in the unversioned RST file. Fixes #77955
2024-01-22 09:34:47 -05: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-22 19:40:49 +00: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 08:52:35 +01:00
Contributing
[libc++][chrono] Adds tzdb_list implementation. This is the first step to implement time zone support in libc++. This adds the complete tzdb_list class and a minimal tzdb class. The tzdb class only contains the version, which is used by reload_tzdb. Next to these classes it contains documentation and build system support needed for time zone support. The code depends on the IANA Time Zone Database, which should be available on the platform used or provided by the libc++ vendors. The code is labeled as experimental since there will be ABI breaks during development; the tzdb class needs to have the standard headers. Implements parts of: - P0355 Extending <chrono> to Calendars and Time Zones Addresses: - LWG3319 Properly reference specification of IANA time zone database Reviewed By: #libc, ldionne Differential Revision: https://reviews.llvm.org/D154282
2022-09-23 18:33:20 +02:00
ImplementationDefinedBehavior
[libc++][modules] Adds the C++23 std module. The patch is based on D144994. D151030 added the module definitions for the module std. This patch wires in the module and enables the basic testing. Some notable features are missing: - There is no test that libc++ can be fully imported as a module. - This lacks the parts for the std.compat module. - The module is not shipped with libc++. Implements parts of - P2465R3 Standard Library Modules std and std.compat Reviewed By: ldionne, aaronmondal, #libc Differential Revision: https://reviews.llvm.org/D151814
2023-02-28 20:29:26 +01:00
Modules
[libc++][hardening][NFC] Rename `HardenedMode.rst` to `Hardening.rst`. This addresses a comment from https://reviews.llvm.org/D154997.
2023-07-20 17:41:37 -07:00
Hardening
[libc++][doc] Updates the tasks to do for a release. This is a followup of the review comments in D144499. Reviewed By: ldionne, philnik, #libc Differential Revision: https://reviews.llvm.org/D150585
2023-05-07 19:50:41 +02:00
ReleaseProcedure
[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 09:46:29 -04:00
Status/Cxx14
Status/Cxx17
Status/Cxx20
[libc++] Updates C++2b to C++23. During the ISO C++ Committee meeting plenary session the C++23 Standard has been voted as technical complete. This updates the reference to c++2b to c++23 and updates the __cplusplus macro. Note since we use clang-tidy 16 a small work-around is needed. Clang knows -std=c++23 but clang-tidy not so for now force the lit compiler flag to use -std=c++2b instead of -std=c++23. Reviewed By: #libc, philnik, jloser, ldionne Differential Revision: https://reviews.llvm.org/D150795
2023-05-17 17:54:53 +02:00
Status/Cxx23
[libc++] Adds C++26 support. Clang has been updated to support C++26, this adds the same support for libc++. At the moment C++23 and C++26 are identical. During the next plenary in June the first C++26 papers will be voted on. Note like Clang this patch uses C++26 is the internal part and C++2c in the user visible part. Depends on D150795 Reviewed By: ldionne, #libc Differential Revision: https://reviews.llvm.org/D151026
2023-05-20 12:38:57 +02:00
Status/Cxx2c
[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 09:46:29 -04:00
Status/Format
[libcxx] Add status paper for Parallelism-TS Reviewed By: #libc, philnik, Mordante Differential Revision: https://reviews.llvm.org/D145652
2023-03-09 14:14:43 +08:00
Status/Parallelism
[libc++][PSTL] Update papers and add a status page for the algorithms Reviewed By: #libc, ldionne Spies: libcxx-commits, mgrang, arphaman Differential Revision: https://reviews.llvm.org/D152578
2023-06-09 12:34:07 -07:00
Status/PSTL
[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-19 23:10:47 +00:00
Status/Ranges
Status/Spaceship
[libc++][math] Mathematical Special Functions: Hermite Polynomial (#89982) Implementing the Hermite polynomials which are part of C++17's mathematical special functions. The goal is to get early feedback which will make implementing the other functions easier. Integration of functions in chunks (e.g. `std::hermite` at first, then `std::laguerre`, etc.) might make sense as well (also see note on boost.math below). I started out from this abandoned merge request: https://reviews.llvm.org/D58876 . The C++23 standard defines them in-terms of `/* floating-point type */` arguments. I have not looked into that. Note, there is still an ongoing discussion on discourse whether importing boost.math is an option.
2024-07-20 15:50:05 +00:00
Status/SpecialMath
[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-06 23:12:55 +01: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-22 19:40:49 +00:00
Test commit for builder llvm-svn: 246910
2015-09-05 05:29:23 +00: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 01:37:43 +00:00
.. toctree::
:hidden:
[libc++] Add documentation for setting up new CI jobs
2020-11-19 14:22:28 -05: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 01:37:43 +00:00
FeatureTestMacroTable
[libc++] Add documentation for setting up new CI jobs
2020-11-19 14:22:28 -05: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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00:00
Update the "Current Status" section of the website to be current. (#84507) The section discusses the reasons for the libraries inception more than a decade ago. Now it discusses the progess libc++ has made, and the many impressive acomplishments our contributors have brought it. The initial section remains below. --------- Co-authored-by: Louis Dionne <ldionne.2@gmail.com>
2024-04-01 13:25:26 -04:00
libc++ has become the default C++ Standard Library implementation for many major platforms, including Apple's macOS,
iOS, watchOS, and tvOS, Google Search, the Android operating system, and FreeBSD. As a result, libc++ has an estimated
user base of over 1 billion daily active users.
Since its inception, libc++ has focused on delivering high performance, standards-conformance, and portability. It has
[libc++] Remove annotations for GCC 13 and update the documentation (#97744) GCC 14 has been released a while ago. We've updated the CI to use GCC 14 now. This removes any old annotations in the tests and updates the documentation to reflect the updated version requirements.
2024-07-06 16:52:45 +02:00
been extensively tested and optimized, making it robust and production ready. libc++ fully implements C++11 and C++14,
Update the "Current Status" section of the website to be current. (#84507) The section discusses the reasons for the libraries inception more than a decade ago. Now it discusses the progess libc++ has made, and the many impressive acomplishments our contributors have brought it. The initial section remains below. --------- Co-authored-by: Louis Dionne <ldionne.2@gmail.com>
2024-04-01 13:25:26 -04:00
with C++17, C++20, C++23, and C++26 features being actively developed and making steady progress.
libc++ is continuously integrated and tested on a wide range of platforms and configurations, ensuring its reliability
and compatibility across various systems. The library's extensive test suite and rigorous quality assurance process have
made it a top choice for platform providers looking to offer their users a robust and efficient C++ Standard Library.
As an open-source project, libc++ benefits from a vibrant community of contributors who work together to improve the
library and add new features. This ongoing development and support ensure that libc++ remains at the forefront of
C++ standardization efforts and continues to meet the evolving needs of C++ developers worldwide.
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-22 19:40:49 +00: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 06:50:03 +00: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-22 19:40:49 +00:00
[libc++][doc] Updates the tasks to do for a release. This is a followup of the review comments in D144499. Reviewed By: ldionne, philnik, #libc Differential Revision: https://reviews.llvm.org/D150585
2023-05-07 19:50:41 +02:00
..
LLVM RELEASE bump version
[libc++] Documents details of the pre-commit CI. This documentation aims to make it cleare how the libc++ pre-commit CI works. For libc++ developers and other LLVM projects whose changes can affect libc++. This was discusses with @aaron.ballman as a follow on some unclearities for the Clang communitee how the libc++ pre-commit CI works. Note some parts depend on patches under review as commented in the documentation. Reviewed By: ldionne, #libc, philnik Differential Revision: https://reviews.llvm.org/D133249
2022-08-04 18:31:03 +02:00
.. _SupportedPlatforms:
[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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00: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-06 15:47:29 -04: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++][CI] Updates to Clang 19. (#85301) Since we have released Clang 16 is no longer actively supported. However the FreeBSD runner is still using this, so some tests still guard against Clang 16.
2024-04-04 20:48:23 +02:00
Clang 17, 18, 19-git latest two stable releases per `LLVM's release page <https://releases.llvm.org>`_ and the development version
[runtimes] Bump the supported AppleClang version to AppleClang 15 (#67065) AppleClang 15 was released on September 18th and is now stable. Per our policy, we're bumping the supported AppleClang compiler to the latest release. This allows cleaning up the test suite, but most importantly unblocking various other patches that are blocked on bumping the compiler requirements.
2023-09-25 09:46:01 -04:00
AppleClang 15 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-19 14:09:46 -04: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++] Remove annotations for GCC 13 and update the documentation (#97744) GCC 14 has been released a while ago. We've updated the CI to use GCC 14 now. This removes any old annotations in the tests and updates the documentation to reflect the updated version requirements.
2024-07-06 16:52:45 +02:00
GCC 14 In C++11 or later only latest stable release per `GCC's release page <https://gcc.gnu.org/releases.html>`_
[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-06 15:47:29 -04:00
============ =============== ========================== =====================
Libc++ also supports common platforms and architectures:
[libc++] Add initial support for picolibc Picolibc is a C Standard Library that is commonly used in embedded environments. This patch adds initial support for this configuration along with pre-commit CI. As of this patch, the test suite only builds the tests and nothing is run. A follow-up patch will make the test suite actually run the tests. Differential Revision: https://reviews.llvm.org/D154246
2023-11-29 09:56:20 -05:00
===================== ========================= ============================
Target platform Target architecture Notes
===================== ========================= ============================
macOS 10.13+ i386, x86_64, arm64
FreeBSD 12+ i386, x86_64, arm
Linux i386, x86_64, arm, arm64 Only glibc-2.24 and later and no other libc is officially supported
Android 5.0+ i386, x86_64, arm, arm64
Windows i386, x86_64 Both MSVC and MinGW style environments, ABI in MSVC environments is :doc:`unstable <DesignDocs/ABIVersioning>`
AIX 7.2TL5+ powerpc, powerpc64
[libc++] Run picolibc tests with qemu This patch actually runs the tests for picolibc behind an emulator, removing a few workarounds and increasing coverage. Differential Revision: https://reviews.llvm.org/D155521
2023-11-29 17:20:20 -05:00
Embedded (picolibc) arm
[libc++] Add initial support for picolibc Picolibc is a C Standard Library that is commonly used in embedded environments. This patch adds initial support for this configuration along with pre-commit CI. As of this patch, the test suite only builds the tests and nothing is run. A follow-up patch will make the test suite actually run the tests. Differential Revision: https://reviews.llvm.org/D154246
2023-11-29 09:56:20 -05: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-06 15:47:29 -04: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 14:24:51 +03: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 10:52:12 -04: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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00: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 09:46:29 -04:00
* :ref:`C++14 - Complete <cxx14-status>`
* :ref:`C++17 - In Progress <cxx17-status>`
* :ref:`C++20 - In Progress <cxx20-status>`
[libc++] Updates C++2b to C++23. During the ISO C++ Committee meeting plenary session the C++23 Standard has been voted as technical complete. This updates the reference to c++2b to c++23 and updates the __cplusplus macro. Note since we use clang-tidy 16 a small work-around is needed. Clang knows -std=c++23 but clang-tidy not so for now force the lit compiler flag to use -std=c++2b instead of -std=c++23. Reviewed By: #libc, philnik, jloser, ldionne Differential Revision: https://reviews.llvm.org/D150795
2023-05-17 17:54:53 +02:00
* :ref:`C++23 - In Progress <cxx23-status>`
[libc++] Adds C++26 support. Clang has been updated to support C++26, this adds the same support for libc++. At the moment C++23 and C++26 are identical. During the next plenary in June the first C++26 papers will be voted on. Note like Clang this patch uses C++26 is the internal part and C++2c in the user visible part. Depends on D150795 Reviewed By: ldionne, #libc Differential Revision: https://reviews.llvm.org/D151026
2023-05-20 12:38:57 +02:00
* :ref:`C++2c - In Progress <cxx2c-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 01:37:43 +00: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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00: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-06 23:22:02 +00: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-22 19:40:49 +00:00
[libc++] Fix link to bug tracker
2022-01-10 08:33:14 -05: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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00: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-06 15:47:29 -04: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-22 19:40:49 +00: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-13 22:12:02 +00:00
.. toctree::
:maxdepth: 1
Use __config_site when building libc++. Also cleanup ABI versioning doc llvm-svn: 250261
2015-10-14 00:22:05 +00: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 11:15:27 -04:00
DesignDocs/AtomicDesign
DesignDocs/CapturingConfigInfo
[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 14:48:40 +00: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-11 22:53:49 +00: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 11:15:27 -04:00
DesignDocs/FeatureTestMacros
DesignDocs/FileTimeType
[libc++] Reduces the number of transitive includes. This defines a new policy for removal of transitive includes. The goal of the policy it to make it relatively easy to remove headers when needed, but avoid breaking developers using and vendors shipping libc++. The method used is to guard transitive includes based on the C++ language version. For the upcoming C++23 we can remove headers when we want, but for other language versions we try to keep it to a minimum. In this code the transitive include of `<chrono>` is removed since D128577 introduces a header cycle between `<format>` and `<chrono>`. This cycle is indirectly required by the Standard. Our cycle dependency tool basically is a grep based tool, so it needs some hints to ignore cycles. With the input of our transitive include tests we can create a better tool. However that's out of the scope of this patch. Note the flag `_LIBCPP_REMOVE_TRANSITIVE_INCLUDES` remains unchanged. So users can still opt-out of transitives includes entirely. Reviewed By: #libc, ldionne, philnik Differential Revision: https://reviews.llvm.org/D132284
2022-08-20 10:34:26 +02:00
DesignDocs/HeaderRemovalPolicy
[libc++] Document guidelines for applying [[nodiscard]] (#84000) We've been applying ``[[nodiscard]]`` more liberally recently, but we don't have any documented guidance on when it's correct to add it. This patch adds that guidance. Follow-up patches will gradually apply it to the code base.
2024-03-29 19:33:46 +01:00
DesignDocs/NodiscardPolicy
[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-05 11:24:38 -08:00
DesignDocs/NoexceptPolicy
[libc++][PSTL] Add design docs Reviewed By: ldionne, Mordante, #libc Spies: grandinj, libcxx-commits, arphaman Differential Revision: https://reviews.llvm.org/D148478
2023-05-03 15:25:19 -07:00
DesignDocs/PSTLIntegration
[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 11:15:27 -04: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-16 15:48:59 -05: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 11:15:27 -04:00
DesignDocs/VisibilityMacros
[libc++][chrono] Adds tzdb_list implementation. This is the first step to implement time zone support in libc++. This adds the complete tzdb_list class and a minimal tzdb class. The tzdb class only contains the version, which is used by reload_tzdb. Next to these classes it contains documentation and build system support needed for time zone support. The code depends on the IANA Time Zone Database, which should be available on the platform used or provided by the libc++ vendors. The code is labeled as experimental since there will be ABI breaks during development; the tzdb class needs to have the standard headers. Implements parts of: - P0355 Extending <chrono> to Calendars and Time Zones Addresses: - LWG3319 Properly reference specification of IANA time zone database Reviewed By: #libc, ldionne Differential Revision: https://reviews.llvm.org/D154282
2022-09-23 18:33:20 +02:00
DesignDocs/TimeZone
[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-13 22:12:02 +00: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-06 15:47:29 -04:00
Add links to libc++ code coverage and builders llvm-svn: 250361
2015-10-15 03:27:02 +00: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-06 15:47:29 -04:00
============================
Cleanup new documentation index and transfer more information from www/index.html llvm-svn: 246913
2015-09-05 06:50:03 +00:00
Add libc++ main builder status badge (#75283) Also add links to github actions workflow.
2023-12-13 00:55:52 -05:00
* `Github Actions CI pipeline <https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml>`_
[libc++] Add documentation for setting up new CI jobs
2020-11-19 14:22:28 -05:00
* `Buildkite CI pipeline <https://buildkite.com/llvm-project/libcxx-ci>`_
[libcxx] Fix link to Buildbot interface Reviewed By: #libc, philnik, ldionne Differential Revision: https://reviews.llvm.org/D138286
2022-11-18 12:55:15 +00:00
* `LLVM Buildbot Builders <https://lab.llvm.org/buildbot>`_
[libc++] Add documentation for setting up new CI jobs
2020-11-19 14:22:28 -05:00
* :ref:`Adding New CI Jobs <AddingNewCIJobs>`
Cleanup new documentation index and transfer more information from www/index.html llvm-svn: 246913
2015-09-05 06:50:03 +00: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-06 15:47:29 -04: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-22 19:40:49 +00:00
Getting Involved
================
Doc: Links should use https
2020-03-22 22:42:03 +01: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-22 19:40:49 +00: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-09 14:40:10 -05: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 10:10:20 -04: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-22 19:40:49 +00:00
**Patches**
[libc++][docs] Remove mention of Phabricator on the landing page
2024-01-24 10:55:40 -05:00
If you want to contribute a patch to libc++, please start by reviewing our
:ref:`documentation about contributing <ContributingToLibcxx>`.
[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-22 19:40:49 +00:00
**Discussion and Questions**
Replace links to archived mailing lists by links to Discourse forums
2022-03-23 10:10:20 -04: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-22 19:40:49 +00:00
Cleanup new documentation index and transfer more information from www/index.html llvm-svn: 246913
2015-09-05 06:50:03 +00:00
Quick Links
===========
Doc: Links should use https
2020-03-22 22:42:03 +01:00
* `LLVM Homepage <https://llvm.org/>`_
Try to fix links for libcxx.llvm.org/docs again. llvm-svn: 246950
2015-09-06 23:09:54 +00:00
* `libc++abi Homepage <http://libcxxabi.llvm.org/>`_
Replace links to archived mailing lists by links to Discourse forums
2022-03-23 10:10:20 -04: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 12:54:21 +05:30
* `Browse libc++ Sources <https://github.com/llvm/llvm-project/tree/main/libcxx/>`_
Reference in New Issue Copy Permalink