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_test.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_test.rst')
-rw-r--r-- | Help/command/ctest_test.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 3589296..b4493a0 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -68,6 +68,8 @@ The options are: Tests not matching this expression are excluded. ``EXCLUDE_FIXTURE <regex>`` + .. versionadded:: 3.7 + If a test in the set of tests to be executed requires a particular fixture, that fixture's setup and cleanup tests would normally be added to the test set automatically. This option prevents adding setup or cleanup tests for @@ -76,9 +78,13 @@ The options are: setup tests that fail. ``EXCLUDE_FIXTURE_SETUP <regex>`` + .. versionadded:: 3.7 + Same as ``EXCLUDE_FIXTURE`` except only matching setup tests are excluded. ``EXCLUDE_FIXTURE_CLEANUP <regex>`` + .. versionadded:: 3.7 + Same as ``EXCLUDE_FIXTURE`` except only matching cleanup tests are excluded. ``PARALLEL_LEVEL <level>`` @@ -86,11 +92,15 @@ The options are: be run in parallel. ``RESOURCE_SPEC_FILE <file>`` + .. versionadded:: 3.16 + Specify a :ref:`resource specification file <ctest-resource-specification-file>`. See :ref:`ctest-resource-allocation` for more information. ``TEST_LOAD <threshold>`` + .. versionadded:: 3.4 + While running tests in parallel, try not to start tests when they may cause the CPU load to pass above a given threshold. If not specified the :variable:`CTEST_TEST_LOAD` variable will be checked, @@ -98,6 +108,8 @@ The options are: See also the ``TestLoad`` setting in the :ref:`CTest Test Step`. ``REPEAT <mode>:<n>`` + .. versionadded:: 3.17 + Run tests repeatedly based on the given ``<mode>`` up to ``<n>`` times. The modes are: @@ -121,6 +133,8 @@ The options are: implicit test dependencies. ``STOP_ON_FAILURE`` + .. versionadded:: 3.18 + Stop the execution of the tests once one has failed. ``STOP_TIME <time-of-day>`` @@ -131,10 +145,14 @@ The options are: Store non-zero if anything went wrong. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.7 + 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 + Suppress any CTest-specific non-error messages that would have otherwise been printed to the console. Output from the underlying test command is not affected. Summary info detailing the percentage of passing tests is also |