summaryrefslogtreecommitdiffstats
path: root/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2020-07-07 14:53:55 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2020-07-07 16:21:58 (GMT)
commitc57695a2f4ad325346e33eee655b75c1716cf957 (patch)
tree2042da6587a8bc5c9f3132b0fad32927597fa528 /Help/variable/CTEST_RESOURCE_SPEC_FILE.rst
parentdab33d1e3339c0f06437692db0c3e1db49765ba2 (diff)
downloadCMake-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/variable/CTEST_RESOURCE_SPEC_FILE.rst')
-rw-r--r--Help/variable/CTEST_RESOURCE_SPEC_FILE.rst5
1 files changed, 5 insertions, 0 deletions
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.