summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2020-04-29 18:49:19 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2020-04-29 18:49:19 (GMT)
commitc1397ace1dfc595c02e9cc7ee8392c085530c014 (patch)
tree5665d64f79b08d89f99f69784e5179ac67e0d7c1
parentd63c442a6bcec287afb32a88c80b68cb141f49f4 (diff)
downloadCMake-c1397ace1dfc595c02e9cc7ee8392c085530c014.zip
CMake-c1397ace1dfc595c02e9cc7ee8392c085530c014.tar.gz
CMake-c1397ace1dfc595c02e9cc7ee8392c085530c014.tar.bz2
Help: Clarify why CTEST_NIGHTLY_START_TIME is needed
-rw-r--r--Help/variable/CTEST_NIGHTLY_START_TIME.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/Help/variable/CTEST_NIGHTLY_START_TIME.rst b/Help/variable/CTEST_NIGHTLY_START_TIME.rst
index bc80276..90841f9 100644
--- a/Help/variable/CTEST_NIGHTLY_START_TIME.rst
+++ b/Help/variable/CTEST_NIGHTLY_START_TIME.rst
@@ -1,5 +1,9 @@
CTEST_NIGHTLY_START_TIME
------------------------
-Specify the CTest ``NightlyStartTime`` setting
-in a :manual:`ctest(1)` dashboard client script.
+Specify the CTest ``NightlyStartTime`` setting in a :manual:`ctest(1)`
+dashboard client script.
+
+Note that this variable must always be set for a nightly build in a
+dashboard script. It is needed so that nightly builds can be properly grouped
+together in CDash.