diff options
author | Eric Fiselier <eric@efcs.ca> | 2016-05-03 22:32:08 +0000 |
---|---|---|
committer | Eric Fiselier <eric@efcs.ca> | 2016-05-03 22:32:08 +0000 |
commit | 539cd6758b8da2f35fb88a275374f752e7671e47 (patch) | |
tree | 5d6ebea3f15868bd40aa2d64826599031d0b32b0 /libcxx/docs/BuildingLibcxx.rst | |
parent | ce48c4d9751a30c106fa8b97b01eb0206373db7f (diff) | |
download | bcm5719-llvm-539cd6758b8da2f35fb88a275374f752e7671e47.tar.gz bcm5719-llvm-539cd6758b8da2f35fb88a275374f752e7671e47.zip |
Add documentation for new experimental library
llvm-svn: 268456
Diffstat (limited to 'libcxx/docs/BuildingLibcxx.rst')
-rw-r--r-- | libcxx/docs/BuildingLibcxx.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/libcxx/docs/BuildingLibcxx.rst b/libcxx/docs/BuildingLibcxx.rst index 0173326a5a6..0730703fac4 100644 --- a/libcxx/docs/BuildingLibcxx.rst +++ b/libcxx/docs/BuildingLibcxx.rst @@ -6,6 +6,8 @@ Building libc++ .. contents:: :local: +.. _build instructions: + Getting Started =============== @@ -119,6 +121,18 @@ CMake docs or execute ``cmake --help-variable VARIABLE_NAME``. libc++ specific options ----------------------- +.. option:: LIBCXX_INSTALL_LIBRARY:BOOL + + **Default**: ``ON`` + + Toggle the installation of the library portion of libc++. + +.. option:: LIBCXX_INSTALL_HEADERS:BOOL + + **Default**: ``ON`` + + Toggle the installation of the libc++ headers. + .. option:: LIBCXX_ENABLE_ASSERTIONS:BOOL **Default**: ``ON`` @@ -143,6 +157,25 @@ libc++ specific options Extra suffix to append to the directory where libraries are to be installed. This option overrides :option:`LLVM_LIBDIR_SUFFIX`. + +.. _libc++experimental options: + +libc++experimental Specific Options +------------------------------------ + +.. option:: LIBCXX_ENABLE_EXPERIMENTAL_LIBRARY:BOOL + + **Default**: ``ON`` + + Build and test libc++experimental.a. + +.. option:: LIBCXX_INSTALL_EXPERIMENTAL_LIBRARY:BOOL + + **Default**: ``OFF`` + + Install libc++experimental.a alongside libc++. + + .. _ABI Library Specific Options: ABI Library Specific Options |