diff options
| author | Andrew Wilkins <axwalk@gmail.com> | 2016-01-15 03:33:35 +0000 |
|---|---|---|
| committer | Andrew Wilkins <axwalk@gmail.com> | 2016-01-15 03:33:35 +0000 |
| commit | 4769517b7b5745853db9cc702862aacce580ac81 (patch) | |
| tree | e1a533ecb7a7e9789ead09e42fe5e52538bfe426 /llvm/docs/CMake.rst | |
| parent | 4b83886ff13277e7e2556d3de5c36f5104ea1de0 (diff) | |
| download | bcm5719-llvm-4769517b7b5745853db9cc702862aacce580ac81.tar.gz bcm5719-llvm-4769517b7b5745853db9cc702862aacce580ac81.zip | |
[docs] Document LLVM_{BUILD,LINK}_LLVM_DYLIB
Summary:
Document the LLVM_BUILD_LLVM_DYLIB and LLVM_LINK_LLVM_DYLIB
CMake options, move BUILD_SHARED_LIBS out of frequently-used,
and add a note/warning to BUILD_SHARED_LIBS.
Reviewers: beanz, delcypher, mjacob
Subscribers: mjacob, llvm-commits
Differential Revision: http://reviews.llvm.org/D16208
llvm-svn: 257864
Diffstat (limited to 'llvm/docs/CMake.rst')
| -rw-r--r-- | llvm/docs/CMake.rst | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst index 9ec6b0a2416..7a1d0a3138a 100644 --- a/llvm/docs/CMake.rst +++ b/llvm/docs/CMake.rst @@ -197,12 +197,6 @@ CMake manual, or execute ``cmake --help-variable VARIABLE_NAME``. **CMAKE_CXX_FLAGS**:STRING Extra flags to use when compiling C++ source files. -**BUILD_SHARED_LIBS**:BOOL - Flag indicating if shared libraries will be built. Its default value is - OFF. This option is only recommended for use by LLVM developers. - On Windows, shared libraries may be used when building with MinGW, including - mingw-w64, but not when building with the Microsoft toolchain. - .. _LLVM-specific variables: LLVM-specific variables @@ -445,6 +439,27 @@ LLVM-specific variables $CMAKE_INSTALL_PREFIX/Toolchains containing an xctoolchain directory which can be used to override the default system tools. +**LLVM_BUILD_LLVM_DYLIB**:BOOL + If enabled, the target for building the libLLVM shared library is added. + Defaults to OFF. This cannot be used in conjunction with BUILD_SHARED_LIBS. + Tools will only be linked to the libLLVM shared library if + LLVM_LINK_LLVM_DYLIB is also ON. + +**LLVM_LINK_LLVM_DYLIB**:BOOL + If enabled, tools will be linked with the libLLVM shared library. Defaults + to OFF. Setting LLVM_LINK_LLVM_DYLIB to ON also sets LLVM_BUILD_LLVM_DYLIB + to ON. + +**BUILD_SHARED_LIBS**:BOOL + Flag indicating if shared libraries will be built instead of static + libraries. Its default value is OFF. On Windows, shared libraries may + be used when building with MinGW, including mingw-w64, but not when + building with the Microsoft toolchain. + + .. note:: BUILD_SHARED_LIBS is only recommended for use by LLVM developers. + If you want to build LLVM as a shared library, you should use the + ``LLVM_BUILD_LLVM_DYLIB`` option. + Executing the test suite ======================== |
