diff options
author | Kyle Edwards <kyle.edwards@kitware.com> | 2020-01-16 15:34:43 (GMT) |
---|---|---|
committer | Kyle Edwards <kyle.edwards@kitware.com> | 2020-01-16 15:34:43 (GMT) |
commit | 310b58e96155edd0d7d39285639ae903a49df3dc (patch) | |
tree | a2d6b826d474f5a7ee0a5b1f326ccd5780c1f4e8 /Help | |
parent | 1e728706de1457a25fe531d5905c28570a208a08 (diff) | |
download | CMake-310b58e96155edd0d7d39285639ae903a49df3dc.zip CMake-310b58e96155edd0d7d39285639ae903a49df3dc.tar.gz CMake-310b58e96155edd0d7d39285639ae903a49df3dc.tar.bz2 |
Ninja Multi-Config: Rename variable to be more consistent
Also make some tweaks to the documentation.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/generator/Ninja Multi-Config.rst | 12 | ||||
-rw-r--r-- | Help/manual/cmake-variables.7.rst | 4 | ||||
-rw-r--r-- | Help/variable/CMAKE_NINJA_CROSS_CONFIG_ENABLE.rst | 6 | ||||
-rw-r--r-- | Help/variable/CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE.rst | 10 |
4 files changed, 18 insertions, 14 deletions
diff --git a/Help/generator/Ninja Multi-Config.rst b/Help/generator/Ninja Multi-Config.rst index 92ca760..248eb05 100644 --- a/Help/generator/Ninja Multi-Config.rst +++ b/Help/generator/Ninja Multi-Config.rst @@ -19,8 +19,8 @@ the desired ``build-<Config>.ninja`` file with ``ninja -f``. Running ``build-<Config>.ninja`` as the ``-f`` file and ``<target>`` as the build target. -If :variable:`CMAKE_NINJA_CROSS_CONFIG_ENABLE` is turned on, executables and -libraries of any configuration can be built regardless of which +If :variable:`CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE` is turned on, executables +and libraries of any configuration can be built regardless of which ``build-<Config>.ninja`` file is used, simply by specifying ``<target>:<OtherConfig>`` as the Ninja target. You can also specify ``<target>:all`` to build a target in all configurations. Each @@ -31,8 +31,8 @@ targets will always use the configuration specified in Ninja for the same file to be output with different commands in the same build graph. -If :variable:`CMAKE_NINJA_CROSS_CONFIG_ENABLE` is not enabled, you can still -build any target in ``build-<Config>.ninja`` by specifying +If :variable:`CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE` is not enabled, you can +still build any target in ``build-<Config>.ninja`` by specifying ``<target>:<Config>`` or ``<target>``, but not ``<target>:<OtherConfig>`` or ``<target>:all``. @@ -60,8 +60,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_NINJA_CROSS_CONFIG_ENABLE` is enabled, and you run the -following instead: +But if :variable:`CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE` is enabled, and you +run the following instead: .. code-block:: shell diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 26f1d80..0cea2c8 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -215,7 +215,6 @@ Variables that Change Behavior /variable/CMAKE_MESSAGE_INDENT /variable/CMAKE_MESSAGE_LOG_LEVEL /variable/CMAKE_MODULE_PATH - /variable/CMAKE_NINJA_MULTI_DEFAULT_BUILD_TYPE /variable/CMAKE_POLICY_DEFAULT_CMPNNNN /variable/CMAKE_POLICY_WARNING_CMPNNNN /variable/CMAKE_PREFIX_PATH @@ -423,7 +422,8 @@ Variables that Control the Build /variable/CMAKE_MODULE_LINKER_FLAGS_INIT /variable/CMAKE_MSVCIDE_RUN_PATH /variable/CMAKE_MSVC_RUNTIME_LIBRARY - /variable/CMAKE_NINJA_CROSS_CONFIG_ENABLE + /variable/CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE + /variable/CMAKE_NINJA_MULTI_DEFAULT_BUILD_TYPE /variable/CMAKE_NINJA_OUTPUT_PATH_PREFIX /variable/CMAKE_NO_BUILTIN_CHRPATH /variable/CMAKE_NO_SYSTEM_FROM_IMPORTED diff --git a/Help/variable/CMAKE_NINJA_CROSS_CONFIG_ENABLE.rst b/Help/variable/CMAKE_NINJA_CROSS_CONFIG_ENABLE.rst deleted file mode 100644 index 5c9c1aa..0000000 --- a/Help/variable/CMAKE_NINJA_CROSS_CONFIG_ENABLE.rst +++ /dev/null @@ -1,6 +0,0 @@ -CMAKE_NINJA_CROSS_CONFIG_ENABLE -------------------------------- - -If this variable is enabled, cross-configuration building is enabled in the -:generator:`Ninja Multi-Config` generator. See the generator's description for -more details. diff --git a/Help/variable/CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE.rst b/Help/variable/CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE.rst new file mode 100644 index 0000000..0571d52 --- /dev/null +++ b/Help/variable/CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE.rst @@ -0,0 +1,10 @@ +CMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE +------------------------------------- + +If this variable is enabled, cross-configuration building is enabled in the +:generator:`Ninja Multi-Config` generator. See the generator's description for +more details. This variable is ``OFF`` by default. + +This variable is meant to be set from the command line (via +``-DCMAKE_NINJA_MULTI_CROSS_CONFIG_ENABLE:BOOL=ON``) and should not be set from +project code. |