8279505: Update documentation for RETRY_COUNT and REPEAT_COUNT

Reviewed-by: erikj, serb
aamarsh · Jan 6, 2022 · bc12381 · bc12381
1 parent 2dbb936
commit bc12381
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/doc/testing.html b/doc/testing.html
@@ -193,9 +193,9 @@ <h4 id="launcher_options">LAUNCHER_OPTIONS</h4>
 <h4 id="aot_modules-1">AOT_MODULES</h4>
 <p>Generate AOT modules before testing for the specified module, or set of modules. If multiple modules are specified, they should be separated by space (or, to help avoid quoting issues, the special value <code>%20</code>).</p>
 <h4 id="retry_count">RETRY_COUNT</h4>
-<p>Retry failed tests up to a set number of times. Defaults to 0.</p>
+<p>Retry failed tests up to a set number of times, until they pass. This allows to pass the tests with intermittent failures. Defaults to 0.</p>
 <h4 id="repeat_count">REPEAT_COUNT</h4>
-<p>Repeat the tests for a set number of times. Defaults to 0.</p>
+<p>Repeat the tests up to a set number of times, stopping at first failure. This helps to reproduce intermittent test failures. Defaults to 0.</p>
 <h3 id="gtest-keywords">Gtest keywords</h3>
 <h4 id="repeat">REPEAT</h4>
 <p>The number of times to repeat the tests (<code>--gtest_repeat</code>).</p>

diff --git a/doc/testing.md b/doc/testing.md
@@ -419,11 +419,15 @@ modules. If multiple modules are specified, they should be separated by space
 
 #### RETRY_COUNT
 
-Retry failed tests up to a set number of times. Defaults to 0.
+Retry failed tests up to a set number of times, until they pass.
+This allows to pass the tests with intermittent failures.
+Defaults to 0.
 
 #### REPEAT_COUNT
 
-Repeat the tests for a set number of times. Defaults to 0.
+Repeat the tests up to a set number of times, stopping at first failure.
+This helps to reproduce intermittent test failures.
+Defaults to 0.
 
 ### Gtest keywords