diff options
| author | Kyle Edwards <kyle.edwards@kitware.com> | 2023-07-20 20:57:02 (GMT) |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2023-08-10 20:47:51 (GMT) |
| commit | c8c1dd0d9540acbe6172afe192c149fe04d0625b (patch) | |
| tree | dfbd13051070176f318fcdb1fb0ae10f1e7912e1 /Help | |
| parent | 3f5a5a5856790107bba5cad6d9d45d1170b986f1 (diff) | |
| download | CMake-c8c1dd0d9540acbe6172afe192c149fe04d0625b.zip CMake-c8c1dd0d9540acbe6172afe192c149fe04d0625b.tar.gz CMake-c8c1dd0d9540acbe6172afe192c149fe04d0625b.tar.bz2 | |
CTest: Add ability to dynamically generate resource spec file
Issue: #25106
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-properties.7.rst | 1 | ||||
| -rw-r--r-- | Help/manual/ctest.1.rst | 19 | ||||
| -rw-r--r-- | Help/prop_test/GENERATED_RESOURCE_SPEC_FILE.rst | 7 | ||||
| -rw-r--r-- | Help/release/dev/dynamically-generated-resource-spec-file.rst | 6 |
4 files changed, 33 insertions, 0 deletions
diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst index 4df0547..c8a433d 100644 --- a/Help/manual/cmake-properties.7.rst +++ b/Help/manual/cmake-properties.7.rst @@ -503,6 +503,7 @@ Properties on Tests /prop_test/FIXTURES_CLEANUP /prop_test/FIXTURES_REQUIRED /prop_test/FIXTURES_SETUP + /prop_test/GENERATED_RESOURCE_SPEC_FILE /prop_test/LABELS /prop_test/MEASUREMENT /prop_test/PASS_REGULAR_EXPRESSION diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 994ae47..effe4b1 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -1817,6 +1817,25 @@ The following variables are passed to the test process: uppercase in the ``CTEST_RESOURCE_GROUP_<num>_<resource-type>`` environment variable. +.. _`ctest-resource-dynamically-generated-spec-file`: + +Dynamically-Generated Resource Specification File +------------------------------------------------- + +.. versionadded:: 3.28 + +A project may optionally specify a single test which will be used to +dynamically generate the resource specification file that CTest will use for +scheduling tests that use resources. The test that generates the file must +have the :prop_test:`GENERATED_RESOURCE_SPEC_FILE` property set, and must have +exactly one fixture in its :prop_test:`FIXTURES_SETUP` property. This fixture +is considered by CTest to have special meaning: it's the fixture that generates +the resource spec file. The fixture may have any name. If such a fixture +exists, all tests that have :prop_test:`RESOURCE_GROUPS` set must have the +fixture in their :prop_test:`FIXTURES_REQUIRED`, and a resource spec file may +not be specified with the ``--resource-spec-file`` argument or the +:variable:`CTEST_RESOURCE_SPEC_FILE` variable. + See Also ======== diff --git a/Help/prop_test/GENERATED_RESOURCE_SPEC_FILE.rst b/Help/prop_test/GENERATED_RESOURCE_SPEC_FILE.rst new file mode 100644 index 0000000..89596ac --- /dev/null +++ b/Help/prop_test/GENERATED_RESOURCE_SPEC_FILE.rst @@ -0,0 +1,7 @@ +GENERATED_RESOURCE_SPEC_FILE +---------------------------- + +.. versionadded:: 3.28 + +Path to the :ref:`dynamically-generated resource spec file +<ctest-resource-dynamically-generated-spec-file>` generated by this test. diff --git a/Help/release/dev/dynamically-generated-resource-spec-file.rst b/Help/release/dev/dynamically-generated-resource-spec-file.rst new file mode 100644 index 0000000..c4b3899 --- /dev/null +++ b/Help/release/dev/dynamically-generated-resource-spec-file.rst @@ -0,0 +1,6 @@ +dynamically-generated-resource-spec-file +---------------------------------------- + +* CTest may now take a :ref:`dynamically-generated resource spec file + <ctest-resource-dynamically-generated-spec-file>`, which can be specified by the + :prop_test:`GENERATED_RESOURCE_SPEC_FILE` test property. |