diff options
| author | Craig Scott <craig.scott@crascit.com> | 2020-07-08 13:06:31 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2020-07-08 13:06:54 (GMT) |
| commit | 32e13e52916617618d9036440a70fd464ba2ad87 (patch) | |
| tree | 370f6a3eb42f16f8a5275bea3958e371833a0bdd /Help | |
| parent | 89845851a74d3dd47275803848593c2cd27e9325 (diff) | |
| parent | c57695a2f4ad325346e33eee655b75c1716cf957 (diff) | |
| download | CMake-32e13e52916617618d9036440a70fd464ba2ad87.zip CMake-32e13e52916617618d9036440a70fd464ba2ad87.tar.gz CMake-32e13e52916617618d9036440a70fd464ba2ad87.tar.bz2 | |
Merge topic 'ctest-resource-spec-file-doc'
c57695a2f4 Help: Clarify search order for resource spec file
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4983
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/ctest.1.rst | 13 | ||||
| -rw-r--r-- | Help/variable/CTEST_RESOURCE_SPEC_FILE.rst | 5 |
2 files changed, 15 insertions, 3 deletions
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 5f953b3..d3ab75a 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -1410,9 +1410,16 @@ Resource Specification File The resource specification file is a JSON file which is passed to CTest, either on the :manual:`ctest(1)` command line as ``--resource-spec-file``, or as the -``RESOURCE_SPEC_FILE`` argument of :command:`ctest_test`. The resource -specification file must be a JSON object. All examples in this document assume -the following resource specification file: +``RESOURCE_SPEC_FILE`` argument of :command:`ctest_test`. If a dashboard script +is used and ``RESOURCE_SPEC_FILE`` is not specified, the value of +:variable:`CTEST_RESOURCE_SPEC_FILE` in the dashboard script is used instead. +If ``--resource-spec-file``, ``RESOURCE_SPEC_FILE``, and +:variable:`CTEST_RESOURCE_SPEC_FILE` in the dashboard script are not specified, +the value of :variable:`CTEST_RESOURCE_SPEC_FILE` in the CMake build is used +instead. If none of these are specified, no resource spec file is used. + +The resource specification file must be a JSON object. All examples in this +document assume the following resource specification file: .. code-block:: json diff --git a/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst b/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst index 0df29c9..8e9bf01 100644 --- a/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst +++ b/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst @@ -5,3 +5,8 @@ CTEST_RESOURCE_SPEC_FILE Specify the CTest ``ResourceSpecFile`` setting in a :manual:`ctest(1)` dashboard client script. + +This can also be used to specify the resource spec file from a CMake build. If +no ``RESOURCE_SPEC_FILE`` is passed to :command:`ctest_test`, and +``CTEST_RESOURCE_SPEC_FILE`` is not specified in the dashboard script, the +value of this variable from the build is used. |