hanchenye-llvm-project/libcxx/docs
Eric Fiselier 2405bd6898 Rework std::type_info definition to support systems without fully
merged type info names.

Previously std::type_info always expected type info string to be unique.
But this isn't always the case. Like when -Bsymbolic is passed to the
linker or due to llvm.org/PR37398.

This patch adds the LIBCXX_HAS_MERGED_TYPEINFO_NAMES_DEFAULT CMake
option which, when specified, overrides the default configuration for
the library.

The current defaults still assume unique names even though this isn't
strictly correct for ELF binaries. We should consider changing the
default in a follow up commit.

llvm-svn: 361913
2019-05-29 02:21:37 +00:00
..
DesignDocs [libcxx] Start defining lit features for tests depending on availability 2019-02-05 19:22:38 +00:00
BuildingLibcxx.rst Rework std::type_info definition to support systems without fully 2019-05-29 02:21:37 +00:00
CMakeLists.txt
FeatureTestMacroTable.rst P0722R3: Implement library support for destroying delete 2019-05-23 23:46:44 +00:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst Bump the trunk version to 9.0.0svn 2019-01-16 10:57:02 +00:00
TestingLibcxx.rst [CMake] Support compiler-rt builtins library in tests 2019-02-05 19:50:47 +00:00
UsingLibcxx.rst libcxx: Add _LIBCPP_NODISCARD_EXT to 38 more functions 2019-04-03 18:13:08 +00:00
conf.py Bump the trunk version to 9.0.0svn 2019-01-16 10:57:02 +00:00
index.rst [libc++][CMake] Clean up some of the libc++ re-exporting logic 2019-03-20 18:16:24 +00: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.