From a77bdefa3e966fce5eac0a2a9f44b79207937304 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sat, 13 Nov 2021 20:44:05 +1100 Subject: Help: Add missing version details for Additional Test Measurements --- Help/command/ctest_test.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 4e5484f..2ed890a 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -190,9 +190,10 @@ Check the `CDash test measurement documentation `_ 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 -```` or ````. The older names -```` and ```` are still supported. +.. versionadded: 3.22 + CTest can parse custom measurements from tags named + ```` or ````. The older names + ```` and ```` 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. @@ -284,6 +289,8 @@ The following example demonstrates how to specify a custom value for the Additional Labels """"""""""""""""" +.. versionadded:: 3.22 + The following example demonstrates how to add additional labels to a test at runtime. -- cgit v0.12 From 250acbb09962623565457a85de27d480565e59d3 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sat, 13 Nov 2021 20:45:05 +1100 Subject: Help: Improve cross-referencing of test LABELS and related features --- Help/command/ctest_test.rst | 2 ++ Help/manual/ctest.1.rst | 4 ++++ 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 << "My Custom Details Value" << 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. -- cgit v0.12