summaryrefslogtreecommitdiffstats
path: root/Help/manual/ctest.1.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-03-11 14:18:38 (GMT)
committerKitware Robot <kwrobot@kitware.com>2024-03-11 14:18:49 (GMT)
commit04d8bc6bb9727b667b8a0d339c7803befce337f2 (patch)
tree51b6488c733279d704a2c25dc7bbb9fdb2d74226 /Help/manual/ctest.1.rst
parentda334e2db9e9c931e833ed7f38bf6bdb607312d4 (diff)
parent5de1e21659090ca83e39e223d351e353347eb88e (diff)
downloadCMake-04d8bc6bb9727b667b8a0d339c7803befce337f2.zip
CMake-04d8bc6bb9727b667b8a0d339c7803befce337f2.tar.gz
CMake-04d8bc6bb9727b667b8a0d339c7803befce337f2.tar.bz2
Merge topic 'ctest-j-default' into release-3.29
5de1e21659 ctest: Allow passing -j without value to choose a contextual default bbcbcff7d9 cmCTestMultiProcessHandler: Modernize member initialization 7457b474a1 Tests: Remove unnecessary parallel suppression from CTestCoverageCollectGCOV ae69801d96 Tests: Convert CTestTestSkipReturnCode to RunCMake.ctest_test case 30dda49416 Tests: Convert CTestTestSerialOrder to RunCMake.ctest_test case Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Acked-by: scivision <michael@scivision.dev> Merge-request: !9315
Diffstat (limited to 'Help/manual/ctest.1.rst')
-rw-r--r--Help/manual/ctest.1.rst24
1 files changed, 17 insertions, 7 deletions
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst
index 9f2eb13..0e90ab6 100644
--- a/Help/manual/ctest.1.rst
+++ b/Help/manual/ctest.1.rst
@@ -118,17 +118,27 @@ Run Tests
previously interrupted. If no interruption occurred, the ``-F`` option
will have no effect.
-.. option:: -j <jobs>, --parallel <jobs>
+.. option:: -j [<level>], --parallel [<level>]
- Run the tests in parallel using the given number of jobs.
+ Run tests in parallel, optionally limited to a given level of parallelism.
- This option tells CTest to run the tests in parallel using given
- number of jobs. This option can also be set by setting the
- :envvar:`CTEST_PARALLEL_LEVEL` environment variable.
+ .. versionadded:: 3.29
- This option can be used with the :prop_test:`PROCESSORS` test property.
+ The ``<level>`` may be omitted, or ``0``, in which case:
- See `Label and Subproject Summary`_.
+ * Under `Job Server Integration`_, parallelism is limited by
+ available job tokens.
+
+ * Otherwise, if the value is omitted, parallelism is limited
+ by the number of processors, or 2, whichever is larger.
+
+ * Otherwise, if the value is ``0``, parallelism is unbounded.
+
+ This option may instead be specified by the :envvar:`CTEST_PARALLEL_LEVEL`
+ environment variable.
+
+ This option can be used with the :prop_test:`PROCESSORS` test property.
+ See the `Label and Subproject Summary`_.
.. option:: --resource-spec-file <file>