Skip to content

Commit 103cd91

Browse files
wangxueserikj79
authored andcommitted
8230079: Update test document by changing "TIMEOUT" to "TIMEOUT_FACTOR"
Reviewed-by: erikj
1 parent fb3b0ab commit 103cd91

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

doc/building.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -572,6 +572,7 @@ <h4 id="advanced-make-control-variables">Advanced Make Control Variables</h4>
572572
<li><code>CONF_CHECK</code></li>
573573
<li><code>COMPARE_BUILD</code></li>
574574
<li><code>JDK_FILTER</code></li>
575+
<li><code>SPEC_FILTER</code></li>
575576
</ul>
576577
<h2 id="running-tests">Running Tests</h2>
577578
<p>Most of the JDK tests are using the <a href="http://openjdk.java.net/jtreg">JTReg</a> test framework. Make sure that your configuration knows where to find your installation of JTReg. If this is not picked up automatically, use the <code>--with-jtreg=&lt;path to jtreg home&gt;</code> option to point to the JTReg framework. Note that this option should point to the JTReg home, i.e. the top directory, containing <code>lib/jtreg.jar</code> etc.</p>

doc/testing.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ <h2 id="using-make-test-the-run-test-framework">Using &quot;make test&quot; (the
5454
$ make test-jdk_lang JTREG=&quot;JOBS=8&quot;
5555
$ make test TEST=jdk_lang
5656
$ make test-only TEST=&quot;gtest:LogTagSet gtest:LogTagSetDescriptions&quot; GTEST=&quot;REPEAT=-1&quot;
57-
$ make test TEST=&quot;hotspot:hotspot_gc&quot; JTREG=&quot;JOBS=1;TIMEOUT=8;VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug&quot;
57+
$ make test TEST=&quot;hotspot:hotspot_gc&quot; JTREG=&quot;JOBS=1;TIMEOUT_FACTOR=8;VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug&quot;
5858
$ make test TEST=&quot;jtreg:test/hotspot:hotspot_gc test/hotspot/jtreg/native_sanity/JniVersion.java&quot;
5959
$ make test TEST=&quot;micro:java.lang.reflect&quot; MICRO=&quot;FORK=1;WARMUP_ITER=2&quot;
6060
$ make exploded-test TEST=tier2</code></pre>
@@ -103,9 +103,9 @@ <h2 id="test-results-and-summary">Test results and summary</h2>
103103
<p>Additional work data is stored in <code>build/$BUILD/test-support/$TEST_ID</code>. For some frameworks, this directory might contain information that is useful in determining the cause of a failed test.</p>
104104
<h2 id="test-suite-control">Test suite control</h2>
105105
<p>It is possible to control various aspects of the test suites using make control variables.</p>
106-
<p>These variables use a keyword=value approach to allow multiple values to be set. So, for instance, <code>JTREG=&quot;JOBS=1;TIMEOUT=8&quot;</code> will set the JTReg concurrency level to 1 and the timeout factor to 8. This is equivalent to setting <code>JTREG_JOBS=1 JTREG_TIMEOUT=8</code>, but using the keyword format means that the <code>JTREG</code> variable is parsed and verified for correctness, so <code>JTREG=&quot;TMIEOUT=8&quot;</code> would give an error, while <code>JTREG_TMIEOUT=8</code> would just pass unnoticed.</p>
106+
<p>These variables use a keyword=value approach to allow multiple values to be set. So, for instance, <code>JTREG=&quot;JOBS=1;TIMEOUT_FACTOR=8&quot;</code> will set the JTReg concurrency level to 1 and the timeout factor to 8. This is equivalent to setting <code>JTREG_JOBS=1 JTREG_TIMEOUT_FACTOR=8</code>, but using the keyword format means that the <code>JTREG</code> variable is parsed and verified for correctness, so <code>JTREG=&quot;TMIEOUT_FACTOR=8&quot;</code> would give an error, while <code>JTREG_TMIEOUT_FACTOR=8</code> would just pass unnoticed.</p>
107107
<p>To separate multiple keyword=value pairs, use <code>;</code> (semicolon). Since the shell normally eats <code>;</code>, the recommended usage is to write the assignment inside qoutes, e.g. <code>JTREG=&quot;...;...&quot;</code>. This will also make sure spaces are preserved, as in <code>JTREG=&quot;VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug&quot;</code>.</p>
108-
<p>(Other ways are possible, e.g. using backslash: <code>JTREG=JOBS=1\;TIMEOUT=8</code>. Also, as a special technique, the string <code>%20</code> will be replaced with space for certain options, e.g. <code>JTREG=VM_OPTIONS=-XshowSettings%20-Xlog:gc+ref=debug</code>. This can be useful if you have layers of scripts and have trouble getting proper quoting of command line arguments through.)</p>
108+
<p>(Other ways are possible, e.g. using backslash: <code>JTREG=JOBS=1\;TIMEOUT_FACTOR=8</code>. Also, as a special technique, the string <code>%20</code> will be replaced with space for certain options, e.g. <code>JTREG=VM_OPTIONS=-XshowSettings%20-Xlog:gc+ref=debug</code>. This can be useful if you have layers of scripts and have trouble getting proper quoting of command line arguments through.)</p>
109109
<p>As far as possible, the names of the keywords have been standardized between test suites.</p>
110110
<h3 id="general-keywords-test_opts">General keywords (TEST_OPTS)</h3>
111111
<p>Some keywords are valid across different test suites. If you want to run tests from multiple test suites, or just don't want to care which test suite specific control variable to use, then you can use the general TEST_OPTS control variable.</p>

doc/testing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Some example command-lines:
2323
$ make test-jdk_lang JTREG="JOBS=8"
2424
$ make test TEST=jdk_lang
2525
$ make test-only TEST="gtest:LogTagSet gtest:LogTagSetDescriptions" GTEST="REPEAT=-1"
26-
$ make test TEST="hotspot:hotspot_gc" JTREG="JOBS=1;TIMEOUT=8;VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug"
26+
$ make test TEST="hotspot:hotspot_gc" JTREG="JOBS=1;TIMEOUT_FACTOR=8;VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug"
2727
$ make test TEST="jtreg:test/hotspot:hotspot_gc test/hotspot/jtreg/native_sanity/JniVersion.java"
2828
$ make test TEST="micro:java.lang.reflect" MICRO="FORK=1;WARMUP_ITER=2"
2929
$ make exploded-test TEST=tier2
@@ -180,19 +180,19 @@ It is possible to control various aspects of the test suites using make control
180180
variables.
181181

182182
These variables use a keyword=value approach to allow multiple values to be
183-
set. So, for instance, `JTREG="JOBS=1;TIMEOUT=8"` will set the JTReg
183+
set. So, for instance, `JTREG="JOBS=1;TIMEOUT_FACTOR=8"` will set the JTReg
184184
concurrency level to 1 and the timeout factor to 8. This is equivalent to
185-
setting `JTREG_JOBS=1 JTREG_TIMEOUT=8`, but using the keyword format means that
185+
setting `JTREG_JOBS=1 JTREG_TIMEOUT_FACTOR=8`, but using the keyword format means that
186186
the `JTREG` variable is parsed and verified for correctness, so
187-
`JTREG="TMIEOUT=8"` would give an error, while `JTREG_TMIEOUT=8` would just
187+
`JTREG="TMIEOUT_FACTOR=8"` would give an error, while `JTREG_TMIEOUT_FACTOR=8` would just
188188
pass unnoticed.
189189

190190
To separate multiple keyword=value pairs, use `;` (semicolon). Since the shell
191191
normally eats `;`, the recommended usage is to write the assignment inside
192192
qoutes, e.g. `JTREG="...;..."`. This will also make sure spaces are preserved,
193193
as in `JTREG="VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug"`.
194194

195-
(Other ways are possible, e.g. using backslash: `JTREG=JOBS=1\;TIMEOUT=8`.
195+
(Other ways are possible, e.g. using backslash: `JTREG=JOBS=1\;TIMEOUT_FACTOR=8`.
196196
Also, as a special technique, the string `%20` will be replaced with space for
197197
certain options, e.g. `JTREG=VM_OPTIONS=-XshowSettings%20-Xlog:gc+ref=debug`.
198198
This can be useful if you have layers of scripts and have trouble getting

0 commit comments

Comments
 (0)