llvm-project

History

Shoaib Meenai 492d7134f3 [libc++] Support Microsoft ABI without vcruntime headers The vcruntime headers are hairy and clash with both libc++ headers themselves and other libraries. libc++ normally deals with the clashes by deferring to the vcruntime headers and silencing its own definitions, but for clients which don't want to depend on vcruntime headers, it's desirable to support the opposite, i.e. have libc++ provide its own definitions. Certain operator new/delete replacement scenarios are not currently supported in this mode, which requires some tests to be marked XFAIL. The added documentation has more details. Differential Revision: https://reviews.llvm.org/D38522 llvm-svn: 315234		2017-10-09 19:25:17 +00:00
..
DesignDocs	[libc++] class template -> template class. NFC	2017-07-13 22:08:59 +00:00
BuildingLibcxx.rst	[libc++] Add site config option for ABI macros	2017-10-04 23:17:12 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
Makefile.sphinx	Attempt to fix Sphinx build	2016-09-16 03:47:53 +00:00
README.txt	Remove test commit.	2015-09-05 05:38:50 +00:00
TestingLibcxx.rst	Fix misspelling of environment throughout libc++	2017-05-09 23:47:20 +00:00
UsingLibcxx.rst	[libc++] Support Microsoft ABI without vcruntime headers	2017-10-09 19:25:17 +00:00
conf.py	Bump docs version to 6.0	2017-07-19 13:46:11 +00:00
index.rst	Add markup for libc++ dylib availability	2017-05-04 17:08:54 +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.