diff options
| author |  Googler <noreply@google.com> | 2015-04-16 16:04:27 +0000 |
|---|---|---|
| committer |  Kristina Chodorow <kchodorow@google.com> | 2015-04-16 18:38:52 +0000 |
| commit | 2df6c5f52259e4706900514e1ef86b76710b1f02 (patch) | |
| tree | 5e6de722e0f860a8e92bd278d61ef6cec640d82f /site/docs/test-encyclopedia.html | |
| parent | 29b05c8e6c48b4028a06cd788d833506cce090eb (diff) | |
Update the Test Encylopedia with a description of the TEST_TIMEOUT env variable that was introduced in
--
MOS_MIGRATED_REVID=91304016
Diffstat (limited to 'site/docs/test-encyclopedia.html')
| -rw-r--r-- | site/docs/test-encyclopedia.html | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/site/docs/test-encyclopedia.html b/site/docs/test-encyclopedia.html index 2931933dd8..cd69c4b402 100644 --- a/site/docs/test-encyclopedia.html +++ b/site/docs/test-encyclopedia.html @@ -99,7 +99,7 @@ runner otherwise detects prohibited behavior, it may choose to kill the test and treat the run as a failure. The runner must not report the test as passing after sending a signal to the test process or any children thereof.</p> -<p id="size">The whole test target (not individual methods or tests) is given a +<p id="timeout">The whole test target (not individual methods or tests) is given a limited amount of time to run to completion. The time limit for a test is based on its timeout attribute according to the following table:</p> <table> @@ -110,7 +110,7 @@ on its timeout attribute according to the following table:</p> <tr><td><code>eternal</code></td><td>3600</td></tr> </table> -<p>Tests which do not explicitly specify a timeout have one implied based on the +<p id="size">Tests which do not explicitly specify a timeout have one implied based on the test's <code>size</code> as follows:</p> <table> <tr><th>size</th><th>Implied timeout label</th></tr> @@ -179,6 +179,7 @@ test unless the user explicitly requests it.</p> <tr><td><code>TEST_PREMATURE_EXIT_FILE</code></td><td>absolute path to a private file in a writable directory (used for catching calls to exit())</td><td>optional</td></tr> <tr><td><code>TEST_RANDOM_SEED</code></td><td>See <a href="bazel-user-manual.html#other_options_for_blaze_test">this table</a>.</td><td>optional</td></tr> <tr><td><code>TEST_SIZE</code></td><td>The test <a href="#size"><code>size</code></a></td><td>optional</td></tr> + <tr><td><code>TEST_TIMEOUT</code></td><td>The test <a href="#timeout"><code>timeout</code></a></td><td>optional</td></tr> <tr><td><code>TEST_SRCDIR</code></td><td>absolute path to the base of the runfiles tree</td><td>required</td></tr> <tr><td><code>TEST_TMPDIR</code></td><td>absolute path to a private writable directory</td><td>required</td></tr> <tr><td><code>TEST_TIMEOUT</code></td><td><code>300</code></td><td>optional</td></tr> |