mirror of
https://github.com/reactos/CMake.git
synced 2024-11-28 05:50:42 +00:00
Help: Improve formatting of variable documentation
Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
This commit is contained in:
James Johnston
Brad King
parent
404d16e7bc
commit
3bb707f0a1
@ -27,6 +27,8 @@ in each directory of a source tree with the name CMakeLists.txt.
|
||||
Users build a project by using CMake to generate a build system for a
|
||||
native tool on their platform.
|
||||
|
||||
.. _`CMake Options`:
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
APPLE
|
||||
-----
|
||||
|
||||
True if running on Mac OS X.
|
||||
``True`` if running on Mac OS X.
|
||||
|
||||
Set to true on Mac OS X.
|
||||
Set to ``true`` on Mac OS X.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
BORLAND
|
||||
-------
|
||||
|
||||
True if the Borland compiler is being used.
|
||||
``True`` if the Borland compiler is being used.
|
||||
|
||||
This is set to true if the Borland compiler is being used.
|
||||
This is set to ``true`` if the Borland compiler is being used.
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
BUILD_SHARED_LIBS
|
||||
-----------------
|
||||
|
||||
Global flag to cause add_library to create shared libraries if on.
|
||||
Global flag to cause :command:`add_library` to create shared libraries if on.
|
||||
|
||||
If present and true, this will cause all libraries to be built shared
|
||||
unless the library was explicitly added as a static library. This
|
||||
variable is often added to projects as an OPTION so that each user of
|
||||
a project can decide if they want to build the project using shared or
|
||||
variable is often added to projects as an :command:`option` so that each user
|
||||
of a project can decide if they want to build the project using shared or
|
||||
static libraries.
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
CMAKE_ABSOLUTE_DESTINATION_FILES
|
||||
--------------------------------
|
||||
|
||||
List of files which have been installed using an ABSOLUTE DESTINATION path.
|
||||
List of files which have been installed using an ``ABSOLUTE DESTINATION`` path.
|
||||
|
||||
This variable is defined by CMake-generated cmake_install.cmake
|
||||
This variable is defined by CMake-generated ``cmake_install.cmake``
|
||||
scripts. It can be used (read-only) by programs or scripts that
|
||||
source those install scripts. This is used by some CPack generators
|
||||
(e.g. RPM).
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES
|
||||
-------------------------------------
|
||||
|
||||
Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DEPENDENCIES` target property.
|
||||
See that target property for additional information.
|
||||
Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DEPENDENCIES` target
|
||||
property. See that target property for additional information.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES
|
||||
------------------------------------
|
||||
|
||||
Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DIRECTORIES` target property.
|
||||
See that target property for additional information.
|
||||
Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DIRECTORIES` target
|
||||
property. See that target property for additional information.
|
||||
|
||||
@ -3,5 +3,6 @@ CMAKE_ARGC
|
||||
|
||||
Number of command line arguments passed to CMake in script mode.
|
||||
|
||||
When run in -P script mode, CMake sets this variable to the number of
|
||||
command line arguments. See also CMAKE_ARGV0, 1, 2 ...
|
||||
When run in :ref:`-P <CMake Options>` script mode, CMake sets this variable to
|
||||
the number of command line arguments. See also :variable:`CMAKE_ARGV0`,
|
||||
``1``, ``2`` ...
|
||||
|
||||
@ -3,7 +3,7 @@ CMAKE_ARGV0
|
||||
|
||||
Command line argument passed to CMake in script mode.
|
||||
|
||||
When run in -P script mode, CMake sets this variable to the first
|
||||
command line argument. It then also sets CMAKE_ARGV1, CMAKE_ARGV2,
|
||||
... and so on, up to the number of command line arguments given. See
|
||||
also CMAKE_ARGC.
|
||||
When run in :ref:`-P <CMake Options>` script mode, CMake sets this variable to
|
||||
the first command line argument. It then also sets ``CMAKE_ARGV1``,
|
||||
``CMAKE_ARGV2``, ... and so on, up to the number of command line arguments
|
||||
given. See also :variable:`CMAKE_ARGC`.
|
||||
|
||||
@ -3,11 +3,11 @@ CMAKE_AUTOMOC_RELAXED_MODE
|
||||
|
||||
Switch between strict and relaxed automoc mode.
|
||||
|
||||
By default, :prop_tgt:`AUTOMOC` behaves exactly as described in the documentation
|
||||
of the :prop_tgt:`AUTOMOC` target property. When set to ``TRUE``, it accepts more
|
||||
input and tries to find the correct input file for ``moc`` even if it
|
||||
differs from the documented behaviour. In this mode it e.g. also
|
||||
checks whether a header file is intended to be processed by moc when a
|
||||
``"foo.moc"`` file has been included.
|
||||
By default, :prop_tgt:`AUTOMOC` behaves exactly as described in the
|
||||
documentation of the :prop_tgt:`AUTOMOC` target property. When set to
|
||||
``TRUE``, it accepts more input and tries to find the correct input file for
|
||||
``moc`` even if it differs from the documented behaviour. In this mode it
|
||||
e.g. also checks whether a header file is intended to be processed by moc
|
||||
when a ``"foo.moc"`` file has been included.
|
||||
|
||||
Relaxed mode has to be enabled for KDE4 compatibility.
|
||||
|
||||
@ -3,5 +3,5 @@ CMAKE_AUTORCC
|
||||
|
||||
Whether to handle ``rcc`` automatically for Qt targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`AUTORCC` property on all the targets.
|
||||
See that target property for additional information.
|
||||
This variable is used to initialize the :prop_tgt:`AUTORCC` property on all
|
||||
the targets. See that target property for additional information.
|
||||
|
||||
@ -3,5 +3,5 @@ CMAKE_AUTOUIC
|
||||
|
||||
Whether to handle ``uic`` automatically for Qt targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`AUTOUIC` property on all the targets.
|
||||
See that target property for additional information.
|
||||
This variable is used to initialize the :prop_tgt:`AUTOUIC` property on all
|
||||
the targets. See that target property for additional information.
|
||||
|
||||
@ -5,4 +5,4 @@ The path to the top level of the build tree.
|
||||
|
||||
This is the full path to the top level of the current CMake build
|
||||
tree. For an in-source build, this would be the same as
|
||||
CMAKE_SOURCE_DIR.
|
||||
:variable:`CMAKE_SOURCE_DIR`.
|
||||
|
||||
@ -4,16 +4,17 @@ CMAKE_BUILD_TYPE
|
||||
Specifies the build type on single-configuration generators.
|
||||
|
||||
This statically specifies what build type (configuration) will be
|
||||
built in this build tree. Possible values are empty, Debug, Release,
|
||||
RelWithDebInfo and MinSizeRel. This variable is only meaningful to
|
||||
single-configuration generators (such as make and Ninja) i.e. those
|
||||
which choose a single configuration when CMake runs to generate a
|
||||
build tree as opposed to multi-configuration generators which offer
|
||||
selection of the build configuration within the generated build
|
||||
built in this build tree. Possible values are empty, ``Debug``, ``Release``,
|
||||
``RelWithDebInfo`` and ``MinSizeRel``. This variable is only meaningful to
|
||||
single-configuration generators (such as :ref:`Makefile Generators` and
|
||||
:generator:`Ninja`) i.e. those which choose a single configuration when CMake
|
||||
runs to generate a build tree as opposed to multi-configuration generators
|
||||
which offer selection of the build configuration within the generated build
|
||||
environment. There are many per-config properties and variables
|
||||
(usually following clean SOME_VAR_<CONFIG> order conventions), such as
|
||||
CMAKE_C_FLAGS_<CONFIG>, specified as uppercase:
|
||||
CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. For example,
|
||||
in a build tree configured to build type Debug, CMake will see to
|
||||
having CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS
|
||||
settings. See also CMAKE_CONFIGURATION_TYPES.
|
||||
(usually following clean ``SOME_VAR_<CONFIG>`` order conventions), such as
|
||||
``CMAKE_C_FLAGS_<CONFIG>``, specified as uppercase:
|
||||
``CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]``. For example,
|
||||
in a build tree configured to build type ``Debug``, CMake will see to
|
||||
having :variable:`CMAKE_C_FLAGS_DEBUG <CMAKE_<LANG>_FLAGS_DEBUG>` settings get
|
||||
added to the :variable:`CMAKE_C_FLAGS <CMAKE_<LANG>_FLAGS>` settings. See
|
||||
also :variable:`CMAKE_CONFIGURATION_TYPES`.
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
CMAKE_BUILD_WITH_INSTALL_RPATH
|
||||
------------------------------
|
||||
|
||||
Use the install path for the RPATH
|
||||
Use the install path for the ``RPATH``.
|
||||
|
||||
Normally CMake uses the build tree for the RPATH when building
|
||||
executables etc on systems that use RPATH. When the software is
|
||||
Normally CMake uses the build tree for the ``RPATH`` when building
|
||||
executables etc on systems that use ``RPATH``. When the software is
|
||||
installed the executables etc are relinked by CMake to have the
|
||||
install RPATH. If this variable is set to true then the software is
|
||||
always built with the install path for the RPATH and does not need to
|
||||
install ``RPATH``. If this variable is set to true then the software is
|
||||
always built with the install path for the ``RPATH`` and does not need to
|
||||
be relinked when installed.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_CACHEFILE_DIR
|
||||
-------------------
|
||||
|
||||
The directory with the CMakeCache.txt file.
|
||||
The directory with the ``CMakeCache.txt`` file.
|
||||
|
||||
This is the full path to the directory that has the CMakeCache.txt
|
||||
file in it. This is the same as CMAKE_BINARY_DIR.
|
||||
This is the full path to the directory that has the ``CMakeCache.txt``
|
||||
file in it. This is the same as :variable:`CMAKE_BINARY_DIR`.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_CACHE_MAJOR_VERSION
|
||||
-------------------------
|
||||
|
||||
Major version of CMake used to create the CMakeCache.txt file
|
||||
Major version of CMake used to create the ``CMakeCache.txt`` file
|
||||
|
||||
This stores the major version of CMake used to write a CMake cache
|
||||
file. It is only different when a different version of CMake is run
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_CACHE_MINOR_VERSION
|
||||
-------------------------
|
||||
|
||||
Minor version of CMake used to create the CMakeCache.txt file
|
||||
Minor version of CMake used to create the ``CMakeCache.txt`` file
|
||||
|
||||
This stores the minor version of CMake used to write a CMake cache
|
||||
file. It is only different when a different version of CMake is run
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_CACHE_PATCH_VERSION
|
||||
-------------------------
|
||||
|
||||
Patch version of CMake used to create the CMakeCache.txt file
|
||||
Patch version of CMake used to create the ``CMakeCache.txt`` file
|
||||
|
||||
This stores the patch version of CMake used to write a CMake cache
|
||||
file. It is only different when a different version of CMake is run
|
||||
|
||||
@ -4,11 +4,11 @@ CMAKE_CFG_INTDIR
|
||||
Build-time reference to per-configuration output subdirectory.
|
||||
|
||||
For native build systems supporting multiple configurations in the
|
||||
build tree (such as Visual Studio and Xcode), the value is a reference
|
||||
to a build-time variable specifying the name of the per-configuration
|
||||
output subdirectory. On Makefile generators this evaluates to "."
|
||||
because there is only one configuration in a build tree. Example
|
||||
values:
|
||||
build tree (such as :ref:`Visual Studio Generators` and :generator:`Xcode`),
|
||||
the value is a reference to a build-time variable specifying the name
|
||||
of the per-configuration output subdirectory. On :ref:`Makefile Generators`
|
||||
this evaluates to `.` because there is only one configuration in a build tree.
|
||||
Example values:
|
||||
|
||||
::
|
||||
|
||||
@ -33,13 +33,14 @@ evaluated at build time. Example of intended usage:
|
||||
)
|
||||
add_custom_target(drive ALL DEPENDS out.txt)
|
||||
|
||||
Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose but
|
||||
Note that ``CMAKE_CFG_INTDIR`` is no longer necessary for this purpose but
|
||||
has been left for compatibility with existing projects. Instead
|
||||
add_custom_command() recognizes executable target names in its COMMAND
|
||||
option, so "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool"
|
||||
can be replaced by just "mytool".
|
||||
:command:`add_custom_command` recognizes executable target names in its
|
||||
``COMMAND`` option, so
|
||||
``${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool`` can be replaced
|
||||
by just ``mytool``.
|
||||
|
||||
This variable is read-only. Setting it is undefined behavior. In
|
||||
multi-configuration build systems the value of this variable is passed
|
||||
as the value of preprocessor symbol "CMAKE_INTDIR" to the compilation
|
||||
as the value of preprocessor symbol ``CMAKE_INTDIR`` to the compilation
|
||||
of all source files.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
CMAKE_CL_64
|
||||
-----------
|
||||
|
||||
Using the 64 bit compiler from Microsoft
|
||||
Using the 64-bit compiler from Microsoft
|
||||
|
||||
Set to true when using the 64 bit cl compiler from Microsoft.
|
||||
Set to ``true`` when using the 64-bit ``cl`` compiler from Microsoft.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_COLOR_MAKEFILE
|
||||
--------------------
|
||||
|
||||
Enables color output when using the Makefile generator.
|
||||
Enables color output when using the :ref:`Makefile Generators`.
|
||||
|
||||
When enabled, the generated Makefiles will produce colored output.
|
||||
Default is ON.
|
||||
Default is ``ON``.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
CMAKE_COMMAND
|
||||
-------------
|
||||
|
||||
The full path to the cmake executable.
|
||||
The full path to the :manual:`cmake(1)` executable.
|
||||
|
||||
This is the full path to the CMake executable cmake which is useful
|
||||
from custom commands that want to use the cmake -E option for portable
|
||||
system commands. (e.g. /usr/local/bin/cmake
|
||||
This is the full path to the CMake executable :manual:`cmake(1)` which is
|
||||
useful from custom commands that want to use the ``cmake -E`` option for
|
||||
portable system commands. (e.g. ``/usr/local/bin/cmake``)
|
||||
|
||||
@ -3,10 +3,10 @@ CMAKE_COMPILER_IS_GNU<LANG>
|
||||
|
||||
True if the compiler is GNU.
|
||||
|
||||
If the selected <LANG> compiler is the GNU compiler then this is TRUE,
|
||||
if not it is FALSE. Unlike the other per-language variables, this
|
||||
If the selected ``<LANG>`` compiler is the GNU compiler then this is ``TRUE``,
|
||||
if not it is ``FALSE``. Unlike the other per-language variables, this
|
||||
uses the GNU syntax for identifying languages instead of the CMake
|
||||
syntax. Recognized values of the <LANG> suffix are:
|
||||
syntax. Recognized values of the ``<LANG>`` suffix are:
|
||||
|
||||
::
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ CMAKE_CONFIGURATION_TYPES
|
||||
Specifies the available build types on multi-config generators.
|
||||
|
||||
This specifies what build types (configurations) will be available
|
||||
such as Debug, Release, RelWithDebInfo etc. This has reasonable
|
||||
such as ``Debug``, ``Release``, ``RelWithDebInfo`` etc. This has reasonable
|
||||
defaults on most platforms, but can be extended to provide other build
|
||||
types. See also CMAKE_BUILD_TYPE for details of managing
|
||||
configuration data, and CMAKE_CFG_INTDIR.
|
||||
types. See also :variable:`CMAKE_BUILD_TYPE` for details of managing
|
||||
configuration data, and :variable:`CMAKE_CFG_INTDIR`.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_<CONFIG>_POSTFIX
|
||||
----------------------
|
||||
|
||||
Default filename postfix for libraries under configuration <CONFIG>.
|
||||
Default filename postfix for libraries under configuration ``<CONFIG>``.
|
||||
|
||||
When a non-executable target is created its <CONFIG>_POSTFIX target
|
||||
property is initialized with the value of this variable if it is set.
|
||||
When a non-executable target is created its :prop_tgt:`<CONFIG>_POSTFIX`
|
||||
target property is initialized with the value of this variable if it is set.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
CMAKE_CTEST_COMMAND
|
||||
-------------------
|
||||
|
||||
Full path to ctest command installed with cmake.
|
||||
Full path to :manual:`ctest(1)` command installed with CMake.
|
||||
|
||||
This is the full path to the CTest executable ctest which is useful
|
||||
from custom commands that want to use the cmake -E option for portable
|
||||
system commands.
|
||||
This is the full path to the CTest executable :manual:`ctest(1)` which is
|
||||
useful from custom commands that want to use the :manual:`cmake(1)` ``-E``
|
||||
option for portable system commands.
|
||||
|
||||
@ -4,7 +4,7 @@ CMAKE_CURRENT_BINARY_DIR
|
||||
The path to the binary directory currently being processed.
|
||||
|
||||
This the full path to the build directory that is currently being
|
||||
processed by cmake. Each directory added by add_subdirectory will
|
||||
processed by cmake. Each directory added by :command:`add_subdirectory` will
|
||||
create a binary directory in the build tree, and as it is being
|
||||
processed this variable will be set. For in-source builds this is the
|
||||
current source directory being processed.
|
||||
|
||||
@ -5,8 +5,8 @@ Full directory of the listfile currently being processed.
|
||||
|
||||
As CMake processes the listfiles in your project this variable will
|
||||
always be set to the directory where the listfile which is currently
|
||||
being processed (CMAKE_CURRENT_LIST_FILE) is located. The value has
|
||||
dynamic scope. When CMake starts processing commands in a source file
|
||||
being processed (:variable:`CMAKE_CURRENT_LIST_FILE`) is located. The value
|
||||
has dynamic scope. When CMake starts processing commands in a source file
|
||||
it sets this variable to the directory where this file is located.
|
||||
When CMake finishes processing commands from the file it restores the
|
||||
previous value. Therefore the value of the variable inside a macro or
|
||||
@ -14,4 +14,4 @@ function is the directory of the file invoking the bottom-most entry
|
||||
on the call stack, not the directory of the file containing the macro
|
||||
or function definition.
|
||||
|
||||
See also CMAKE_CURRENT_LIST_FILE.
|
||||
See also :variable:`CMAKE_CURRENT_LIST_FILE`.
|
||||
|
||||
@ -12,4 +12,4 @@ value. Therefore the value of the variable inside a macro or function
|
||||
is the file invoking the bottom-most entry on the call stack, not the
|
||||
file containing the macro or function definition.
|
||||
|
||||
See also CMAKE_PARENT_LIST_FILE.
|
||||
See also :variable:`CMAKE_PARENT_LIST_FILE`.
|
||||
|
||||
@ -4,8 +4,8 @@ CMAKE_CXX_COMPILE_FEATURES
|
||||
List of features known to the C++ compiler
|
||||
|
||||
These features are known to be available for use with the C++ compiler. This
|
||||
list is a subset of the features listed in the :prop_gbl:`CMAKE_CXX_KNOWN_FEATURES`
|
||||
global property.
|
||||
list is a subset of the features listed in the
|
||||
:prop_gbl:`CMAKE_CXX_KNOWN_FEATURES` global property.
|
||||
|
||||
See the :manual:`cmake-compile-features(7)` manual for information on
|
||||
compile features and a list of supported compilers.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_CXX_EXTENSIONS
|
||||
--------------------
|
||||
|
||||
Default value for ``CXX_EXTENSIONS`` property of targets.
|
||||
Default value for :prop_tgt:`CXX_EXTENSIONS` property of targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`CXX_EXTENSIONS`
|
||||
property on all targets. See that target property for additional
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_CXX_STANDARD
|
||||
------------------
|
||||
|
||||
Default value for ``CXX_STANDARD`` property of targets.
|
||||
Default value for :prop_tgt:`CXX_STANDARD` property of targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`CXX_STANDARD`
|
||||
property on all targets. See that target property for additional
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_CXX_STANDARD_REQUIRED
|
||||
---------------------------
|
||||
|
||||
Default value for ``CXX_STANDARD_REQUIRED`` property of targets.
|
||||
Default value for :prop_tgt:`CXX_STANDARD_REQUIRED` property of targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`CXX_STANDARD_REQUIRED`
|
||||
property on all targets. See that target property for additional
|
||||
|
||||
@ -4,8 +4,8 @@ CMAKE_C_COMPILE_FEATURES
|
||||
List of features known to the C compiler
|
||||
|
||||
These features are known to be available for use with the C compiler. This
|
||||
list is a subset of the features listed in the :prop_gbl:`CMAKE_C_KNOWN_FEATURES`
|
||||
global property.
|
||||
list is a subset of the features listed in the
|
||||
:prop_gbl:`CMAKE_C_KNOWN_FEATURES` global property.
|
||||
|
||||
See the :manual:`cmake-compile-features(7)` manual for information on
|
||||
compile features and a list of supported compilers.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_C_EXTENSIONS
|
||||
------------------
|
||||
|
||||
Default value for ``C_EXTENSIONS`` property of targets.
|
||||
Default value for :prop_tgt:`C_EXTENSIONS` property of targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`C_EXTENSIONS`
|
||||
property on all targets. See that target property for additional
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_C_STANDARD
|
||||
----------------
|
||||
|
||||
Default value for ``C_STANDARD`` property of targets.
|
||||
Default value for :prop_tgt:`C_STANDARD` property of targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`C_STANDARD`
|
||||
property on all targets. See that target property for additional
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_C_STANDARD_REQUIRED
|
||||
-------------------------
|
||||
|
||||
Default value for ``C_STANDARD_REQUIRED`` property of targets.
|
||||
Default value for :prop_tgt:`C_STANDARD_REQUIRED` property of targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`C_STANDARD_REQUIRED`
|
||||
property on all targets. See that target property for additional
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_DEBUG_POSTFIX
|
||||
-------------------
|
||||
|
||||
See variable CMAKE_<CONFIG>_POSTFIX.
|
||||
See variable :variable:`CMAKE_<CONFIG>_POSTFIX`.
|
||||
|
||||
This variable is a special case of the more-general
|
||||
CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration.
|
||||
:variable:`CMAKE_<CONFIG>_POSTFIX` variable for the `DEBUG` configuration.
|
||||
|
||||
@ -9,6 +9,6 @@ only be used when evaluating the :prop_tgt:`INCLUDE_DIRECTORIES`,
|
||||
:prop_tgt:`COMPILE_DEFINITIONS`, :prop_tgt:`COMPILE_OPTIONS`,
|
||||
:prop_tgt:`AUTOUIC_OPTIONS`, :prop_tgt:`SOURCES`, :prop_tgt:`COMPILE_FEATURES`,
|
||||
:prop_tgt:`POSITION_INDEPENDENT_CODE` target properties and any other property
|
||||
listed in :prop_tgt:`COMPATIBLE_INTERFACE_STRING` and other ``COMPATIBLE_INTERFACE_``
|
||||
properties. It outputs an origin for each entry in the target property.
|
||||
Default is unset.
|
||||
listed in :prop_tgt:`COMPATIBLE_INTERFACE_STRING` and other
|
||||
``COMPATIBLE_INTERFACE_`` properties. It outputs an origin for each entry in
|
||||
the target property. Default is unset.
|
||||
|
||||
@ -1,10 +1,11 @@
|
||||
CMAKE_DISABLE_FIND_PACKAGE_<PackageName>
|
||||
----------------------------------------
|
||||
|
||||
Variable for disabling find_package() calls.
|
||||
Variable for disabling :command:`find_package` calls.
|
||||
|
||||
Every non-REQUIRED find_package() call in a project can be disabled by
|
||||
setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE.
|
||||
Every non-``REQUIRED`` :command:`find_package` call in a project can be
|
||||
disabled by setting the variable
|
||||
``CMAKE_DISABLE_FIND_PACKAGE_<PackageName>`` to ``TRUE``.
|
||||
This can be used to build a project without an optional package,
|
||||
although that package is installed.
|
||||
|
||||
@ -12,4 +13,4 @@ This switch should be used during the initial CMake run. Otherwise if
|
||||
the package has already been found in a previous CMake run, the
|
||||
variables which have been stored in the cache will still be there. In
|
||||
that case it is recommended to remove the cache variables for this
|
||||
package from the cache using the cache editor or cmake -U
|
||||
package from the cache using the cache editor or :manual:`cmake(1)` ``-U``
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_DL_LIBS
|
||||
-------------
|
||||
|
||||
Name of library containing dlopen and dlcose.
|
||||
Name of library containing ``dlopen`` and ``dlcose``.
|
||||
|
||||
The name of the library that has dlopen and dlclose in it, usually
|
||||
-ldl on most UNIX machines.
|
||||
The name of the library that has ``dlopen`` and ``dlclose`` in it, usually
|
||||
``-ldl`` on most UNIX machines.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
CMAKE_EDIT_COMMAND
|
||||
------------------
|
||||
|
||||
Full path to cmake-gui or ccmake. Defined only for Makefile generators
|
||||
when not using an "extra" generator for an IDE.
|
||||
Full path to :manual:`cmake-gui(1)` or :manual:`ccmake(1)`. Defined only for
|
||||
:ref:`Makefile Generators` when not using an "extra" generator for an IDE.
|
||||
|
||||
This is the full path to the CMake executable that can graphically
|
||||
edit the cache. For example, cmake-gui or ccmake.
|
||||
edit the cache. For example, :manual:`cmake-gui(1)` or :manual:`ccmake(1)`.
|
||||
|
||||
@ -3,9 +3,9 @@ CMAKE_ERROR_DEPRECATED
|
||||
|
||||
Whether to issue deprecation errors for macros and functions.
|
||||
|
||||
If TRUE, this can be used by macros and functions to issue fatal
|
||||
If ``TRUE``, this can be used by macros and functions to issue fatal
|
||||
errors when deprecated macros or functions are used. This variable is
|
||||
FALSE by default.
|
||||
``FALSE`` by default.
|
||||
|
||||
These errors can be enabled with the ``-Werror=deprecated`` option, or
|
||||
disabled with the ``-Wno-error=deprecated`` option, when running
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
|
||||
-------------------------------------------
|
||||
|
||||
Ask cmake_install.cmake script to error out as soon as a file with absolute INSTALL DESTINATION is encountered.
|
||||
Ask ``cmake_install.cmake`` script to error out as soon as a file with
|
||||
absolute ``INSTALL DESTINATION`` is encountered.
|
||||
|
||||
The fatal error is emitted before the installation of the offending
|
||||
file takes place. This variable is used by CMake-generated
|
||||
cmake_install.cmake scripts. If one sets this variable to ON while
|
||||
``cmake_install.cmake`` scripts. If one sets this variable to ``ON`` while
|
||||
running the script, it may get fatal error messages from the script.
|
||||
|
||||
@ -3,7 +3,7 @@ CMAKE_EXECUTABLE_SUFFIX
|
||||
|
||||
The suffix for executables on this platform.
|
||||
|
||||
The suffix to use for the end of an executable filename if any, .exe
|
||||
The suffix to use for the end of an executable filename if any, ``.exe``
|
||||
on Windows.
|
||||
|
||||
CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>.
|
||||
``CMAKE_EXECUTABLE_SUFFIX_<LANG>`` overrides this for language ``<LANG>``.
|
||||
|
||||
@ -3,5 +3,5 @@ CMAKE_EXE_LINKER_FLAGS_<CONFIG>
|
||||
|
||||
Flags to be used when linking an executable.
|
||||
|
||||
Same as CMAKE_C_FLAGS_* but used by the linker when creating
|
||||
Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating
|
||||
executables.
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
CMAKE_EXTRA_GENERATOR
|
||||
---------------------
|
||||
|
||||
The extra generator used to build the project.
|
||||
The extra generator used to build the project. See
|
||||
:manual:`cmake-generators(7)`.
|
||||
|
||||
When using the Eclipse, CodeBlocks or KDevelop generators, CMake
|
||||
generates Makefiles (CMAKE_GENERATOR) and additionally project files
|
||||
for the respective IDE. This IDE project file generator is stored in
|
||||
CMAKE_EXTRA_GENERATOR (e.g. "Eclipse CDT4").
|
||||
generates Makefiles (:variable:`CMAKE_GENERATOR`) and additionally project
|
||||
files for the respective IDE. This IDE project file generator is stored in
|
||||
``CMAKE_EXTRA_GENERATOR`` (e.g. ``Eclipse CDT4``).
|
||||
|
||||
@ -4,6 +4,6 @@ CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES
|
||||
Additional suffixes for shared libraries.
|
||||
|
||||
Extensions for shared libraries other than that specified by
|
||||
CMAKE_SHARED_LIBRARY_SUFFIX, if any. CMake uses this to recognize
|
||||
:variable:`CMAKE_SHARED_LIBRARY_SUFFIX`, if any. CMake uses this to recognize
|
||||
external shared library files during analysis of libraries linked by a
|
||||
target.
|
||||
|
||||
@ -4,6 +4,6 @@ CMAKE_FIND_LIBRARY_PREFIXES
|
||||
Prefixes to prepend when looking for libraries.
|
||||
|
||||
This specifies what prefixes to add to library names when the
|
||||
find_library command looks for libraries. On UNIX systems this is
|
||||
typically lib, meaning that when trying to find the foo library it
|
||||
will look for libfoo.
|
||||
:command:`find_library` command looks for libraries. On UNIX systems this is
|
||||
typically ``lib``, meaning that when trying to find the ``foo`` library it
|
||||
will look for ``libfoo``.
|
||||
|
||||
@ -4,6 +4,6 @@ CMAKE_FIND_LIBRARY_SUFFIXES
|
||||
Suffixes to append when looking for libraries.
|
||||
|
||||
This specifies what suffixes to add to library names when the
|
||||
find_library command looks for libraries. On Windows systems this is
|
||||
typically .lib and .dll, meaning that when trying to find the foo
|
||||
library it will look for foo.dll etc.
|
||||
:command:`find_library` command looks for libraries. On Windows systems this
|
||||
is typically ``.lib`` and ``.dll``, meaning that when trying to find the
|
||||
``foo`` library it will look for ``foo.dll`` etc.
|
||||
|
||||
@ -8,8 +8,8 @@ CMake adds the :variable:`CMAKE_INSTALL_PREFIX` and the
|
||||
:variable:`CMAKE_SYSTEM_PREFIX_PATH` by default. This variable may be set
|
||||
on the command line to control that behavior.
|
||||
|
||||
Set :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` to TRUE to tell find_package not
|
||||
to search in the :variable:`CMAKE_INSTALL_PREFIX` or
|
||||
:variable:`CMAKE_STAGING_PREFIX` by default. Note that the
|
||||
Set ``CMAKE_FIND_NO_INSTALL_PREFIX`` to ``TRUE`` to tell
|
||||
:command:`find_package` not to search in the :variable:`CMAKE_INSTALL_PREFIX`
|
||||
or :variable:`CMAKE_STAGING_PREFIX` by default. Note that the
|
||||
prefix may still be searched for other reasons, such as being the same prefix
|
||||
as the CMake installation, or for being a built-in system prefix.
|
||||
|
||||
@ -1,19 +1,19 @@
|
||||
CMAKE_FIND_PACKAGE_WARN_NO_MODULE
|
||||
---------------------------------
|
||||
|
||||
Tell find_package to warn if called without an explicit mode.
|
||||
Tell :command:`find_package` to warn if called without an explicit mode.
|
||||
|
||||
If find_package is called without an explicit mode option (MODULE,
|
||||
CONFIG or NO_MODULE) and no Find<pkg>.cmake module is in
|
||||
CMAKE_MODULE_PATH then CMake implicitly assumes that the caller
|
||||
intends to search for a package configuration file. If no package
|
||||
If :command:`find_package` is called without an explicit mode option
|
||||
(``MODULE``, ``CONFIG``, or ``NO_MODULE``) and no ``Find<pkg>.cmake`` module
|
||||
is in :variable:`CMAKE_MODULE_PATH` then CMake implicitly assumes that the
|
||||
caller intends to search for a package configuration file. If no package
|
||||
configuration file is found then the wording of the failure message
|
||||
must account for both the case that the package is really missing and
|
||||
the case that the project has a bug and failed to provide the intended
|
||||
Find module. If instead the caller specifies an explicit mode option
|
||||
then the failure message can be more specific.
|
||||
|
||||
Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package to
|
||||
warn when it implicitly assumes Config mode. This helps developers
|
||||
enforce use of an explicit mode in all calls to find_package within a
|
||||
project.
|
||||
Set ``CMAKE_FIND_PACKAGE_WARN_NO_MODULE`` to ``TRUE`` to tell
|
||||
:command:`find_package` to warn when it implicitly assumes Config mode. This
|
||||
helps developers enforce use of an explicit mode in all calls to
|
||||
:command:`find_package` within a project.
|
||||
|
||||
@ -4,5 +4,5 @@ CMAKE_FIND_ROOT_PATH
|
||||
:ref:`;-list <CMake Language Lists>` of root paths to search on the filesystem.
|
||||
|
||||
This variable is most useful when cross-compiling. CMake uses the paths in
|
||||
this list as alternative roots to find filesystem items with :command:`find_package`,
|
||||
:command:`find_library` etc.
|
||||
this list as alternative roots to find filesystem items with
|
||||
:command:`find_package`, :command:`find_library` etc.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_Fortran_FORMAT
|
||||
--------------------
|
||||
|
||||
Set to FIXED or FREE to indicate the Fortran source layout.
|
||||
Set to ``FIXED`` or ``FREE`` to indicate the Fortran source layout.
|
||||
|
||||
This variable is used to initialize the Fortran_FORMAT property on all
|
||||
the targets. See that target property for additional information.
|
||||
This variable is used to initialize the :prop_tgt:`Fortran_FORMAT` property on
|
||||
all the targets. See that target property for additional information.
|
||||
|
||||
@ -3,6 +3,6 @@ CMAKE_Fortran_MODDIR_DEFAULT
|
||||
|
||||
Fortran default module output directory.
|
||||
|
||||
Most Fortran compilers write .mod files to the current working
|
||||
directory. For those that do not, this is set to "." and used when
|
||||
the Fortran_MODULE_DIRECTORY target property is not set.
|
||||
Most Fortran compilers write ``.mod`` files to the current working
|
||||
directory. For those that do not, this is set to ``.`` and used when
|
||||
the :prop_tgt:`Fortran_MODULE_DIRECTORY` target property is not set.
|
||||
|
||||
@ -4,4 +4,4 @@ CMAKE_Fortran_MODDIR_FLAG
|
||||
Fortran flag for module output directory.
|
||||
|
||||
This stores the flag needed to pass the value of the
|
||||
Fortran_MODULE_DIRECTORY target property to the compiler.
|
||||
:prop_tgt:`Fortran_MODULE_DIRECTORY` target property to the compiler.
|
||||
|
||||
@ -3,5 +3,5 @@ CMAKE_Fortran_MODOUT_FLAG
|
||||
|
||||
Fortran flag to enable module output.
|
||||
|
||||
Most Fortran compilers write .mod files out by default. For others,
|
||||
Most Fortran compilers write ``.mod`` files out by default. For others,
|
||||
this stores the flag needed to enable module output.
|
||||
|
||||
@ -3,6 +3,6 @@ CMAKE_Fortran_MODULE_DIRECTORY
|
||||
|
||||
Fortran module output directory.
|
||||
|
||||
This variable is used to initialize the Fortran_MODULE_DIRECTORY
|
||||
This variable is used to initialize the :prop_tgt:`Fortran_MODULE_DIRECTORY`
|
||||
property on all the targets. See that target property for additional
|
||||
information.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_GENERATOR
|
||||
---------------
|
||||
|
||||
The generator used to build the project.
|
||||
The generator used to build the project. See :manual:`cmake-generators(7)`.
|
||||
|
||||
The name of the generator that is being used to generate the build
|
||||
files. (e.g. "Unix Makefiles", "Visual Studio 6", etc.)
|
||||
files. (e.g. ``Unix Makefiles``, ``Visual Studio 6``, etc.)
|
||||
|
||||
@ -5,8 +5,8 @@ Generator-specific target platform name specified by user.
|
||||
|
||||
Some CMake generators support a target platform name to be given
|
||||
to the native build system to choose a compiler toolchain.
|
||||
If the user specifies a platform name (e.g. via the cmake -A option)
|
||||
the value will be available in this variable.
|
||||
If the user specifies a platform name (e.g. via the :manual:`cmake(1)` ``-A``
|
||||
option) the value will be available in this variable.
|
||||
|
||||
The value of this variable should never be modified by project code.
|
||||
A toolchain file specified by the :variable:`CMAKE_TOOLCHAIN_FILE`
|
||||
|
||||
@ -5,8 +5,8 @@ Native build system toolset name specified by user.
|
||||
|
||||
Some CMake generators support a toolset name to be given to the native
|
||||
build system to choose a compiler. If the user specifies a toolset
|
||||
name (e.g. via the cmake -T option) the value will be available in
|
||||
this variable.
|
||||
name (e.g. via the :manual:`cmake(1)` ``-T`` option) the value will be
|
||||
available in this variable.
|
||||
|
||||
The value of this variable should never be modified by project code.
|
||||
A toolchain file specified by the :variable:`CMAKE_TOOLCHAIN_FILE`
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
CMAKE_GNUtoMS
|
||||
-------------
|
||||
|
||||
Convert GNU import libraries (.dll.a) to MS format (.lib).
|
||||
Convert GNU import libraries (``.dll.a``) to MS format (``.lib``).
|
||||
|
||||
This variable is used to initialize the GNUtoMS property on targets
|
||||
when they are created. See that target property for additional
|
||||
This variable is used to initialize the :prop_tgt:`GNUtoMS` property on
|
||||
targets when they are created. See that target property for additional
|
||||
information.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
CMAKE_HOST_APPLE
|
||||
----------------
|
||||
|
||||
True for Apple OS X operating systems.
|
||||
``True`` for Apple OS X operating systems.
|
||||
|
||||
Set to true when the host system is Apple OS X.
|
||||
Set to ``true`` when the host system is Apple OS X.
|
||||
|
||||
@ -4,5 +4,5 @@ CMAKE_HOST_SYSTEM_NAME
|
||||
Name of the OS CMake is running on.
|
||||
|
||||
On systems that have the uname command, this variable is set to the
|
||||
output of uname -s. ``Linux``, ``Windows``, and ``Darwin`` for Mac OS X
|
||||
output of ``uname -s``. ``Linux``, ``Windows``, and ``Darwin`` for Mac OS X
|
||||
are the values found on the big three operating systems.
|
||||
|
||||
@ -3,6 +3,6 @@ CMAKE_HOST_SYSTEM_PROCESSOR
|
||||
|
||||
The name of the CPU CMake is running on.
|
||||
|
||||
On systems that support uname, this variable is set to the output of
|
||||
uname -p, on windows it is set to the value of the environment variable
|
||||
On systems that support ``uname``, this variable is set to the output of
|
||||
``uname -p``. On Windows it is set to the value of the environment variable
|
||||
``PROCESSOR_ARCHITECTURE``.
|
||||
|
||||
@ -4,5 +4,5 @@ CMAKE_HOST_SYSTEM_VERSION
|
||||
The OS version CMake is running on.
|
||||
|
||||
A numeric version string for the system. On systems that support
|
||||
uname, this variable is set to the output of uname -r. On other
|
||||
``uname``, this variable is set to the output of ``uname -r``. On other
|
||||
systems this is set to major-minor version numbers.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_HOST_UNIX
|
||||
---------------
|
||||
|
||||
True for UNIX and UNIX like operating systems.
|
||||
``True`` for UNIX and UNIX like operating systems.
|
||||
|
||||
Set to true when the host system is UNIX or UNIX like (i.e. APPLE and
|
||||
Set to ``true`` when the host system is UNIX or UNIX like (i.e. APPLE and
|
||||
CYGWIN).
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
CMAKE_HOST_WIN32
|
||||
----------------
|
||||
|
||||
True on windows systems, including win64.
|
||||
``True`` on Windows systems, including Win64.
|
||||
|
||||
Set to true when the host system is Windows and on Cygwin.
|
||||
Set to ``true`` when the host system is Windows and on Cygwin.
|
||||
|
||||
@ -6,4 +6,4 @@ The prefix for import libraries that you link to.
|
||||
The prefix to use for the name of an import library if used on this
|
||||
platform.
|
||||
|
||||
CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.
|
||||
``CMAKE_IMPORT_LIBRARY_PREFIX_<LANG>`` overrides this for language ``<LANG>``.
|
||||
|
||||
@ -6,4 +6,4 @@ The suffix for import libraries that you link to.
|
||||
The suffix to use for the end of an import library filename if used on
|
||||
this platform.
|
||||
|
||||
CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.
|
||||
``CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG>`` overrides this for language ``<LANG>``.
|
||||
|
||||
@ -3,11 +3,11 @@ CMAKE_INCLUDE_CURRENT_DIR
|
||||
|
||||
Automatically add the current source- and build directories to the include path.
|
||||
|
||||
If this variable is enabled, CMake automatically adds in each
|
||||
directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR}
|
||||
to the include path for this directory. These additional include
|
||||
If this variable is enabled, CMake automatically adds
|
||||
:variable:`CMAKE_CURRENT_SOURCE_DIR` and :variable:`CMAKE_CURRENT_BINARY_DIR`
|
||||
to the include path for each directory. These additional include
|
||||
directories do not propagate down to subdirectories. This is useful
|
||||
mainly for out-of-source builds, where files generated into the build
|
||||
tree are included by files located in the source tree.
|
||||
|
||||
By default CMAKE_INCLUDE_CURRENT_DIR is OFF.
|
||||
By default ``CMAKE_INCLUDE_CURRENT_DIR`` is ``OFF``.
|
||||
|
||||
@ -1,10 +1,12 @@
|
||||
CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE
|
||||
--------------------------------------
|
||||
|
||||
Automatically add the current source- and build directories to the INTERFACE_INCLUDE_DIRECTORIES.
|
||||
Automatically add the current source- and build directories to the
|
||||
:prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` target property.
|
||||
|
||||
If this variable is enabled, CMake automatically adds for each shared
|
||||
library target, static library target, module target and executable
|
||||
target, ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} to
|
||||
the INTERFACE_INCLUDE_DIRECTORIES.By default
|
||||
CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE is OFF.
|
||||
target, :variable:`CMAKE_CURRENT_SOURCE_DIR` and
|
||||
:variable:`CMAKE_CURRENT_BINARY_DIR` to
|
||||
the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` target property. By default
|
||||
``CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE`` is ``OFF``.
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
CMAKE_INCLUDE_DIRECTORIES_BEFORE
|
||||
--------------------------------
|
||||
|
||||
Whether to append or prepend directories by default in :command:`include_directories`.
|
||||
Whether to append or prepend directories by default in
|
||||
:command:`include_directories`.
|
||||
|
||||
This variable affects the default behavior of the :command:`include_directories`
|
||||
command. Setting this variable to 'ON' is equivalent to using the BEFORE option
|
||||
in all uses of that command.
|
||||
command. Setting this variable to ``ON`` is equivalent to using the ``BEFORE``
|
||||
option in all uses of that command.
|
||||
|
||||
@ -4,5 +4,5 @@ CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE
|
||||
Whether to force prepending of project include directories.
|
||||
|
||||
This variable affects the order of include directories generated in compiler
|
||||
command lines. If set to 'ON', it causes the :variable:`CMAKE_SOURCE_DIR` and
|
||||
the :variable:`CMAKE_BINARY_DIR` to appear first.
|
||||
command lines. If set to ``ON``, it causes the :variable:`CMAKE_SOURCE_DIR`
|
||||
and the :variable:`CMAKE_BINARY_DIR` to appear first.
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
CMAKE_INSTALL_DEFAULT_COMPONENT_NAME
|
||||
------------------------------------
|
||||
|
||||
Default component used in install() commands.
|
||||
Default component used in :command:`install` commands.
|
||||
|
||||
If an install() command is used without the COMPONENT argument, these
|
||||
files will be grouped into a default component. The name of this
|
||||
If an :command:`install` command is used without the ``COMPONENT`` argument,
|
||||
these files will be grouped into a default component. The name of this
|
||||
default install component will be taken from this variable. It
|
||||
defaults to "Unspecified".
|
||||
defaults to ``Unspecified``.
|
||||
|
||||
@ -3,6 +3,6 @@ CMAKE_INSTALL_NAME_DIR
|
||||
|
||||
Mac OS X directory name for installed targets.
|
||||
|
||||
CMAKE_INSTALL_NAME_DIR is used to initialize the INSTALL_NAME_DIR
|
||||
property on all targets. See that target property for more
|
||||
information.
|
||||
``CMAKE_INSTALL_NAME_DIR`` is used to initialize the
|
||||
:prop_tgt:`INSTALL_NAME_DIR` property on all targets. See that target
|
||||
property for more information.
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
CMAKE_INSTALL_PREFIX
|
||||
--------------------
|
||||
|
||||
Install directory used by install.
|
||||
Install directory used by :command:`install`.
|
||||
|
||||
If "make install" is invoked or INSTALL is built, this directory is
|
||||
If ``make install`` is invoked or ``INSTALL`` is built, this directory is
|
||||
prepended onto all install directories. This variable defaults to
|
||||
/usr/local on UNIX and c:/Program Files on Windows.
|
||||
``/usr/local`` on UNIX and ``c:/Program Files`` on Windows.
|
||||
|
||||
On UNIX one can use the DESTDIR mechanism in order to relocate the
|
||||
whole installation. DESTDIR means DESTination DIRectory. It is
|
||||
On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
|
||||
whole installation. ``DESTDIR`` means DESTination DIRectory. It is
|
||||
commonly used by makefile users in order to install software at
|
||||
non-default location. It is usually invoked like this:
|
||||
|
||||
@ -17,16 +17,17 @@ non-default location. It is usually invoked like this:
|
||||
make DESTDIR=/home/john install
|
||||
|
||||
which will install the concerned software using the installation
|
||||
prefix, e.g. "/usr/local" prepended with the DESTDIR value which
|
||||
finally gives "/home/john/usr/local".
|
||||
prefix, e.g. ``/usr/local`` prepended with the ``DESTDIR`` value which
|
||||
finally gives ``/home/john/usr/local``.
|
||||
|
||||
WARNING: DESTDIR may not be used on Windows because installation
|
||||
prefix usually contains a drive letter like in "C:/Program Files"
|
||||
WARNING: ``DESTDIR`` may not be used on Windows because installation
|
||||
prefix usually contains a drive letter like in ``C:/Program Files``
|
||||
which cannot be prepended with some other prefix.
|
||||
|
||||
The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH so
|
||||
that find_package, find_program, find_library, find_path, and
|
||||
find_file will search the prefix for other software.
|
||||
The installation prefix is also added to :variable:`CMAKE_SYSTEM_PREFIX_PATH`
|
||||
so that :command:`find_package`, :command:`find_program`,
|
||||
:command:`find_library`, :command:`find_path`, and :command:`find_file`
|
||||
will search the prefix for other software.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@ -5,4 +5,4 @@ The rpath to use for installed targets.
|
||||
|
||||
A semicolon-separated list specifying the rpath to use in installed
|
||||
targets (for platforms that support it). This is used to initialize
|
||||
the target property INSTALL_RPATH for all targets.
|
||||
the target property :prop_tgt:`INSTALL_RPATH` for all targets.
|
||||
|
||||
@ -3,7 +3,7 @@ CMAKE_INSTALL_RPATH_USE_LINK_PATH
|
||||
|
||||
Add paths to linker search and installed rpath.
|
||||
|
||||
CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true
|
||||
``CMAKE_INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``true``
|
||||
will append directories in the linker search path and outside the
|
||||
project to the INSTALL_RPATH. This is used to initialize the target
|
||||
property INSTALL_RPATH_USE_LINK_PATH for all targets.
|
||||
project to the :prop_tgt:`INSTALL_RPATH`. This is used to initialize the
|
||||
target property :prop_tgt:`INSTALL_RPATH_USE_LINK_PATH` for all targets.
|
||||
|
||||
@ -4,6 +4,7 @@ CMAKE_<LANG>_ARCHIVE_APPEND
|
||||
Rule variable to append to a static archive.
|
||||
|
||||
This is a rule variable that tells CMake how to append to a static
|
||||
archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on
|
||||
some platforms in order to support large object counts. See also
|
||||
CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.
|
||||
archive. It is used in place of :variable:`CMAKE_<LANG>_CREATE_STATIC_LIBRARY`
|
||||
on some platforms in order to support large object counts. See also
|
||||
:variable:`CMAKE_<LANG>_ARCHIVE_CREATE` and
|
||||
:variable:`CMAKE_<LANG>_ARCHIVE_FINISH`.
|
||||
|
||||
@ -4,6 +4,7 @@ CMAKE_<LANG>_ARCHIVE_CREATE
|
||||
Rule variable to create a new static archive.
|
||||
|
||||
This is a rule variable that tells CMake how to create a static
|
||||
archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on
|
||||
some platforms in order to support large object counts. See also
|
||||
CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.
|
||||
archive. It is used in place of :variable:`CMAKE_<LANG>_CREATE_STATIC_LIBRARY`
|
||||
on some platforms in order to support large object counts. See also
|
||||
:variable:`CMAKE_<LANG>_ARCHIVE_APPEND` and
|
||||
:variable:`CMAKE_<LANG>_ARCHIVE_FINISH`.
|
||||
|
||||
@ -4,6 +4,7 @@ CMAKE_<LANG>_ARCHIVE_FINISH
|
||||
Rule variable to finish an existing static archive.
|
||||
|
||||
This is a rule variable that tells CMake how to finish a static
|
||||
archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on
|
||||
some platforms in order to support large object counts. See also
|
||||
CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.
|
||||
archive. It is used in place of :variable:`CMAKE_<LANG>_CREATE_STATIC_LIBRARY`
|
||||
on some platforms in order to support large object counts. See also
|
||||
:variable:`CMAKE_<LANG>_ARCHIVE_CREATE` and
|
||||
:variable:`CMAKE_<LANG>_ARCHIVE_APPEND`.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_<LANG>_COMPILER
|
||||
---------------------
|
||||
|
||||
The full path to the compiler for LANG.
|
||||
The full path to the compiler for ``LANG``.
|
||||
|
||||
This is the command that will be used as the <LANG> compiler. Once
|
||||
This is the command that will be used as the ``<LANG>`` compiler. Once
|
||||
set, you can not change this variable.
|
||||
|
||||
@ -5,9 +5,9 @@ The external toolchain for cross-compiling, if supported.
|
||||
|
||||
Some compiler toolchains do not ship their own auxilliary utilities such as
|
||||
archivers and linkers. The compiler driver may support a command-line argument
|
||||
to specify the location of such tools. CMAKE_<LANG>_COMPILER_EXTERNAL_TOOLCHAIN
|
||||
may be set to a path to a path to the external toolchain and will be passed
|
||||
to the compiler driver if supported.
|
||||
to specify the location of such tools.
|
||||
``CMAKE_<LANG>_COMPILER_EXTERNAL_TOOLCHAIN`` may be set to a path to a path to
|
||||
the external toolchain and will be passed to the compiler driver if supported.
|
||||
|
||||
This variable may only be set in a toolchain file specified by
|
||||
the :variable:`CMAKE_TOOLCHAIN_FILE` variable.
|
||||
|
||||
@ -3,5 +3,5 @@ CMAKE_<LANG>_COMPILER_LOADED
|
||||
|
||||
Defined to true if the language is enabled.
|
||||
|
||||
When language <LANG> is enabled by project() or enable_language() this
|
||||
variable is defined to 1.
|
||||
When language ``<LANG>`` is enabled by :command:`project` or
|
||||
:command:`enable_language` this variable is defined to ``1``.
|
||||
|
||||
@ -4,4 +4,4 @@ CMAKE_<LANG>_COMPILE_OBJECT
|
||||
Rule variable to compile a single object file.
|
||||
|
||||
This is a rule variable that tells CMake how to compile a single
|
||||
object file for the language <LANG>.
|
||||
object file for the language ``<LANG>``.
|
||||
|
||||
@ -4,4 +4,4 @@ CMAKE_<LANG>_CREATE_SHARED_LIBRARY
|
||||
Rule variable to create a shared library.
|
||||
|
||||
This is a rule variable that tells CMake how to create a shared
|
||||
library for the language <LANG>.
|
||||
library for the language ``<LANG>``.
|
||||
|
||||
@ -4,4 +4,4 @@ CMAKE_<LANG>_CREATE_SHARED_MODULE
|
||||
Rule variable to create a shared module.
|
||||
|
||||
This is a rule variable that tells CMake how to create a shared
|
||||
library for the language <LANG>.
|
||||
library for the language ``<LANG>``.
|
||||
|
||||
@ -4,4 +4,4 @@ CMAKE_<LANG>_CREATE_STATIC_LIBRARY
|
||||
Rule variable to create a static library.
|
||||
|
||||
This is a rule variable that tells CMake how to create a static
|
||||
library for the language <LANG>.
|
||||
library for the language ``<LANG>``.
|
||||
|
||||
@ -3,4 +3,4 @@ CMAKE_<LANG>_FLAGS
|
||||
|
||||
Flags for all build types.
|
||||
|
||||
<LANG> flags used regardless of the value of CMAKE_BUILD_TYPE.
|
||||
``<LANG>`` flags used regardless of the value of :variable:`CMAKE_BUILD_TYPE`.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
CMAKE_<LANG>_FLAGS_DEBUG
|
||||
------------------------
|
||||
|
||||
Flags for Debug build type or configuration.
|
||||
Flags for ``Debug`` build type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is Debug.
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``Debug``.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_<LANG>_FLAGS_MINSIZEREL
|
||||
-----------------------------
|
||||
|
||||
Flags for MinSizeRel build type or configuration.
|
||||
Flags for ``MinSizeRel`` build type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel.Short for
|
||||
minimum size release.
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``MinSizeRel``
|
||||
(short for minimum size release).
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
CMAKE_<LANG>_FLAGS_RELEASE
|
||||
--------------------------
|
||||
|
||||
Flags for Release build type or configuration.
|
||||
Flags for ``Release`` build type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is Release
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``Release``.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_<LANG>_FLAGS_RELWITHDEBINFO
|
||||
---------------------------------
|
||||
|
||||
Flags for RelWithDebInfo type or configuration.
|
||||
Flags for ``RelWithDebInfo`` type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. Short for
|
||||
Release With Debug Information.
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``RelWithDebInfo``
|
||||
(short for Release With Debug Information).
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
CMAKE_<LANG>_GHS_KERNEL_FLAGS_DEBUG
|
||||
-----------------------------------
|
||||
|
||||
GHS kernel flags for Debug build type or configuration.
|
||||
GHS kernel flags for ``Debug`` build type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is Debug.
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``Debug``.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_<LANG>_GHS_KERNEL_FLAGS_MINSIZEREL
|
||||
----------------------------------------
|
||||
|
||||
GHS kernel flags for MinSizeRel build type or configuration.
|
||||
GHS kernel flags for ``MinSizeRel`` build type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel.Short for
|
||||
minimum size release.
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``MinSizeRel``
|
||||
(short for minimum size release).
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
CMAKE_<LANG>_GHS_KERNEL_FLAGS_RELEASE
|
||||
-------------------------------------
|
||||
|
||||
GHS kernel flags for Release build type or configuration.
|
||||
GHS kernel flags for ``Release`` build type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is Release
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``Release``.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CMAKE_<LANG>_GHS_KERNEL_FLAGS_RELWITHDEBINFO
|
||||
--------------------------------------------
|
||||
|
||||
GHS kernel flags for RelWithDebInfo type or configuration.
|
||||
GHS kernel flags for ``RelWithDebInfo`` type or configuration.
|
||||
|
||||
<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. Short for
|
||||
Release With Debug Information.
|
||||
``<LANG>`` flags used when :variable:`CMAKE_BUILD_TYPE` is ``RelWithDebInfo``
|
||||
(short for Release With Debug Information).
|
||||
|
||||
@ -4,6 +4,6 @@ CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES
|
||||
Directories implicitly searched by the compiler for header files.
|
||||
|
||||
CMake does not explicitly specify these directories on compiler
|
||||
command lines for language <LANG>. This prevents system include
|
||||
command lines for language ``<LANG>``. This prevents system include
|
||||
directories from being treated as user include directories on some
|
||||
compilers.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user