diff options
Diffstat (limited to 'src/main/java/com/google/devtools/build')
-rw-r--r-- | src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html | 11 | ||||
-rw-r--r-- | src/main/java/com/google/devtools/build/docgen/templates/attributes/test/timeout.html | 38 |
2 files changed, 38 insertions, 11 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html index e1807113b8..73aeb505ed 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html @@ -8,38 +8,43 @@ it needs to run.</p> <p>Unittests are considered "small", integration tests "medium", and end-to-end tests "large" or "enormous". Bazel uses the size to determine a default timeout (which can be overridden using the -"timeout" attribute) and the amount of resources that have to be acquired for the test to run. -The mapping of test size to resource is currently:</p> +<code>timeout</code> attribute) and the amount of resources that have to be acquired for the test to +run. Test sizes correspond to the following resources and default timeouts:</p> <table style="width: 100%"> <tr> - <th>size</th> + <th>Size</th> <th>RAM (in MB)</th> <th>CPU (in CPU cores)</th> <th>I/O (fraction)</th> + <th>Default timeout</th> </tr> <tr> <td>small</td> <td>20</td> <td>0.9</td> <td>0</td> + <td>short (1 minute)</td> </tr> <tr> <td>medium</td> <td>100</td> <td>0.9</td> <td>0.1</td> + <td>moderate (5 minutes)</td> </tr> <tr> <td>large</td> <td>300</td> <td>0.8</td> <td>0.1</td> + <td>long (15 minutes)</td> </tr> <tr> <td>enormous</td> <td>800</td> <td>0.7</td> <td>0.4</td> + <td>eternal (60 minutes)</td> </tr> </table> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/timeout.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/timeout.html index 440bec41c1..d11d0a4bc6 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/timeout.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/timeout.html @@ -1,16 +1,38 @@ -<p><code>String "eternal", "long", "moderate", or "short" -with the default derived from a test's size attribute)</code></p> +<p><code>String "short", "moderate", "long", "eternal" +(with the default derived from the test's size attribute)</code></p> <p> -How long the test is normally expected to run before returning. +How long the test is expected to run before returning. </p> <p> While a test's size attribute controls resource estimation, a test's timeout may be set independently. If not explicitly specified, the -timeout is based on the test's size (with "small" ⇒ "short", -"medium" ⇒ "moderate", etc...). By default, "short" means 1 minute, -"moderate" 5 minutes, "long" 15 minutes, and "eternal" 60 minutes (this -can be overridden with --test_timeout, e.g. for running under certain -configurations which are known to be slow). +timeout is based on the <a href="#test.size">test's size</a>. The test +timeout can be overridden with the <code>--test_timeout</code> flag, e.g. for +running under certain conditions which are known to be slow. Test timeout values +correspond to the following time periods: </p> + +<table style="width: 100%"> + <tr> + <th>Timeout Value</th> + <th>Time Period</th> + </tr> + <tr> + <td>short</td> + <td>1 minute</td> + </tr> + <tr> + <td>moderate</td> + <td>5 minutes</td> + </tr> + <tr> + <td>long</td> + <td>15 minutes</td> + </tr> + <tr> + <td>eternal</td> + <td>60 minutes</td> + </tr> +</table> |