diff options
| author | scivision <scivision@users.noreply.github.com> | 2024-01-18 21:45:50 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2024-01-18 22:37:17 (GMT) |
| commit | 434bd9c0ef67b75316376370b227678dc97a88ea (patch) | |
| tree | 8782c169a292e8c9316a7b461bd6cba8d10a4bc1 /Help | |
| parent | c75047709f2ee2a3f8791f19b9ce8cc76e633521 (diff) | |
| download | CMake-434bd9c0ef67b75316376370b227678dc97a88ea.zip CMake-434bd9c0ef67b75316376370b227678dc97a88ea.tar.gz CMake-434bd9c0ef67b75316376370b227678dc97a88ea.tar.bz2 | |
Help: Document {CTEST,CMAKE_BUILD}_PARALLEL_LEVEL equivalent command-line
Clarify that the `--parallel` option isn't needed when these env.
variables are set to a finite integer.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst | 4 | ||||
| -rw-r--r-- | Help/envvar/CTEST_PARALLEL_LEVEL.rst | 8 |
2 files changed, 10 insertions, 2 deletions
diff --git a/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst index dbc589a..a50797c 100644 --- a/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst +++ b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst @@ -8,6 +8,10 @@ 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>`. +For example, if ``CMAKE_BUILD_PARALLEL_LEVEL`` is set to 8, the +underlying build tool will execute up to 8 jobs concurrently as if +``cmake --build`` were invoked with the +:option:`--parallel 8 <cmake--build --parallel>` option. If this variable is defined empty the native build tool's default number is used. diff --git a/Help/envvar/CTEST_PARALLEL_LEVEL.rst b/Help/envvar/CTEST_PARALLEL_LEVEL.rst index fd4936e..126bdb3 100644 --- a/Help/envvar/CTEST_PARALLEL_LEVEL.rst +++ b/Help/envvar/CTEST_PARALLEL_LEVEL.rst @@ -3,5 +3,9 @@ CTEST_PARALLEL_LEVEL .. include:: ENV_VAR.txt -Specify the number of tests for CTest to run in parallel. See :manual:`ctest(1)` -for more information on parallel test execution. +Specify the number of tests for CTest to run in parallel. +For example, if ``CTEST_PARALLEL_LEVEL`` is set to 8, CTest will run +up to 8 tests concurrently as if ``ctest`` were invoked with the +:option:`--parallel 8 <ctest --parallel>` option. + +See :manual:`ctest(1)` for more information on parallel test execution. |