From 434bd9c0ef67b75316376370b227678dc97a88ea Mon Sep 17 00:00:00 2001 From: scivision Date: Thu, 18 Jan 2024 16:45:50 -0500 Subject: 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. --- Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst | 4 ++++ 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 `. +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 ` 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 ` option. + +See :manual:`ctest(1)` for more information on parallel test execution. -- cgit v0.12