ctest_update.rst 976 B

12345678910111213141516171819202122232425262728293031
  1. ctest_update
  2. ------------
  3. Perform the :ref:`CTest Update Step` as a :ref:`Dashboard Client`.
  4. ::
  5. ctest_update([SOURCE <source-dir>] [RETURN_VALUE <result-var>] [QUIET])
  6. Update the source tree from version control and record results in
  7. ``Update.xml`` for submission with the :command:`ctest_submit` command.
  8. The options are:
  9. ``SOURCE <source-dir>``
  10. Specify the source directory. If not given, the
  11. :variable:`CTEST_SOURCE_DIRECTORY` variable is used.
  12. ``RETURN_VALUE <result-var>``
  13. Store in the ``<result-var>`` variable the number of files
  14. updated or ``-1`` on error.
  15. ``QUIET``
  16. Tell CTest to suppress most non-error messages that it would
  17. have otherwise printed to the console. CTest will still report
  18. the new revision of the repository and any conflicting files
  19. that were found.
  20. The update always follows the version control branch currently checked
  21. out in the source directory. See the :ref:`CTest Update Step`
  22. documentation for more information.