1ctest_update 2------------ 3 4Perform the :ref:`CTest Update Step` as a :ref:`Dashboard Client`. 5 6:: 7 8 ctest_update([SOURCE <source-dir>] 9 [RETURN_VALUE <result-var>] 10 [CAPTURE_CMAKE_ERROR <result-var>] 11 [QUIET]) 12 13Update the source tree from version control and record results in 14``Update.xml`` for submission with the :command:`ctest_submit` command. 15 16The options are: 17 18``SOURCE <source-dir>`` 19 Specify the source directory. If not given, the 20 :variable:`CTEST_SOURCE_DIRECTORY` variable is used. 21 22``RETURN_VALUE <result-var>`` 23 Store in the ``<result-var>`` variable the number of files 24 updated or ``-1`` on error. 25 26``CAPTURE_CMAKE_ERROR <result-var>`` 27 .. versionadded:: 3.13 28 29 Store in the ``<result-var>`` variable -1 if there are any errors running 30 the command and prevent ctest from returning non-zero if an error occurs. 31 32``QUIET`` 33 .. versionadded:: 3.3 34 35 Tell CTest to suppress most non-error messages that it would 36 have otherwise printed to the console. CTest will still report 37 the new revision of the repository and any conflicting files 38 that were found. 39 40The update always follows the version control branch currently checked 41out in the source directory. See the :ref:`CTest Update Step` 42documentation for information about variables that change the behavior 43of ``ctest_update()``. 44