llvm-project

History

Petr Hosek a2685cd6dc [libcxx] Support building hermetic static library This is useful when static libc++ library is being linked into shared libraries that may be used in combination with libraries. We want to avoid we exporting libc++ symbols in those cases where this option is useful. This is provided as a CMake option and can be enabled by libc++ vendors as needed. Differential Revision: https://reviews.llvm.org/D55404 llvm-svn: 350489		2019-01-06 06:14:31 +00:00
..
DesignDocs	[libcxx] Remove the availability_markup LIT feature	2018-12-07 21:48:39 +00:00
BuildingLibcxx.rst	[libcxx] Support building hermetic static library	2019-01-06 06:14:31 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
Makefile.sphinx	Add design docs for upcoming file_time_type change.	2018-07-25 02:53:53 +00:00
README.txt	Remove test commit.	2015-09-05 05:38:50 +00:00
ReleaseNotes.rst	[libcxx] Remove bad_array_length	2018-11-29 19:44:57 +00:00
TestingLibcxx.rst	[libcxx] Make sure use_system_cxx_lib does not override cxx_runtime_root for DYLD_LIBRARY_PATH	2018-12-14 18:19:14 +00:00
UsingLibcxx.rst	[libc++] Improve diagnostics for non-const comparators and hashers in associative containers	2018-12-06 21:46:17 +00:00
conf.py	fix some typos in the doc	2018-09-20 08:05:01 +00:00
index.rst	Correct docs to reference the new libc++ lists.	2018-09-22 19:49:29 +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.