diff options
| author | Florian Maushart <FloriansGit@online.ms> | 2018-04-14 20:50:19 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2018-05-25 13:42:20 (GMT) |
| commit | 1ab3881ec9e809ac5f6cad5cd84048310b8683e2 (patch) | |
| tree | 2b5c7c5a9ad2e38a584de50b5f019056883c3877 /Help | |
| parent | dfc692342831186053bd385605c8a21239e2e77d (diff) | |
| download | CMake-1ab3881ec9e809ac5f6cad5cd84048310b8683e2.zip CMake-1ab3881ec9e809ac5f6cad5cd84048310b8683e2.tar.gz CMake-1ab3881ec9e809ac5f6cad5cd84048310b8683e2.tar.bz2 | |
cmake: Add options for parallel builds to --build mode
While we already support `cmake --build . -- -j`, the options after `--`
are specific to the native build tool. Add new options `--parallel
[<N>]` and `-j [<N>]` to abstract this and map to the proper option
for the native build tool.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst | 9 | ||||
| -rw-r--r-- | Help/manual/cmake-env-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/manual/cmake.1.rst | 7 | ||||
| -rw-r--r-- | Help/release/dev/parallel_build_option.rst | 6 |
4 files changed, 23 insertions, 0 deletions
diff --git a/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst new file mode 100644 index 0000000..198dc51 --- /dev/null +++ b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst @@ -0,0 +1,9 @@ +CMAKE_BUILD_PARALLEL_LEVEL +-------------------------- + +Specifies the maximum number of concurrent processes to use when building +using the ``cmake --build`` command line +:ref:`Build Tool Mode <Build Tool Mode>`. + +If this variable is defined empty the native build tool's default number is +used. diff --git a/Help/manual/cmake-env-variables.7.rst b/Help/manual/cmake-env-variables.7.rst index 2d8869f..2d17bb5 100644 --- a/Help/manual/cmake-env-variables.7.rst +++ b/Help/manual/cmake-env-variables.7.rst @@ -13,6 +13,7 @@ Environment Variables that Control the Build .. toctree:: :maxdepth: 1 + /envvar/CMAKE_BUILD_PARALLEL_LEVEL /envvar/CMAKE_CONFIG_TYPE /envvar/CMAKE_MSVCIDE_RUN_PATH /envvar/CMAKE_OSX_ARCHITECTURES diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 577d321..177acd4 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -159,6 +159,13 @@ following options: ``--build <dir>`` Project binary directory to be built. This is required and must be first. +``-j [<jobs>], --parallel [<jobs>]`` + The maximum number of concurrent processes to use when building. + If ``<jobs>`` is omitted the native build tool's default number is used. + + The :envvar:`CMAKE_BUILD_PARALLEL_LEVEL` environment variable, if set, + specifies a default parallel level when this option is not given. + ``--target <tgt>`` Build ``<tgt>`` instead of default targets. May only be specified once. diff --git a/Help/release/dev/parallel_build_option.rst b/Help/release/dev/parallel_build_option.rst new file mode 100644 index 0000000..2451fd0 --- /dev/null +++ b/Help/release/dev/parallel_build_option.rst @@ -0,0 +1,6 @@ +parallel_build_option +--------------------- + +* The :manual:`cmake(1)` :ref:`Build Tool Mode` (``cmake --build``) gained + ``--parallel [<jobs>]`` and ``-j [<jobs>]`` options to specify a parallel + build level. They map to corresponding options of the native build tool. |