summaryrefslogtreecommitdiff
path: root/Help/generator
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2020-02-26 13:22:32 -0500
committerBrad King <brad.king@kitware.com>2020-02-27 09:22:08 -0500
commit7a63dafafbc666a184a007adca5b138796384f77 (patch)
tree5589a3106c1cbeea58d06e9c3fc5dab3c82a9cf9 /Help/generator
parent93287e34bcdd1ad3a945e24cea591cbd60f9df3b (diff)
downloadcmake-7a63dafafbc666a184a007adca5b138796384f77.tar.gz
Ninja Multi-Config: Remove "NMC" from variable names
Also rename `..._DEFAULT_BUILD_FILE_CONFIG` to `..._DEFAULT_BUILD_TYPE`. These name changes make the variables meaningful for future use by other generators.
Diffstat (limited to 'Help/generator')
-rw-r--r--Help/generator/Ninja Multi-Config.rst26
1 files changed, 13 insertions, 13 deletions
diff --git a/Help/generator/Ninja Multi-Config.rst b/Help/generator/Ninja Multi-Config.rst
index 11c59f2bf9..c2331f031c 100644
--- a/Help/generator/Ninja Multi-Config.rst
+++ b/Help/generator/Ninja Multi-Config.rst
@@ -35,7 +35,7 @@ The ``Ninja Multi-Config`` generator recognizes the following variables:
Specifies the total set of configurations to build. See the variable's
documentation for more information.
-:variable:`CMAKE_NMC_CROSS_CONFIGS`
+:variable:`CMAKE_CROSS_CONFIGS`
Specifies a :ref:`semicolon-separated list <CMake Language Lists>` of
configurations available from all ``build-<Config>.ninja`` files.
This variable activates cross-config mode.
@@ -49,7 +49,7 @@ The ``Ninja Multi-Config`` generator recognizes the following variables:
The value of this variable must be a subset of
:variable:`CMAKE_CONFIGURATION_TYPES`.
-:variable:`CMAKE_NMC_DEFAULT_BUILD_FILE_CONFIG`
+:variable:`CMAKE_DEFAULT_BUILD_TYPE`
Specifies the configuration to use by default in a ``build.ninja`` file. If
this variable is specified, a ``build.ninja`` file is generated which uses
build rules from ``build-<Config>.ninja`` by default. All custom commands are
@@ -59,26 +59,26 @@ The ``Ninja Multi-Config`` generator recognizes the following variables:
The value of this variable must be one of the items from
:variable:`CMAKE_CONFIGURATION_TYPES`.
-:variable:`CMAKE_NMC_DEFAULT_CONFIGS`
+:variable:`CMAKE_DEFAULT_CONFIGS`
Specifies a :ref:`semicolon-separated list <CMake Language Lists>` of
configurations to build for a target in ``build.ninja``
if no ``:<Config>`` suffix is specified. If it is set to ``all``, all
- configurations from :variable:`CMAKE_NMC_CROSS_CONFIGS` are used. If
+ configurations from :variable:`CMAKE_CROSS_CONFIGS` are used. If
it is not specified, it defaults to
- :variable:`CMAKE_NMC_DEFAULT_BUILD_FILE_CONFIG`.
+ :variable:`CMAKE_DEFAULT_BUILD_TYPE`.
For example, if you set
- :variable:`CMAKE_NMC_DEFAULT_BUILD_FILE_CONFIG` to ``Release``, but
- set :variable:`CMAKE_NMC_DEFAULT_CONFIGS` to ``Debug`` or ``all``,
+ :variable:`CMAKE_DEFAULT_BUILD_TYPE` to ``Release``, but
+ set :variable:`CMAKE_DEFAULT_CONFIGS` to ``Debug`` or ``all``,
all ``<target>`` aliases in ``build.ninja`` will resolve to
``<target>:Debug`` or ``<target>:all``, but custom commands will still use
the ``Release`` configuration.
The value of this variable must be a subset of
- :variable:`CMAKE_NMC_CROSS_CONFIGS` or be the same as
- :variable:`CMAKE_NMC_DEFAULT_BUILD_FILE_CONFIG`. It must not be
- specified if :variable:`CMAKE_NMC_DEFAULT_BUILD_FILE_CONFIG` or
- :variable:`CMAKE_NMC_CROSS_CONFIGS` is not used.
+ :variable:`CMAKE_CROSS_CONFIGS` or be the same as
+ :variable:`CMAKE_DEFAULT_BUILD_TYPE`. It must not be
+ specified if :variable:`CMAKE_DEFAULT_BUILD_TYPE` or
+ :variable:`CMAKE_CROSS_CONFIGS` is not used.
Consider the following example:
@@ -104,8 +104,8 @@ This would build the ``Debug`` configuration of ``generator``, which would be
used to generate ``generated.c``, which would be used to build the ``Debug``
configuration of ``generated``.
-But if :variable:`CMAKE_NMC_CROSS_CONFIGS` is set to ``all``, and you
-run the following instead:
+But if :variable:`CMAKE_CROSS_CONFIGS` is set to ``all``, and you run the
+following instead:
.. code-block:: shell