hanchenye-llvm-project/libcxx/docs
Shoaib Meenai 8e62812ed3 [libc++] Add site config option for ABI macros
Some ABI macros affect headers, so it's nice to have a site config
option for them. Add a LIBCXX_ABI_DEFINES cmake macro to allow
specifying a list of ABI macros to define in the site config.

The primary design constraint (as discussed with Eric on IRC a while
back) was to not have to repeat the ABI macro names in cmake, which only
leaves a free-form cmake list as an option. A somewhat unfortunate
consequence is that we can't verify that the ABI macros being defined
actually exist, though we can at least perform some basic sanity
checking, since all the ABI macros begin with _LIBCPP_ABI_.

Differential Revision: https://reviews.llvm.org/D36719

llvm-svn: 314946
2017-10-04 23:17:12 +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
README.txt
TestingLibcxx.rst Fix misspelling of environment throughout libc++ 2017-05-09 23:47:20 +00:00
UsingLibcxx.rst [libc++] Add _LIBCPP_DISABLE_EXTERN_TEMPLATE config option 2017-04-13 20:13:32 +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.