mirrors/cmake
2
0
Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-09-25 04:09:36 +03:00
Code Activity

Help: Document plain ctest command-line signature and exit code

Browse Source
This commit is contained in:
Brad King
2026-03-02 12:20:07 -05:00
parent f453a38d37
commit fa7c993ef9
1 changed files with 35 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/manual/ctest.1.rst
+35 -7
View File
@@ -11,7 +11,7 @@ Synopsis
.. parsed-literal::
`Run Tests`_
ctest [<options>] [--test-dir <path-to-build>]
ctest [<options>...] [--test-dir <path-to-build>]
`Build and Test Mode`_
ctest --build-and-test <path-to-source> <path-to-build>
@@ -42,6 +42,26 @@ This program will run the tests and report results.
Run Tests
=========
:program:`ctest` runs tests defined by a ``CTestTestfile.cmake`` file,
typically in a build tree generated by :manual:`cmake(1)`:
.. code-block:: shell
ctest [<options>...] [--test-dir <path-to-build>]
If all tests pass, the exit code is ``0``. The exit code is non-zero
in the following cases:
* An error occurs, such as failure to process invalid arguments.
* The :option:`--no-tests=error <ctest --no-tests>` argument is given and no
tests are executed, e.g., when ``CTestTestfile.cmake`` defines no tests,
or when the given arguments exclude all tests.
* At least one test fails.
The options for running tests are:
.. program:: ctest
.. option:: --preset <preset>, --preset=<preset>
@@ -484,13 +504,21 @@ Run Tests
.. option:: --no-tests=<action>
Regard no tests found either as error (when ``<action>`` is set to
``error``) or ignore it (when ``<action>`` is set to ``ignore``).
Specify behavior when no tests are executed, e.g., when
``CTestTestfile.cmake`` defines no tests, or when the given arguments
exclude all tests. The ``<action>`` may be one of:
If no tests were found, the default behavior of CTest is to always log an
error message but to return an error code in script mode only. This option
unifies the behavior of CTest by either returning an error code if no tests
were found or by ignoring it.
``error``
Consider running no tests to be an error.
This is the default when running :option:`ctest -S` scripts.
``ignore``
Consider running no tests to be normal.
This is the default when `running tests <Run Tests_>`__ via the
:program:`ctest` command line, even when running as a
`dashboard client <Dashboard Client_>`__.
.. versionadded:: 3.26