llvm-project/libcxx/docs
Louis Dionne c0cde79e9e [libc++] Remove C++03 extensions for std::allocator_arg & friends
As explained in the release note, libc++ used to provide various
global variables as an extension in C++03 mode. Unfortunately, that
made our definition non-conforming in all standard modes. This was
never a big problem until recently, since we are trying to support
C++20 Modules in libc++, and that requires cleaning up the definition
of these variables.

This change is the first in a series of changes to achieve our end goal.
This patch removes the ability for users to rely on the (incorrect)
definition of those global variables inside the shared library. The
plan is to then remove those definitions from the shared library
(which is an ABI break but I don't think it will have impact), and
finally to make our definition of those variables conforming in all
standard modes.

Differential Revision: https://reviews.llvm.org/D145422
2023-03-19 10:14:32 -04:00
..
DesignDocs
Helpers
Status [libcxx] Add status paper for Parallelism-TS 2023-03-17 12:31:32 +08:00
AddingNewCIJobs.rst [libc++][NFC] Fix typo in documentation 2023-03-02 12:42:15 -05:00
BuildingLibcxx.rst
CMakeLists.txt
conf.py Bump the trunk major version to 17 2023-01-24 22:57:27 -08:00
Contributing.rst [libc++][test] Adds more generic test macros. 2023-02-17 17:01:58 +01:00
FeatureTestMacroTable.rst [libc++] implement move_iterator<T*> should be a random access iterator \n Differntial Revision- https://reviews.llvm.org/D135248 2023-03-01 23:47:00 +05:30
index.rst [libcxx] Add status paper for Parallelism-TS 2023-03-17 12:31:32 +08:00
README.txt
ReleaseNotes.rst [libc++] Remove C++03 extensions for std::allocator_arg & friends 2023-03-19 10:14:32 -04:00
TestingLibcxx.rst [libc++][test] Adds more generic test macros. 2023-02-17 17:01:58 +01:00
UsingLibcxx.rst [libc++] Introduce a compile-time mechanism to override __libcpp_verbose_abort 2023-01-24 21:39:14 -05:00

libc++ Documentation
====================

The libc++ documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

To build the documents into html configure libc++ with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DLIBCXX_INCLUDE_DOCS=ON

After configuring libc++ with these options the make rule `docs-libcxx-html`
should be available.

The documentation in this directory is published at https://libcxx.llvm.org. It is kept up-to-date
by a build bot: https://lab.llvm.org/buildbot/#/builders/publish-sphinx-docs. If you notice that the
documentation is not updating anymore, please contact one of the maintainers.