llvm-project/libcxx/docs
Mark de Wever 1a036e9cc8 [libcxx] Implement P1956 rename low-level bit functions
Implements P1956: On the names of low-level bit manipulation functions.

Users may use older versions of libc++ or other standard libraries with the old names. In order to keep compatibility the old functions are kept, but marked as deprecated.

The patch also adds a new config macro `_LIBCPP_DEPRECATED_MSG`. Do you prefer a this is a separate patch?

Reviewed By: ldionne, #libc

Differential Revision: https://reviews.llvm.org/D90551
2020-11-24 17:37:06 +01:00
..
DesignDocs [libc++] Rework the whole availability markup implementation 2020-11-05 12:28:52 -05:00
AddingNewCIJobs.rst [libc++] Add documentation for setting up new CI jobs 2020-11-19 14:42:02 -05:00
BuildingLibcxx.rst [libc++] Clarify how we pick the typeinfo comparison 2020-11-18 16:58:45 -05:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst [libcxx] Implement P1956 rename low-level bit functions 2020-11-24 17:37:06 +01:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst [libcxx] Implement P1956 rename low-level bit functions 2020-11-24 17:37:06 +01:00
TestingLibcxx.rst [libc++] Migrate warning flags to the DSL 2020-11-02 12:25:05 -05:00
UsingLibcxx.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
conf.py Bump the trunk major version to 12 2020-07-15 12:05:05 +02:00
index.rst [libc++] Add documentation for setting up new CI jobs 2020-11-19 14:42:02 -05: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.