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.
This commit is contained in:
scivision
2024-01-18 16:45:50 -05:00
committed by Brad King
parent c75047709f
commit 434bd9c0ef
2 changed files with 10 additions and 2 deletions

View File

@@ -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.

View File

@@ -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.