c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
44 lines
1.3 KiB
ReStructuredText
44 lines
1.3 KiB
ReStructuredText
ctest_update
|
|
------------
|
|
|
|
Perform the :ref:`CTest Update Step` as a :ref:`Dashboard Client`.
|
|
|
|
::
|
|
|
|
ctest_update([SOURCE <source-dir>]
|
|
[RETURN_VALUE <result-var>]
|
|
[CAPTURE_CMAKE_ERROR <result-var>]
|
|
[QUIET])
|
|
|
|
Update the source tree from version control and record results in
|
|
``Update.xml`` for submission with the :command:`ctest_submit` command.
|
|
|
|
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.
|
|
|
|
``CAPTURE_CMAKE_ERROR <result-var>``
|
|
.. versionadded:: 3.13
|
|
|
|
Store in the ``<result-var>`` variable -1 if there are any errors running
|
|
the command and prevent ctest from returning non-zero if an error occurs.
|
|
|
|
``QUIET``
|
|
.. versionadded:: 3.3
|
|
|
|
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.
|
|
|
|
The update always follows the version control branch currently checked
|
|
out in the source directory. See the :ref:`CTest Update Step`
|
|
documentation for information about variables that change the behavior
|
|
of ``ctest_update()``.
|