summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_update.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/ctest_update.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/command/ctest_update.rst')
-rw-r--r--Help/command/ctest_update.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst
new file mode 100644
index 0000000..d34e192
--- /dev/null
+++ b/Help/command/ctest_update.rst
@@ -0,0 +1,13 @@
+ctest_update
+------------
+
+Update the work tree from version control.
+
+::
+
+ ctest_update([SOURCE source] [RETURN_VALUE res])
+
+Updates the given source directory and stores results in Update.xml.
+If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used.
+The RETURN_VALUE option specifies a variable in which to store the
+result, which is the number of files updated or -1 on error.