diff options
| author | Kyle Edwards <kyle.edwards@kitware.com> | 2020-07-07 14:53:55 (GMT) |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2020-07-07 16:21:58 (GMT) |
| commit | c57695a2f4ad325346e33eee655b75c1716cf957 (patch) | |
| tree | 2042da6587a8bc5c9f3132b0fad32927597fa528 /Help | |
| parent | dab33d1e3339c0f06437692db0c3e1db49765ba2 (diff) | |
| download | CMake-c57695a2f4ad325346e33eee655b75c1716cf957.zip CMake-c57695a2f4ad325346e33eee655b75c1716cf957.tar.gz CMake-c57695a2f4ad325346e33eee655b75c1716cf957.tar.bz2 | |
Help: Clarify search order for resource spec file
Clarify the order in which --resource-spec-file, RESOURCE_SPEC_FILE,
and CTEST_RESOURCE_SPEC_FILE are searched, and add tests to
enforce this.
Fixes: #20914
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 59f365f..a6fdbc9 100644 --- a/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst +++ b/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst @@ -3,3 +3,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. |