diff options
| author | Andrew Wilkins <axwalk@gmail.com> | 2016-01-19 05:43:21 +0000 |
|---|---|---|
| committer | Andrew Wilkins <axwalk@gmail.com> | 2016-01-19 05:43:21 +0000 |
| commit | 2a3810e8f7a45a118b5d55eb7f9d1e0cae363fd2 (patch) | |
| tree | 222b322715bd9ad404df276f011f303e1f4fd761 /llvm/docs/CMake.rst | |
| parent | b336bca07e0b0508e599d37f53cc479a940fb402 (diff) | |
| download | bcm5719-llvm-2a3810e8f7a45a118b5d55eb7f9d1e0cae363fd2.tar.gz bcm5719-llvm-2a3810e8f7a45a118b5d55eb7f9d1e0cae363fd2.zip | |
docs: address post-commit review
Rewording/expansion of CMake options
suggested by Dan Liew.
See http://reviews.llvm.org/D16208.
llvm-svn: 258112
Diffstat (limited to 'llvm/docs/CMake.rst')
| -rw-r--r-- | llvm/docs/CMake.rst | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst index 7a1d0a3138a..4e5feae9993 100644 --- a/llvm/docs/CMake.rst +++ b/llvm/docs/CMake.rst @@ -441,9 +441,12 @@ LLVM-specific variables **LLVM_BUILD_LLVM_DYLIB**:BOOL If enabled, the target for building the libLLVM shared library is added. + This library contains all of LLVM's components in a single shared library. 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. + Tools will only be linked to the libLLVM shared library if LLVM_LINK_LLVM_DYLIB + is also ON. + The components in the library can be customised by setting LLVM_DYLIB_COMPONENTS + to a list of the desired components. **LLVM_LINK_LLVM_DYLIB**:BOOL If enabled, tools will be linked with the libLLVM shared library. Defaults @@ -451,10 +454,10 @@ LLVM-specific variables 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. + Flag indicating if each LLVM component (e.g. Support) is built as a shared + library (ON) or as a static library (OFF). 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 |
