llvm-project/libcxx/docs
Joe Loser 93df7b9f75
[libc++][ABI Break] Make is_error_condition_enum_v and is_error_code_enum_v bool, not size_t
`is_error_condition_enum_v` and `is_error_code_enum_v` are currently of
type `size_t`, but the standard mandates they are of type `bool`.

This is an ABI break technically since the size of these variable
templates has changed. Document it as such in the release notes.

Fixes https://bugs.llvm.org/show_bug.cgi?id=50755

Reviewed By: ldionne, Quuxplusone, #libc, var-const

Differential Revision: https://reviews.llvm.org/D112553
2021-10-28 15:38:17 -04:00
..
DesignDocs [libc++] Remove support for CloudABI, which has been abandoned 2021-08-24 14:11:32 -04:00
Helpers [libc++][doc] Use issue labels. 2021-10-15 17:30:33 +02:00
Status [libc++] P0433R2: add the remaining deduction guides. 2021-10-28 11:09:51 -07:00
AddingNewCIJobs.rst [libc++] Add timeout to BuildKite jobs 2021-08-09 15:31:04 -04:00
BuildingLibcxx.rst [runtimes] Use the new "runtimes" build by default and deprecate other builds 2021-10-18 13:50:26 -04:00
CMakeLists.txt
Contributing.rst [libc++][NFC] Add link to Discord channel from documentation 2021-09-22 11:13:53 -04:00
FeatureTestMacroTable.rst [libc++][doc] Fixes FeatureTestMacroTable.html. 2021-10-22 17:25:43 +02:00
README.txt [libc++] NFC: Add note about how the libcxx website gets updated 2021-07-05 10:25:33 -04:00
ReleaseNotes.rst [libc++][ABI Break] Make is_error_condition_enum_v and is_error_code_enum_v bool, not size_t 2021-10-28 15:38:17 -04:00
TestingLibcxx.rst [libc++][Docs] Update benchmark doc wrt monorepo 2021-10-02 07:35:32 +05:30
UsingLibcxx.rst [libc++] Implement C++20's P0476R2: std::bit_cast 2021-09-09 11:05:54 -04:00
conf.py Bump the trunk major version to 14 2021-07-27 21:58:25 -07:00
index.rst [libc++][ci] Update to Clang 13. 2021-10-28 17:37:32 +02:00

README.txt

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.