llvm-project

History

Mehdi Amini e9c66ad9fa Add markup for libc++ dylib availability Libc++ is used as a system library on macOS and iOS (amongst others). In order for users to be able to compile a binary that is intended to be deployed to an older version of the platform, clang provides the availability attribute <https://clang.llvm.org/docs/AttributeReference.html#availability>_ that can be placed on declarations to describe the lifecycle of a symbol in the library. See docs/DesignDocs/AvailabilityMarkup.rst for more information. Differential Revision: https://reviews.llvm.org/D31739 llvm-svn: 302172		2017-05-04 17:08:54 +00:00
..
DesignDocs	Add markup for libc++ dylib availability	2017-05-04 17:08:54 +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	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.