diff options
author | Brad King <brad.king@kitware.com> | 2019-11-15 14:28:37 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2019-11-15 15:08:33 (GMT) |
commit | 32c165d2636a65362265d20a16e1f914a53882dd (patch) | |
tree | d7db33083d84370fffc281deda848786fd2b2952 /Help | |
parent | c1ae0532f3a1d6d2c7b6e8f370be2a6dca89bf93 (diff) | |
download | CMake-32c165d2636a65362265d20a16e1f914a53882dd.zip CMake-32c165d2636a65362265d20a16e1f914a53882dd.tar.gz CMake-32c165d2636a65362265d20a16e1f914a53882dd.tar.bz2 |
CTest: Consolidate '--repeat-* n' options as `--repeat *:n`
Combine `--repeat-until-fail`, `--repeat-until-pass`, and
`--repeat-after-timeout` to create a single `--repeat <mode>:<n>`
option. Retain `--repeat-until-fail` too because that has been
available in previous releases.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/ctest.1.rst | 30 | ||||
-rw-r--r-- | Help/release/dev/ctest-repeat-until-pass.rst | 9 | ||||
-rw-r--r-- | Help/release/dev/ctest-repeat.rst | 10 |
3 files changed, 27 insertions, 22 deletions
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 328f579..2a6cb48 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -261,23 +261,27 @@ Options fail, subsequent calls to CTest with the ``--rerun-failed`` option will run the set of tests that most recently failed (if any). -``--repeat-until-fail <n>`` - Require each test to run ``<n>`` times without failing in order to pass. - - This is useful in finding sporadic failures in test cases. +``--repeat <mode>:<n>`` + Run tests repeatedly based on the given ``<mode>`` up to ``<n>`` times. + The modes are: -``--repeat-until-pass <n>`` - Allow each test to run up to ``<n>`` times in order to pass. - Repeats tests if they fail for any reason. + ``until-fail`` + Require each test to run ``<n>`` times without failing in order to pass. + This is useful in finding sporadic failures in test cases. - This is useful in tolerating sporadic failures in test cases. + ``until-pass`` + Allow each test to run up to ``<n>`` times in order to pass. + Repeats tests if they fail for any reason. + This is useful in tolerating sporadic failures in test cases. -``--repeat-after-timeout <n>`` - Allow each test to run up to ``<n>`` times in order to pass. - Repeats tests only if they timeout. + ``after-timeout`` + Allow each test to run up to ``<n>`` times in order to pass. + Repeats tests only if they timeout. + This is useful in tolerating sporadic timeouts in test cases + on busy machines. - This is useful in tolerating sporadic timeouts in test cases - on busy machines. +``--repeat-until-fail <n>`` + Equivalent to ``--repeat until-fail:<n>``. ``--max-width <width>`` Set the max width for a test name to output. diff --git a/Help/release/dev/ctest-repeat-until-pass.rst b/Help/release/dev/ctest-repeat-until-pass.rst deleted file mode 100644 index b5f6c26..0000000 --- a/Help/release/dev/ctest-repeat-until-pass.rst +++ /dev/null @@ -1,9 +0,0 @@ -ctest-repeat-until-pass ------------------------ - -* The :manual:`ctest(1)` tool learned new ``--repeat-until-pass <n>`` - and ``--repeat-after-timeout <n>`` options to help tolerate sporadic - test failures. - -* The :command:`ctest_test` command gained a ``REPEAT <mode>:<n>`` option - to specify conditions in which to repeat tests. diff --git a/Help/release/dev/ctest-repeat.rst b/Help/release/dev/ctest-repeat.rst new file mode 100644 index 0000000..b1ff59b --- /dev/null +++ b/Help/release/dev/ctest-repeat.rst @@ -0,0 +1,10 @@ +ctest-repeat +------------ + +* The :manual:`ctest(1)` tool gained a ``--repeat <mode>:<n>`` option + to specify conditions in which to repeat tests. This generalizes + the existing ``--repeat-until-fail <n>`` option to add modes for + ``until-pass`` and ``after-timeout``. + +* The :command:`ctest_test` command gained a ``REPEAT <mode>:<n>`` option + to specify conditions in which to repeat tests. |