summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-11-15 14:24:28 +0000
committerKitware Robot <kwrobot@kitware.com>2021-11-15 09:24:41 -0500
commit40ae5658326f9069aae6c8da061674c485ad7ee3 (patch)
tree60cdff8c0f713a8bdc1fa9487fa9c6d1cd8b36e3
parentca4b81d69f645408cfca9960a96b835517d042a3 (diff)
parent250acbb09962623565457a85de27d480565e59d3 (diff)
downloadcmake-40ae5658326f9069aae6c8da061674c485ad7ee3.tar.gz
Merge topic 'doc-tests-labels-dynamic' into release-3.22
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
-rw-r--r--Help/command/ctest_test.rst15
-rw-r--r--Help/manual/ctest.1.rst4
-rw-r--r--Help/prop_test/LABELS.rst8
3 files changed, 22 insertions, 5 deletions
diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst
index 4e5484f1c8..6a9a6a04d8 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 03d8bf6c80..d66c5a9d58 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 8d75570959..a06f152747 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.