summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorfriendlyanon <friendlyanon_@hotmail.com>2021-05-01 14:10:21 (GMT)
committerfriendlyanon <friendlyanon_@hotmail.com>2021-05-04 18:17:17 (GMT)
commitfc2ac460435df289149e4faaf494e6b287071a8c (patch)
tree6b08af5df9a9f1f3fe1fd90f54a220118a1e9301 /Help/command
parent4dd4e9dd6ce5efd9bb9bbb784816167a8b5873ae (diff)
downloadCMake-fc2ac460435df289149e4faaf494e6b287071a8c.zip
CMake-fc2ac460435df289149e4faaf494e6b287071a8c.tar.gz
CMake-fc2ac460435df289149e4faaf494e6b287071a8c.tar.bz2
build_command: Add the PARALLEL_LEVEL argument
Issue: #19712
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/build_command.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/Help/command/build_command.rst b/Help/command/build_command.rst
index 6659005..a03979d 100644
--- a/Help/command/build_command.rst
+++ b/Help/command/build_command.rst
@@ -8,23 +8,29 @@ This is mainly intended for internal use by the :module:`CTest` module.
build_command(<variable>
[CONFIGURATION <config>]
+ [PARALLEL_LEVEL <parallel>]
[TARGET <target>]
[PROJECT_NAME <projname>] # legacy, causes warning
)
Sets the given ``<variable>`` to a command-line string of the form::
- <cmake> --build . [--config <config>] [--target <target>...] [-- -i]
+ <cmake> --build . [--config <config>] [--parallel <parallel>] [--target <target>...] [-- -i]
where ``<cmake>`` is the location of the :manual:`cmake(1)` command-line
-tool, and ``<config>`` and ``<target>`` are the values provided to the
-``CONFIGURATION`` and ``TARGET`` options, if any. The trailing ``-- -i``
-option is added for :ref:`Makefile Generators` if policy :policy:`CMP0061`
-is not set to ``NEW``.
+tool, and ``<config>``, ``<parallel>`` and ``<target>`` are the values
+provided to the ``CONFIGURATION``, ``PARALLEL_LEVEL`` and ``TARGET``
+options, if any. The trailing ``-- -i`` option is added for
+:ref:`Makefile Generators` if policy :policy:`CMP0061` is not set to
+``NEW``.
When invoked, this ``cmake --build`` command line will launch the
underlying build system tool.
+.. versionadded:: 3.21
+ The ``PARALLEL_LEVEL`` argument can be used to set the ``--parallel``
+ flag.
+
.. code-block:: cmake
build_command(<cachevariable> <makecommand>)