diff options
| author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-07 20:30:30 (GMT) |
|---|---|---|
| committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-09 15:51:57 (GMT) |
| commit | c705279bae45c85b689febd66d5437d9ec05c9b9 (patch) | |
| tree | f64bca14f17a902a96d67a30357df3d1e6c745eb /Help/command/ctest_update.rst | |
| parent | 63a1917d098922b59bbba8fdeb42519363d5ba0d (diff) | |
| download | CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.zip CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.gz CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.bz2 | |
Help: Add `.. versionadded` directives to commands documentation
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
Diffstat (limited to 'Help/command/ctest_update.rst')
| -rw-r--r-- | Help/command/ctest_update.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst index 96a11c9..63f991b 100644 --- a/Help/command/ctest_update.rst +++ b/Help/command/ctest_update.rst @@ -24,10 +24,14 @@ The options are: 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 |