summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_update.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-05-07 20:10:20 (GMT)
committerBrad King <brad.king@kitware.com>2015-05-07 20:10:20 (GMT)
commit695d6f62d31efc8c979e80713dc550a1b1054e00 (patch)
treecb86f349efe3f77432cfcc08cbb5dfdbae220be1 /Help/command/ctest_update.rst
parentf8716c8b4466dd464853a5f9484ac151689c1d0c (diff)
downloadCMake-695d6f62d31efc8c979e80713dc550a1b1054e00.zip
CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.gz
CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.bz2
Help: Revise ctest_* command documentation (#15559)
Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
Diffstat (limited to 'Help/command/ctest_update.rst')
-rw-r--r--Help/command/ctest_update.rst29
1 files changed, 19 insertions, 10 deletions
diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst
index 01e357b..74af1f7 100644
--- a/Help/command/ctest_update.rst
+++ b/Help/command/ctest_update.rst
@@ -1,18 +1,27 @@
ctest_update
------------
-Update the work tree from version control.
+Perform the :ref:`CTest Update Step` as a :ref:`Dashboard Client`.
::
- ctest_update([SOURCE source] [RETURN_VALUE res] [QUIET])
+ ctest_update([SOURCE <source-dir>] [RETURN_VALUE <result-var>] [QUIET])
-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.
+Update the source tree from version control and record results in
+``Update.xml`` for submission with the :command:`ctest_submit` command.
-If QUIET is specified then CTest will suppress most non-error
-messages that it would have otherwise printed to the console.
-CTest will still report the new revision of the repository
-and any conflicting files that were found.
+The options are:
+
+``SOURCE <source-dir>``
+ Specify the source directory. If not given, the
+ :variable:`CTEST_SOURCE_DIRECTORY` variable is used.
+
+``RETURN_VALUE <result-var>``
+ Store in the ``<result-var>`` variable the number of files
+ updated or ``-1`` on error.
+
+``QUIET``
+ Tell CTest to suppress most non-error messages that it would
+ have otherwise printed to the console. CTest will still report
+ the new revision of the repository and any conflicting files
+ that were found.