summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-01-19 16:03:52 (GMT)
committerKitware Robot <kwrobot@kitware.com>2024-01-19 16:04:02 (GMT)
commit7f42261d316da7d88d69c700f1d30605cdb8e809 (patch)
tree5b299da9e2581a4ef70a4440eb6d6711e22d8795
parentd5cc1da1ca4d93be3a210d7c210ef51ba3e87027 (diff)
parent434bd9c0ef67b75316376370b227678dc97a88ea (diff)
downloadCMake-7f42261d316da7d88d69c700f1d30605cdb8e809.zip
CMake-7f42261d316da7d88d69c700f1d30605cdb8e809.tar.gz
CMake-7f42261d316da7d88d69c700f1d30605cdb8e809.tar.bz2
Merge topic 'doc-par'
434bd9c0ef Help: Document {CTEST,CMAKE_BUILD}_PARALLEL_LEVEL equivalent command-line Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9168
-rw-r--r--Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst4
-rw-r--r--Help/envvar/CTEST_PARALLEL_LEVEL.rst8
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.