mirror of
https://github.com/Kitware/CMake.git
synced 2026-11-08 06:16:53 +00:00
Help: Use *.rst extension for included files
So, editor(s) can correctly highlight the RST syntax in the included files.
This commit is contained in:
509 files changed
+871
-871
No files matched your search
@@ -25,7 +25,7 @@ language syntax may require escapes to specify some values).
|
||||
Any leading ``-D`` on an item will be removed.
|
||||
|
||||
.. |command_name| replace:: ``add_compile_definitions``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
@@ -20,9 +20,9 @@ Arguments
|
||||
^^^^^^^^^
|
||||
|
||||
.. |command_name| replace:: ``add_compile_options``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
.. include:: OPTIONS_SHELL.txt
|
||||
.. include:: include/OPTIONS_SHELL.rst
|
||||
|
||||
Example
|
||||
^^^^^^^
|
||||
|
||||
@@ -24,13 +24,13 @@ exist to add libraries (:command:`target_link_libraries` or
|
||||
see the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property.
|
||||
|
||||
.. |command_name| replace:: ``add_link_options``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
.. include:: DEVICE_LINK_OPTIONS.txt
|
||||
.. include:: include/DEVICE_LINK_OPTIONS.rst
|
||||
|
||||
.. include:: OPTIONS_SHELL.txt
|
||||
.. include:: include/OPTIONS_SHELL.rst
|
||||
|
||||
.. include:: LINK_OPTIONS_LINKER.txt
|
||||
.. include:: include/LINK_OPTIONS_LINKER.rst
|
||||
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
@@ -59,9 +59,9 @@ Policy Version
|
||||
|
||||
cmake_policy(VERSION <min>[...<max>])
|
||||
|
||||
.. include:: POLICY_VERSION.txt
|
||||
.. include:: include/POLICY_VERSION.rst
|
||||
|
||||
.. include:: DEPRECATED_POLICY_VERSIONS.txt
|
||||
.. include:: include/DEPRECATED_POLICY_VERSIONS.rst
|
||||
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
@@ -39,12 +39,12 @@ CMake is older than 3.12, the extra ``...`` dots will be seen as version
|
||||
component separators, resulting in the ``...<max>`` part being ignored and
|
||||
preserving the pre-3.12 behavior of basing policies on ``<min>``.
|
||||
|
||||
.. include:: POLICY_VERSION.txt
|
||||
.. include:: include/POLICY_VERSION.rst
|
||||
|
||||
Note that the :command:`cmake_minimum_required(VERSION)`
|
||||
command implicitly calls ``cmake_policy(VERSION)`` too.
|
||||
|
||||
.. include:: DEPRECATED_POLICY_VERSIONS.txt
|
||||
.. include:: include/DEPRECATED_POLICY_VERSIONS.rst
|
||||
|
||||
Setting Policies Explicitly
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@@ -58,7 +58,7 @@ policy warning by setting the policy state to ``OLD``. Alternatively
|
||||
one may fix the project to work with the new behavior and set the
|
||||
policy state to ``NEW``.
|
||||
|
||||
.. include:: ../policy/DEPRECATED.txt
|
||||
.. include:: ../policy/include/DEPRECATED.rst
|
||||
|
||||
Checking Policy Settings
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@@ -11,7 +11,7 @@ Enables support for the named languages in CMake. This is the same as
|
||||
the :command:`project` command but does not create any of the extra
|
||||
variables that are created by the :command:`project` command.
|
||||
|
||||
.. include:: SUPPORTED_LANGUAGES.txt
|
||||
.. include:: include/SUPPORTED_LANGUAGES.rst
|
||||
|
||||
The following restrictions apply to where ``enable_language()`` may be called:
|
||||
|
||||
|
||||
@@ -45,4 +45,4 @@ find_file
|
||||
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
|
||||
:variable:`CMAKE_FIND_ROOT_PATH_MODE_INCLUDE`
|
||||
|
||||
.. include:: FIND_XXX.txt
|
||||
.. include:: include/FIND_XXX.rst
|
||||
@@ -44,7 +44,7 @@ find_library
|
||||
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
|
||||
:variable:`CMAKE_FIND_ROOT_PATH_MODE_LIBRARY`
|
||||
|
||||
.. include:: FIND_XXX.txt
|
||||
.. include:: include/FIND_XXX.rst
|
||||
|
||||
When more than one value is given to the ``NAMES`` option this command by
|
||||
default will consider one name at a time and search every directory
|
||||
|
||||
@@ -436,7 +436,7 @@ target architecture, in the following order:
|
||||
``REGISTRY_VIEW`` can be specified to manage ``Windows`` registry queries
|
||||
specified as part of ``PATHS`` and ``HINTS``.
|
||||
|
||||
.. include:: FIND_XXX_REGISTRY_VIEW.txt
|
||||
.. include:: include/FIND_XXX_REGISTRY_VIEW.rst
|
||||
|
||||
If ``PATH_SUFFIXES`` is specified, the suffixes are appended to each
|
||||
(``W``) or (``U``) directory entry one-by-one.
|
||||
@@ -620,8 +620,8 @@ before calling ``find_package``.
|
||||
and ``<prefix>/<name>.framework/Versions/*/Resources/CMake``. In previous
|
||||
versions of CMake, this order was unspecified.
|
||||
|
||||
.. include:: FIND_XXX_ROOT.txt
|
||||
.. include:: FIND_XXX_ORDER.txt
|
||||
.. include:: include/FIND_XXX_ROOT.rst
|
||||
.. include:: include/FIND_XXX_ORDER.rst
|
||||
|
||||
By default the value stored in the result variable will be the path at
|
||||
which the file is found. The :variable:`CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS`
|
||||
|
||||
@@ -44,7 +44,7 @@ find_path
|
||||
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
|
||||
:variable:`CMAKE_FIND_ROOT_PATH_MODE_INCLUDE`
|
||||
|
||||
.. include:: FIND_XXX.txt
|
||||
.. include:: include/FIND_XXX.rst
|
||||
|
||||
When searching for frameworks, if the file is specified as ``A/b.h``, then
|
||||
the framework search will look for ``A.framework/Headers/b.h``. If that
|
||||
|
||||
@@ -35,7 +35,7 @@ find_program
|
||||
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
|
||||
:variable:`CMAKE_FIND_ROOT_PATH_MODE_PROGRAM`
|
||||
|
||||
.. include:: FIND_XXX.txt
|
||||
.. include:: include/FIND_XXX.rst
|
||||
|
||||
When more than one value is given to the ``NAMES`` option this command by
|
||||
default will consider one name at a time and search every directory
|
||||
|
||||
File renamed without changes.
File renamed without changes.
@@ -61,7 +61,7 @@ Options include:
|
||||
``REGISTRY_VIEW``
|
||||
.. versionadded:: 3.24
|
||||
|
||||
.. include:: FIND_XXX_REGISTRY_VIEW.txt
|
||||
.. include:: include/FIND_XXX_REGISTRY_VIEW.rst
|
||||
|
||||
``PATH_SUFFIXES``
|
||||
Specify additional subdirectories to check below each directory
|
||||
@@ -261,5 +261,5 @@ On macOS the :variable:`CMAKE_FIND_FRAMEWORK` and
|
||||
:variable:`CMAKE_FIND_APPBUNDLE` variables determine the order of
|
||||
preference between Apple-style and unix-style package components.
|
||||
|
||||
.. include:: FIND_XXX_ROOT.txt
|
||||
.. include:: FIND_XXX_ORDER.txt
|
||||
.. include:: include/FIND_XXX_ROOT.rst
|
||||
.. include:: include/FIND_XXX_ORDER.rst
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -30,7 +30,7 @@ skipping warnings, or these fixed-install system files not being
|
||||
considered in dependency calculations - see compiler docs.
|
||||
|
||||
.. |command_name| replace:: ``include_directories``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -123,7 +123,7 @@ The options are:
|
||||
|
||||
Selects which programming languages are needed to build the project.
|
||||
|
||||
.. include:: SUPPORTED_LANGUAGES.txt
|
||||
.. include:: include/SUPPORTED_LANGUAGES.rst
|
||||
|
||||
By default ``C`` and ``CXX`` are enabled if no language options are given.
|
||||
Specify language ``NONE``, or use the ``LANGUAGES`` keyword and list no languages,
|
||||
|
||||
@@ -38,7 +38,7 @@ Set Normal Variable
|
||||
can be used as an alternate method to the :command:`set(PARENT_SCOPE)`
|
||||
and :command:`unset(PARENT_SCOPE)` commands to update the parent scope.
|
||||
|
||||
.. include:: UNSET_NOTE.txt
|
||||
.. include:: include/UNSET_NOTE.rst
|
||||
|
||||
Set Cache Entry
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
@@ -26,7 +26,7 @@ same ``<target>`` append items in the order called.
|
||||
Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`.
|
||||
|
||||
.. |command_name| replace:: ``target_compile_definitions``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
Any leading ``-D`` on an item will be removed. Empty items are ignored.
|
||||
For example, the following are all equivalent:
|
||||
|
||||
@@ -33,7 +33,7 @@ The named ``<target>`` must have been created by a command such as
|
||||
.. |command_name| replace:: ``target_compile_features``
|
||||
.. |more_see_also| replace:: See the :manual:`cmake-compile-features(7)`
|
||||
manual for information on compile features and a list of supported compilers.
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
:start-line: 1
|
||||
|
||||
See Also
|
||||
|
||||
@@ -39,9 +39,9 @@ The following arguments specify compile options. Repeated calls for the same
|
||||
Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`.
|
||||
|
||||
.. |command_name| replace:: ``target_compile_options``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
.. include:: OPTIONS_SHELL.txt
|
||||
.. include:: include/OPTIONS_SHELL.rst
|
||||
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
@@ -41,7 +41,7 @@ If ``SYSTEM`` is used together with ``PUBLIC`` or ``INTERFACE``, the
|
||||
populated with the specified directories.
|
||||
|
||||
.. |command_name| replace:: ``target_include_directories``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
Specified include directories may be absolute paths or relative paths.
|
||||
A relative path will be interpreted as relative to the current source
|
||||
@@ -71,7 +71,7 @@ Creating Relocatable Packages
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. |INTERFACE_PROPERTY_LINK| replace:: :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES`
|
||||
.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt
|
||||
.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst
|
||||
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
@@ -35,7 +35,7 @@ If ``BEFORE`` is specified, the content will be prepended to the relevant
|
||||
property instead of being appended.
|
||||
|
||||
.. |command_name| replace:: ``target_link_directories``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -150,7 +150,7 @@ command lines.
|
||||
See the :manual:`cmake-buildsystem(7)` manual for more on defining
|
||||
buildsystem properties.
|
||||
|
||||
.. include:: ../command/LINK_LIBRARIES_LINKER.txt
|
||||
.. include:: ../command/include/LINK_LIBRARIES_LINKER.rst
|
||||
|
||||
Libraries for a Target and/or its Dependents
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@@ -416,7 +416,7 @@ Creating Relocatable Packages
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. |INTERFACE_PROPERTY_LINK| replace:: :prop_tgt:`INTERFACE_LINK_LIBRARIES`
|
||||
.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt
|
||||
.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.rst
|
||||
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
@@ -43,13 +43,13 @@ The following arguments specify link options. Repeated calls for the same
|
||||
:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.
|
||||
|
||||
.. |command_name| replace:: ``target_link_options``
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
|
||||
.. include:: DEVICE_LINK_OPTIONS.txt
|
||||
.. include:: include/DEVICE_LINK_OPTIONS.rst
|
||||
|
||||
.. include:: OPTIONS_SHELL.txt
|
||||
.. include:: include/OPTIONS_SHELL.rst
|
||||
|
||||
.. include:: LINK_OPTIONS_LINKER.txt
|
||||
.. include:: include/LINK_OPTIONS_LINKER.rst
|
||||
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
@@ -78,7 +78,7 @@ included by absolute path. For example:
|
||||
brackets must be specified by absolute path. Also, when specifying angle
|
||||
brackets inside a generator expression, be sure to encode the closing
|
||||
``>`` as :genex:`$<ANGLE-R>`. For example:
|
||||
.. include:: GENEX_NOTE.txt
|
||||
.. include:: include/GENEX_NOTE.rst
|
||||
:start-line: 1
|
||||
|
||||
.. code-block:: cmake
|
||||
|
||||
@@ -18,7 +18,7 @@ If ``PARENT_SCOPE`` is present then the variable is removed from the scope
|
||||
above the current scope. See the same option in the :command:`set` command
|
||||
for further details.
|
||||
|
||||
.. include:: UNSET_NOTE.txt
|
||||
.. include:: include/UNSET_NOTE.rst
|
||||
|
||||
Unset Environment Variable
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@@ -3,7 +3,7 @@ ADSP_ROOT
|
||||
|
||||
.. versionadded:: 3.24
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``ADSP_ROOT`` environment variable specifies a default value
|
||||
for the :variable:`CMAKE_ADSP_ROOT` variable when there is no explicit
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
ASM<DIALECT>
|
||||
------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling a specific dialect of assembly language
|
||||
files. ``ASM<DIALECT>`` can be one of:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
ASM<DIALECT>FLAGS
|
||||
-----------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Add default compilation flags to be used when compiling a specific dialect
|
||||
of an assembly language. ``ASM<DIALECT>FLAGS`` can be one of:
|
||||
@@ -14,6 +14,6 @@ of an assembly language. ``ASM<DIALECT>FLAGS`` can be one of:
|
||||
|
||||
.. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>`
|
||||
.. |LANG| replace:: ``ASM<DIALECT>``
|
||||
.. include:: LANG_FLAGS.txt
|
||||
.. include:: include/LANG_FLAGS.rst
|
||||
|
||||
See also :variable:`CMAKE_ASM<DIALECT>_FLAGS_INIT <CMAKE_<LANG>_FLAGS_INIT>`.
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
CC
|
||||
--
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling ``C`` language files. Will only be used by
|
||||
CMake on the first configuration to determine ``C`` compiler, after which the
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
CFLAGS
|
||||
------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Add default compilation flags to be used when compiling ``C`` files.
|
||||
|
||||
.. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_C_FLAGS <CMAKE_<LANG>_FLAGS>`
|
||||
.. |LANG| replace:: ``C``
|
||||
.. include:: LANG_FLAGS.txt
|
||||
.. include:: include/LANG_FLAGS.rst
|
||||
|
||||
See also :variable:`CMAKE_C_FLAGS_INIT <CMAKE_<LANG>_FLAGS_INIT>`.
|
||||
@@ -3,7 +3,7 @@ CLICOLOR
|
||||
|
||||
.. versionadded:: 3.21
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Set to ``0`` to tell command-line tools not to print color
|
||||
messages even if connected to a terminal.
|
||||
|
||||
@@ -3,7 +3,7 @@ CLICOLOR_FORCE
|
||||
|
||||
.. versionadded:: 3.5
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Set to a non-empty value, other than ``0``, to tell command-line
|
||||
tools to print color messages even if not connected to a terminal.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_APPBUNDLE_PATH
|
||||
--------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_APPBUNDLE_PATH`` environment variable may be set to a list of
|
||||
directories to be searched for macOS application bundles
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_APPLE_SILICON_PROCESSOR
|
||||
|
||||
.. versionadded:: 3.19.2
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
On Apple Silicon hosts running macOS, set this environment variable to tell
|
||||
CMake what architecture to use for :variable:`CMAKE_HOST_SYSTEM_PROCESSOR`.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_BUILD_PARALLEL_LEVEL
|
||||
|
||||
.. versionadded:: 3.12
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specifies the maximum number of concurrent processes to use when building
|
||||
using the ``cmake --build`` command line
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_BUILD_TYPE
|
||||
|
||||
.. versionadded:: 3.22
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_BUILD_TYPE`` environment variable specifies a default value
|
||||
for the :variable:`CMAKE_BUILD_TYPE` variable when there is no explicit
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_COLOR_DIAGNOSTICS
|
||||
|
||||
.. versionadded:: 3.24
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specifies a default value for the :variable:`CMAKE_COLOR_DIAGNOSTICS` variable
|
||||
when there is no explicit value given on the first run.
|
||||
@@ -3,7 +3,7 @@ CMAKE_CONFIGURATION_TYPES
|
||||
|
||||
.. versionadded:: 3.22
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_CONFIGURATION_TYPES`` environment variable specifies a
|
||||
default value for the :variable:`CMAKE_CONFIGURATION_TYPES` variable
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_CONFIG_DIR
|
||||
|
||||
.. versionadded:: 3.31
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specify a CMake user-wide configuration directory for
|
||||
:manual:`cmake-file-api(7)` queries.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_CONFIG_TYPE
|
||||
-----------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The default build configuration for :ref:`Build Tool Mode` and
|
||||
``ctest`` build handler when there is no explicit configuration given.
|
||||
@@ -3,7 +3,7 @@ CMAKE_CROSSCOMPILING_EMULATOR
|
||||
|
||||
.. versionadded:: 3.28
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The default value for :variable:`CMAKE_CROSSCOMPILING_EMULATOR` when there
|
||||
is no explicit configuration given on the first run while creating a new
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_EXPORT_BUILD_DATABASE
|
||||
|
||||
.. versionadded:: 3.31
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The default value for :variable:`CMAKE_EXPORT_BUILD_DATABASE` when there is no
|
||||
explicit configuration given on the first run while creating a new build tree.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_EXPORT_COMPILE_COMMANDS
|
||||
|
||||
.. versionadded:: 3.17
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The default value for :variable:`CMAKE_EXPORT_COMPILE_COMMANDS` when there
|
||||
is no explicit configuration given on the first run while creating a new
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_FRAMEWORK_PATH
|
||||
--------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_FRAMEWORK_PATH`` environment variable may be set to a list of
|
||||
directories to be searched for macOS frameworks by the :command:`find_library`,
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_GENERATOR
|
||||
|
||||
.. versionadded:: 3.15
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specifies the CMake default generator to use when no generator is supplied
|
||||
with :option:`-G <cmake -G>`. If the provided value doesn't name a generator
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_GENERATOR_INSTANCE
|
||||
|
||||
.. versionadded:: 3.15
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Default value for :variable:`CMAKE_GENERATOR_INSTANCE` if no Cache entry is
|
||||
present. This value is only applied if :envvar:`CMAKE_GENERATOR` is set.
|
||||
@@ -3,7 +3,7 @@ CMAKE_GENERATOR_PLATFORM
|
||||
|
||||
.. versionadded:: 3.15
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Default value for :variable:`CMAKE_GENERATOR_PLATFORM` if no Cache entry
|
||||
is present and no value is specified by :option:`cmake -A` option.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_GENERATOR_TOOLSET
|
||||
|
||||
.. versionadded:: 3.15
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Default value for :variable:`CMAKE_GENERATOR_TOOLSET` if no Cache entry
|
||||
is present and no value is specified by :option:`cmake -T` option.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_INCLUDE_PATH
|
||||
------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_INCLUDE_PATH`` environment variable may be set to a list of
|
||||
directories to be searched by the :command:`find_file` and :command:`find_path` commands.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_INSTALL_MODE
|
||||
|
||||
.. versionadded:: 3.22
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_INSTALL_MODE`` environment variable allows users to operate
|
||||
CMake in an alternate mode of :command:`file(INSTALL)` and :command:`install()`.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_INSTALL_PARALLEL_LEVEL
|
||||
|
||||
.. versionadded:: 3.31
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specifies the default maximum number of concurrent processes to use when
|
||||
installing using ``cmake --install``.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_INSTALL_PREFIX
|
||||
|
||||
.. versionadded:: 3.29
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_INSTALL_PREFIX`` environment variable specifies a custom default
|
||||
value for the :variable:`CMAKE_INSTALL_PREFIX` variable in place of the
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_<LANG>_COMPILER_LAUNCHER
|
||||
|
||||
.. versionadded:: 3.17
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Default compiler launcher to use for the specified language. Will only be used
|
||||
by CMake to initialize the variable on the first configuration. Afterwards, it
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES_EXCLUDE
|
||||
|
||||
.. versionadded:: 3.27
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
A :ref:`semicolon-separated list <CMake Language Lists>` of directories
|
||||
to exclude from the :variable:`CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES`
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_<LANG>_LINKER_LAUNCHER
|
||||
|
||||
.. versionadded:: 3.21
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Default launcher to use when linking a target of the specified language. Will
|
||||
only be used by CMake to initialize the variable on the first configuration.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_LIBRARY_PATH
|
||||
------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_LIBRARY_PATH`` environment variable may be set to a list of
|
||||
directories to be searched by the :command:`find_library` command.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_MAXIMUM_RECURSION_DEPTH
|
||||
|
||||
.. versionadded:: 3.27
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Maximum recursion depth for CMake scripts. This environment variable is
|
||||
used if the :variable:`CMAKE_MAXIMUM_RECURSION_DEPTH` variable is not set.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_MSVCIDE_RUN_PATH
|
||||
----------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Extra PATH locations for custom commands when using
|
||||
:ref:`Visual Studio Generators`.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_OSX_ARCHITECTURES
|
||||
-----------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Target specific architectures for macOS.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_POLICY_VERSION_MINIMUM
|
||||
|
||||
.. versionadded:: 4.0
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The default value for :variable:`CMAKE_POLICY_VERSION_MINIMUM` when there
|
||||
is no explicit configuration given on the first run while creating a new
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_PREFIX_PATH
|
||||
-----------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_PREFIX_PATH`` environment variable may be set to a list of
|
||||
directories specifying installation *prefixes* to be searched by the
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CMAKE_PROGRAM_PATH
|
||||
------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_PROGRAM_PATH`` environment variable may be set to a list of
|
||||
directories to be searched by the :command:`find_program` command.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_TEST_LAUNCHER
|
||||
|
||||
.. versionadded:: 3.29
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The default value for the :variable:`CMAKE_TEST_LAUNCHER` variable when there
|
||||
is no explicit configuration given on the first run while creating a new
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_TLS_VERIFY
|
||||
|
||||
.. versionadded:: 3.30
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specify the default value for the :command:`file(DOWNLOAD)` and
|
||||
:command:`file(UPLOAD)` commands' ``TLS_VERIFY`` option.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_TLS_VERSION
|
||||
|
||||
.. versionadded:: 3.30
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specify the default value for the :command:`file(DOWNLOAD)` and
|
||||
:command:`file(UPLOAD)` commands' ``TLS_VERSION`` option.
|
||||
|
||||
@@ -3,7 +3,7 @@ CMAKE_TOOLCHAIN_FILE
|
||||
|
||||
.. versionadded:: 3.21
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
The ``CMAKE_TOOLCHAIN_FILE`` environment variable specifies a default value
|
||||
for the :variable:`CMAKE_TOOLCHAIN_FILE` variable when there is no explicit
|
||||
|
||||
@@ -3,12 +3,12 @@ CSFLAGS
|
||||
|
||||
.. versionadded:: 3.9.2
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Add default compilation flags to be used when compiling ``CSharp`` files.
|
||||
|
||||
.. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_CSharp_FLAGS <CMAKE_<LANG>_FLAGS>`
|
||||
.. |LANG| replace:: ``CSharp``
|
||||
.. include:: LANG_FLAGS.txt
|
||||
.. include:: include/LANG_FLAGS.rst
|
||||
|
||||
See also :variable:`CMAKE_CSharp_FLAGS_INIT <CMAKE_<LANG>_FLAGS_INIT>`.
|
||||
@@ -1,7 +1,7 @@
|
||||
CTEST_INTERACTIVE_DEBUG_MODE
|
||||
----------------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Environment variable that will exist and be set to ``1`` when a test executed
|
||||
by :manual:`ctest(1)` is run in interactive mode.
|
||||
@@ -3,7 +3,7 @@ CTEST_NO_TESTS_ACTION
|
||||
|
||||
.. versionadded:: 3.26
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Environment variable that controls how :manual:`ctest <ctest(1)>` handles
|
||||
cases when there are no tests to run. Possible values are: ``error``,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CTEST_OUTPUT_ON_FAILURE
|
||||
-----------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Boolean environment variable that controls if the output should be logged for
|
||||
failed tests. Set the value to ``1``, ``True``, or ``ON`` to enable output on failure.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
CTEST_PARALLEL_LEVEL
|
||||
--------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Specify the number of tests for CTest to run in parallel.
|
||||
For example, if ``CTEST_PARALLEL_LEVEL`` is set to 8, CTest will run
|
||||
|
||||
@@ -3,7 +3,7 @@ CTEST_PROGRESS_OUTPUT
|
||||
|
||||
.. versionadded:: 3.13
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Boolean environment variable that affects how :manual:`ctest <ctest(1)>`
|
||||
command output reports overall progress. When set to ``1``, ``TRUE``, ``ON`` or anything
|
||||
|
||||
@@ -3,7 +3,7 @@ CTEST_USE_INSTRUMENTATION
|
||||
|
||||
.. versionadded:: 4.0
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
CTEST_USE_LAUNCHERS_DEFAULT
|
||||
---------------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Initializes the :variable:`CTEST_USE_LAUNCHERS` variable if not already defined.
|
||||
@@ -3,7 +3,7 @@ CTEST_USE_VERBOSE_INSTRUMENTATION
|
||||
|
||||
.. versionadded:: 4.0
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ CUDAARCHS
|
||||
|
||||
.. versionadded:: 3.20
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Value used to initialize :variable:`CMAKE_CUDA_ARCHITECTURES` on the first
|
||||
configuration. Subsequent runs will use the value stored in the cache.
|
||||
|
||||
@@ -3,7 +3,7 @@ CUDACXX
|
||||
|
||||
.. versionadded:: 3.8
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling ``CUDA`` language files. Will only be used by
|
||||
CMake on the first configuration to determine ``CUDA`` compiler, after which the
|
||||
|
||||
@@ -3,12 +3,12 @@ CUDAFLAGS
|
||||
|
||||
.. versionadded:: 3.8
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Add default compilation flags to be used when compiling ``CUDA`` files.
|
||||
|
||||
.. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_CUDA_FLAGS <CMAKE_<LANG>_FLAGS>`
|
||||
.. |LANG| replace:: ``CUDA``
|
||||
.. include:: LANG_FLAGS.txt
|
||||
.. include:: include/LANG_FLAGS.rst
|
||||
|
||||
See also :variable:`CMAKE_CUDA_FLAGS_INIT <CMAKE_<LANG>_FLAGS_INIT>`.
|
||||
@@ -3,7 +3,7 @@ CUDAHOSTCXX
|
||||
|
||||
.. versionadded:: 3.8
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling host code when compiling ``CUDA``
|
||||
language files. Will only be used by CMake on the first configuration to
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
CXX
|
||||
---
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling ``CXX`` language files. Will only be used by
|
||||
CMake on the first configuration to determine ``CXX`` compiler, after which the
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
CXXFLAGS
|
||||
--------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Add default compilation flags to be used when compiling ``CXX`` (C++) files.
|
||||
|
||||
.. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_CXX_FLAGS <CMAKE_<LANG>_FLAGS>`
|
||||
.. |LANG| replace:: ``CXX``
|
||||
.. include:: LANG_FLAGS.txt
|
||||
.. include:: include/LANG_FLAGS.rst
|
||||
|
||||
See also :variable:`CMAKE_CXX_FLAGS_INIT <CMAKE_<LANG>_FLAGS_INIT>`.
|
||||
@@ -1,7 +1,7 @@
|
||||
DASHBOARD_TEST_FROM_CTEST
|
||||
-------------------------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Environment variable that will exist when a test executed by :manual:`ctest(1)`
|
||||
is run in non-interactive mode. The value will be equal to
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
DESTDIR
|
||||
-------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
|
||||
whole installation. ``DESTDIR`` means DESTination DIRectory. It is
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
FC
|
||||
--
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling ``Fortran`` language files. Will only be used
|
||||
by CMake on the first configuration to determine ``Fortran`` compiler, after
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
FFLAGS
|
||||
------
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Add default compilation flags to be used when compiling ``Fortran`` files.
|
||||
|
||||
.. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_Fortran_FLAGS <CMAKE_<LANG>_FLAGS>`
|
||||
.. |LANG| replace:: ``Fortran``
|
||||
.. include:: LANG_FLAGS.txt
|
||||
.. include:: include/LANG_FLAGS.rst
|
||||
|
||||
See also :variable:`CMAKE_Fortran_FLAGS_INIT <CMAKE_<LANG>_FLAGS_INIT>`.
|
||||
@@ -3,7 +3,7 @@ HIPCXX
|
||||
|
||||
.. versionadded:: 3.21
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling ``HIP`` language files. Will only be used by
|
||||
CMake on the first configuration to determine ``HIP`` compiler, after which the
|
||||
|
||||
@@ -3,12 +3,12 @@ HIPFLAGS
|
||||
|
||||
.. versionadded:: 3.21
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Add default compilation flags to be used when compiling ``HIP`` files.
|
||||
|
||||
.. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_HIP_FLAGS <CMAKE_<LANG>_FLAGS>`
|
||||
.. |LANG| replace:: ``HIP``
|
||||
.. include:: LANG_FLAGS.txt
|
||||
.. include:: include/LANG_FLAGS.rst
|
||||
|
||||
See also :variable:`CMAKE_HIP_FLAGS_INIT <CMAKE_<LANG>_FLAGS_INIT>`.
|
||||
@@ -3,7 +3,7 @@ HIPHOSTCXX
|
||||
|
||||
.. versionadded:: 3.28
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling host code when compiling ``HIP``
|
||||
language files with the NVIDIA CUDA Compiler. Will only be used by CMake
|
||||
|
||||
@@ -3,7 +3,7 @@ ISPC
|
||||
|
||||
.. versionadded:: 3.19
|
||||
|
||||
.. include:: ENV_VAR.txt
|
||||
.. include:: include/ENV_VAR.rst
|
||||
|
||||
Preferred executable for compiling ``ISPC`` language files. Will only be used by
|
||||
CMake on the first configuration to determine ``ISPC`` compiler, after which the
|
||||
|
||||
Loaded 100 of 509 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user