kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

InstallRequiredSystemLibraries: Format documentation

This commit is contained in:
Brad King 2015-03-03 09:14:29 -05:00
parent 1049feaab6
commit d6a320ab5e
1 changed files with 34 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
Modules/InstallRequiredSystemLibraries.cmake
View File

@ -2,33 +2,42 @@
# InstallRequiredSystemLibraries
# ------------------------------
#
# Include this module to search for compiler-provided system runtime
# libraries and add install rules for them. Some optional variables
# may be set prior to including the module to adjust behavior:
#
# ``CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS``
# Specify additional runtime libraries that may not be detected.
# After inclusion any detected libraries will be appended to this.
#
# By including this file, all library files listed in the variable
# CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS will be installed with
# install(PROGRAMS ...) into bin for WIN32 and lib for non-WIN32. If
# CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_SKIP is set to TRUE before including
# this file, then the INSTALL command is not called. The user can use
# the variable CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS to use a custom install
# command and install them however they want. If it is the MSVC
# compiler, then the microsoft run time libraries will be found and
# automatically added to the CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS, and
# installed. If CMAKE_INSTALL_DEBUG_LIBRARIES is set and it is the MSVC
# compiler, then the debug libraries are installed when available. If
# CMAKE_INSTALL_DEBUG_LIBRARIES_ONLY is set then only the debug
# libraries are installed when both debug and release are available. If
# CMAKE_INSTALL_MFC_LIBRARIES is set then the MFC run time libraries are
# installed as well as the CRT run time libraries. If
# CMAKE_INSTALL_OPENMP_LIBRARIES is set then the OpenMP run time libraries
# are installed as well. If
# CMAKE_INSTALL_SYSTEM_RUNTIME_DESTINATION is set then the libraries are
# installed to that directory rather than the default. If
# CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_NO_WARNINGS is NOT set, then this
# file warns about required files that do not exist. You can set this
# variable to ON before including this file to avoid the warning. For
# example, the Visual Studio Express editions do not include the
# redistributable files, so if you include this file on a machine with
# only VS Express installed, you'll get the warning.
# ``CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_SKIP``
# Set to TRUE to skip calling the :command:`install(PROGRAMS)` command to
# allow the includer to specify its own install rule, using the value of
# ``CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS`` to get the list of libraries.
#
# ``CMAKE_INSTALL_DEBUG_LIBRARIES``
# Set to TRUE to install the debug runtime libraries when available
# with MSVC tools.
#
# ``CMAKE_INSTALL_DEBUG_LIBRARIES_ONLY``
# Set to TRUE to install only the debug runtime libraries with MSVC
# tools even if the release runtime libraries are also available.
#
# ``CMAKE_INSTALL_MFC_LIBRARIES``
# Set to TRUE to install the MSVC MFC runtime libraries.
#
# ``CMAKE_INSTALL_OPENMP_LIBRARIES``
# Set to TRUE to install the MSVC OpenMP runtime libraries
#
# ``CMAKE_INSTALL_SYSTEM_RUNTIME_DESTINATION``
# Specify the :command:`install(PROGRAMS)` command ``DESTINATION``
# option. If not specified, the default is ``bin`` on Windows
# and ``lib`` elsewhere.
#
# ``CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_NO_WARNINGS``
# Set to TRUE to disable warnings about required library files that
# do not exist. (For example, Visual Studio Express editions may
# not provide the redistributable files.)
#=============================================================================
# Copyright 2006-2009 Kitware, Inc.