diff options
author | Brad King <brad.king@kitware.com> | 2021-11-15 14:24:28 (GMT) |
---|---|---|
committer | Kitware Robot <kwrobot@kitware.com> | 2021-11-15 14:24:42 (GMT) |
commit | 39624cc9119c9438966d3fabe9dfef65982ce359 (patch) | |
tree | 345ef3fbaeec20b8102d3dc539dabbc5f9a6fb69 /Help | |
parent | acc3d6bbf102f43c6862906bb1991891fd983e10 (diff) | |
parent | 250acbb09962623565457a85de27d480565e59d3 (diff) | |
download | CMake-39624cc9119c9438966d3fabe9dfef65982ce359.zip CMake-39624cc9119c9438966d3fabe9dfef65982ce359.tar.gz CMake-39624cc9119c9438966d3fabe9dfef65982ce359.tar.bz2 |
Merge topic 'doc-tests-labels-dynamic'
250acbb099 Help: Improve cross-referencing of test LABELS and related features
a77bdefa3e Help: Add missing version details for Additional Test Measurements
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6726
Diffstat (limited to 'Help')
-rw-r--r-- | Help/command/ctest_test.rst | 15 | ||||
-rw-r--r-- | Help/manual/ctest.1.rst | 4 | ||||
-rw-r--r-- | Help/prop_test/LABELS.rst | 8 |
3 files changed, 22 insertions, 5 deletions
diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 4e5484f..6a9a6a0 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -190,9 +190,10 @@ Check the `CDash test measurement documentation <https://github.com/Kitware/CDash/blob/master/docs/test_measurements.md>`_ for more information on the types of test measurements that CDash recognizes. -Starting in version 3.22, CTest can parse custom measurements from tags named -``<CTestMeasurement>`` or ``<CTestMeasurementFile>``. The older names -``<DartMeasurement>`` and ``<DartMeasurementFile>`` are still supported. +.. versionadded: 3.22 + CTest can parse custom measurements from tags named + ``<CTestMeasurement>`` or ``<CTestMeasurementFile>``. The older names + ``<DartMeasurement>`` and ``<DartMeasurementFile>`` are still supported. The following example demonstrates how to output a variety of custom test measurements. @@ -256,6 +257,8 @@ separate from the interactive comparison UI. Attached Files """""""""""""" +.. versionadded:: 3.21 + The following example demonstrates how to upload non-image files to CDash. .. code-block:: c++ @@ -273,6 +276,8 @@ properties instead. Custom Details """""""""""""" +.. versionadded:: 3.21 + The following example demonstrates how to specify a custom value for the ``Test Details`` field displayed on CDash. @@ -281,9 +286,13 @@ 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 """"""""""""""""" +.. versionadded:: 3.22 + The following example demonstrates how to add additional labels to a test at runtime. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 52e8009..1e7b077 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. |