llvm-project/libcxx/docs
Shoaib Meenai 461764de0d [libc++] Add _LIBCPP_DISABLE_EXTERN_TEMPLATE config option
When the libc++ extern template macros were added, the intent was for it
to be possible for consumers of the headers to disable extern templates
(via `-D_LIBCPP_EXTERN_TEMPLATE(...)=`). Unfortunately, support for
specifying function-like macros varies on the command line varies across
compilers (e.g. MSVC doesn't support it at all), and cmake doesn't allow
it for the same reason. Add a non-function macro for this purpose.

The intended use is for libraries which want to use the libc++ headers
without taking a dependency on the libc++ library itself. I can name the
macro something which reflects its intent rather than its behavior (e.g.
`_LIBCPP_HEADER_ONLY`) if desired.

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

llvm-svn: 300246
2017-04-13 20:13:32 +00:00
..
DesignDocs [libc++] Make _LIBCPP_TYPE_VIS export members 2017-03-02 03:22:18 +00:00
BuildingLibcxx.rst docs: add some documentation for building on Windows 2017-02-10 03:58:20 +00:00
CMakeLists.txt
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 Update TestingLibcxx doc to reflect the use_system_cxx_lib flag. Patch from Michael Park 2016-12-23 19:09:14 +00:00
UsingLibcxx.rst [libc++] Add _LIBCPP_DISABLE_EXTERN_TEMPLATE config option 2017-04-13 20:13:32 +00:00
conf.py Update version to 5.0 2017-01-13 18:29:56 +00:00
index.rst Update all bug URL's to point to https://bugs.llvm.org/... 2017-02-17 08:37:03 +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.