summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-05-30 18:15:55 (GMT)
committerBrad King <brad.king@kitware.com>2014-05-30 18:15:55 (GMT)
commit28f73dffbf7cea391b2141994d0405bb867fb63f (patch)
treea9a79381edf44427b9dcf6c74d9c432bee25b2f9 /Help/command
parentc4a26b70cbaa1708b3ad28f2d09976fd7b1c925e (diff)
downloadCMake-28f73dffbf7cea391b2141994d0405bb867fb63f.zip
CMake-28f73dffbf7cea391b2141994d0405bb867fb63f.tar.gz
CMake-28f73dffbf7cea391b2141994d0405bb867fb63f.tar.bz2
Help: Document ctest_start initial checkout command variables
Describe the behavior of the ctest_start() command when the CTEST_CHECKOUT_COMMAND or CTEST_CVS_CHECKOUT variable is set.
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/ctest_start.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Help/command/ctest_start.rst b/Help/command/ctest_start.rst
index f16142e..b5c7a17 100644
--- a/Help/command/ctest_start.rst
+++ b/Help/command/ctest_start.rst
@@ -14,3 +14,9 @@ CTEST_SOURCE_DIRECTORY and CTEST_BINARY_DIRECTORY. If the track is
specified, the submissions will go to the specified track. If APPEND
is used, the existing TAG is used rather than creating a new one based
on the current time stamp.
+
+If the ``CTEST_CHECKOUT_COMMAND`` variable (or the ``CTEST_CVS_CHECKOUT``
+variable) is set, its content is treated as command-line. The command is
+invoked with the current working directory set to the parent of the source
+directory, even if the source directory already exists. This can be used
+to create the source tree from a version control repository.