diff options
| author | Brad King <brad.king@kitware.com> | 2015-05-08 13:41:24 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2015-05-08 13:41:24 (GMT) |
| commit | 6831f91a6c6d4f5d194c7a035c8de45f203f9cf8 (patch) | |
| tree | 4b5f9390168bc56dbe10e3aa5b3b808ba9379db4 /Help/command/ctest_update.rst | |
| parent | 715b3edf7d4629a84baae9c141247474a1771157 (diff) | |
| parent | 695d6f62d31efc8c979e80713dc550a1b1054e00 (diff) | |
| download | CMake-6831f91a6c6d4f5d194c7a035c8de45f203f9cf8.zip CMake-6831f91a6c6d4f5d194c7a035c8de45f203f9cf8.tar.gz CMake-6831f91a6c6d4f5d194c7a035c8de45f203f9cf8.tar.bz2 | |
Merge topic 'doc-ctest-command-formatting'
695d6f62 Help: Revise ctest_* command documentation (#15559)
f8716c8b Help: Update cmake-generators(7) organization for GHS
Diffstat (limited to 'Help/command/ctest_update.rst')
| -rw-r--r-- | Help/command/ctest_update.rst | 29 |
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. |