diff options
author | Craig Scott <craig.scott@crascit.com> | 2021-11-13 09:45:05 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2021-11-13 09:45:05 (GMT) |
commit | 250acbb09962623565457a85de27d480565e59d3 (patch) | |
tree | e2db440d1f6bf3be12efc7f9a9da1a96d2201b5c /Help | |
parent | a77bdefa3e966fce5eac0a2a9f44b79207937304 (diff) | |
download | CMake-250acbb09962623565457a85de27d480565e59d3.zip CMake-250acbb09962623565457a85de27d480565e59d3.tar.gz CMake-250acbb09962623565457a85de27d480565e59d3.tar.bz2 |
Help: Improve cross-referencing of test LABELS and related features
Diffstat (limited to 'Help')
-rw-r--r-- | Help/command/ctest_test.rst | 2 | ||||
-rw-r--r-- | Help/manual/ctest.1.rst | 4 | ||||
-rw-r--r-- | Help/prop_test/LABELS.rst | 8 |
3 files changed, 12 insertions, 2 deletions
diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 2ed890a..6a9a6a0 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -286,6 +286,8 @@ The following example demonstrates how to specify a custom value for the std::cout << "<CTestDetails>My Custom Details Value</CTestDetails>" << std::endl; +.. _`Additional Labels`: + Additional Labels """"""""""""""""" diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 03d8bf6..d66c5a9 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -464,6 +464,10 @@ CTest prints timing summary information for each ``LABEL`` and subproject associated with the tests run. The label time summary will not include labels that are mapped to subprojects. +.. versionadded:: 3.22 + Labels added dynamically during test execution are also reported in the + timing summary. See :ref:`Additional Labels`. + When the :prop_test:`PROCESSORS` test property is set, CTest will display a weighted test timing result in label and subproject summaries. The time is reported with `sec*proc` instead of just `sec`. diff --git a/Help/prop_test/LABELS.rst b/Help/prop_test/LABELS.rst index 8d75570..a06f152 100644 --- a/Help/prop_test/LABELS.rst +++ b/Help/prop_test/LABELS.rst @@ -1,6 +1,10 @@ LABELS ------ -Specify a list of text labels associated with a test. +Specify a list of text labels associated with a test. The labels are +reported in both the ``ctest`` output summary and in dashboard submissions. +They can also be used to filter the set of tests to be executed (see the +``ctest -L`` and ``ctest -LE`` :ref:`CTest Options`). -The list is reported in dashboard submissions. +See :ref:`Additional Labels` for adding labels to a test dynamically during +test execution. |