reorder properties alphabetically

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@392289 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier 2006-04-07 13:40:26 +00:00
parent e3c03cd5c8
commit 27a481a98f

View File

@ -16,18 +16,60 @@
* limitations under the License.
*/
-->
<document>
<properties>
<title>Test Properties</title>
<author email="smor@apache.org">Stéphane MOR</author>
</properties>
<body>
<section name="Test Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.junit.dir</td>
<td>Yes</td>
<td>
The directory to invoke the VM in. (ignored if fork is disabled).
The default value is <code>${basedir}</code>.
</td>
</tr>
<tr>
<td>maven.junit.envvars</td>
<td>Yes</td>
<td>
If fork is enabled, additional environment variables may be passed to the new VM.
You can specify some variable separated by a space.
Each variable is describe in sub properties.
Sample :
<source><![CDATA[
maven.junit.envvars=LD_LIBRARY_PATH
LD_LIBRARY_PATH=/usr/local/lib]]></source>
</td>
</tr>
<tr>
<td>maven.junit.jvm</td>
<td>Yes</td>
<td>
If this property is set it is used as the JVM for the junit tests
to run in. This is passed to the Ant junit task in the jvm property.
If maven.junit.fork is not true, this is ignored.
</td>
</tr>
<tr>
<td>maven.junit.jvmargs</td>
<td>Yes</td>
<td>
If fork is enabled, additional parameters may be passed to the new VM.
You can specify some args separated by a space.
Sample :
<source><![CDATA[
maven.junit.jvmargs=-Xmx160m -verbose]]></source>
</td>
</tr>
<tr>
<td>maven.junit.fork</td>
<td>Yes</td>
@ -63,11 +105,21 @@
</td>
</tr>
<tr>
<td>maven.junit.dir</td>
<td>maven.junit.printSummary</td>
<td>Yes</td>
<td>
The directory to invoke the VM in. (ignored if fork is disabled).
The default value is <code>${basedir}</code>.
If this value is set to false, JUnit test run details will not
include test summary information for a suite. Default value is
<code>true</code>. This parameter corresponds to the JUnit Ant
task <code>printSummary</code> attribute.
</td>
</tr>
<tr>
<td>maven.junit.timeout</td>
<td>Yes</td>
<td>
Cancel the individual tests if they don't finish in the given time
(measured in milliseconds). Ignored if fork is disabled.
</td>
</tr>
<tr>
@ -81,30 +133,20 @@
</td>
</tr>
<tr>
<td>maven.junit.printSummary</td>
<td>maven.test.classpath</td>
<td>Yes</td>
<td>
If this value is set to false, JUnit test run details will not
include test summary information for a suite. Default value is
<code>true</code>. This parameter corresponds to the JUnit Ant
task <code>printSummary</code> attribute.
Specifies one or more locations that will be added to
the classpath when the tests are run. Multiple values
can be used; the rules of the ant &lt;pathelement path=&quot;...&quot;&gt;
directive apply.
</td>
</tr>
<tr>
<td>maven.junit.jvm</td>
<td>maven.test.compile.src.set</td>
<td>Yes</td>
<td>
If this property is set it is used as the JVM for the junit tests
to run in. This is passed to the Ant junit task in the jvm property.
If maven.junit.fork is not true, this is ignored.
</td>
</tr>
<tr>
<td>maven.junit.timeout</td>
<td>Yes</td>
<td>
Cancel the individual tests if they don't finish in the given time
(measured in milliseconds). Ignored if fork is disabled.
The source directories Maven uses to compile test code.
</td>
</tr>
<tr>
@ -118,12 +160,20 @@
</td>
</tr>
<tr>
<td>maven.test.skip</td>
<td>maven.test.error.ignore</td>
<td>Yes</td>
<td>
Set this to 'true' to bypass unit tests entirely. Its use
is <b>NOT RECOMMENDED</b>, but quite convenient on occasion.
Ignored by <code>test:single</code>.
Set this to <code>true</code> to ignore errors during testing.
Its use is <b>NOT RECOMMENDED</b>, but quite convenient on occasion.
</td>
</tr>
<tr>
<td>maven.test.excludeXmlApis</td>
<td>Yes</td>
<td>
If set to yes, the XML APIs will not be added to the list of libraries used for your test cases
when forked. This should be used when you provide your own XML APIs library. By default, it is
<code>no</code>.
</td>
</tr>
<tr>
@ -136,11 +186,20 @@
</td>
</tr>
<tr>
<td>maven.test.error.ignore</td>
<td>maven.test.reportsDirectory</td>
<td>Yes</td>
<td>
Set this to <code>true</code> to ignore errors during testing.
Its use is <b>NOT RECOMMENDED</b>, but quite convenient on occasion.
Directory to write the reports to.
Defaults to <code>${maven.build.dir}/test-reports</code>.
</td>
</tr>
<tr>
<td>maven.test.skip</td>
<td>Yes</td>
<td>
Set this to 'true' to bypass unit tests entirely. Its use
is <b>NOT RECOMMENDED</b>, but quite convenient on occasion.
Ignored by <code>test:single</code>.
</td>
</tr>
<tr>
@ -157,55 +216,6 @@
</p>
</td>
</tr>
<tr>
<td>maven.test.compile.src.set</td>
<td>Yes</td>
<td>
The source directories Maven uses to compile test code.
</td>
</tr>
<tr>
<td>maven.test.reportsDirectory</td>
<td>Yes</td>
<td>
Directory to write the reports to.
Defaults to <code>${maven.build.dir}/test-reports</code>.
</td>
</tr>
<tr>
<td>maven.test.classpath</td>
<td>Yes</td>
<td>
Specifies one or more locations that will be added to
the classpath when the tests are run. Multiple values
can be used; the rules of the ant &lt;pathelement path=&quot;...&quot;&gt;
directive apply.
</td>
</tr>
<tr>
<td>maven.junit.jvmargs</td>
<td>Yes</td>
<td>
If fork is enabled, additional parameters may be passed to the new VM.
You can specify some args separated by a space.
Sample :
<source><![CDATA[
maven.junit.jvmargs=-Xmx160m -verbose]]></source>
</td>
</tr>
<tr>
<td>maven.junit.envvars</td>
<td>Yes</td>
<td>
If fork is enabled, additional environment variables may be passed to the new VM.
You can specify some variable separated by a space.
Each variable is describe in sub properties.
Sample :
<source><![CDATA[
maven.junit.envvars=LD_LIBRARY_PATH
LD_LIBRARY_PATH=/usr/local/lib]]></source>
</td>
</tr>
<tr>
<td>maven.junit.sysproperties</td>
<td>Yes</td>
@ -222,7 +232,7 @@ prop1=your value
basedir=${basedir}]]></source>
</td>
</tr>
<tr>
<tr>
<td>maven.test.search.classdir</td>
<td>Yes</td>
<td>
@ -237,17 +247,7 @@ basedir=${basedir}]]></source>
<source><![CDATA[maven.test.search.classdir=true]]></source>
</td>
</tr>
<tr>
<td>maven.test.excludeXmlApis</td>
<td>Yes</td>
<td>
If set to yes, the XML APIs will not be added to the list of libraries used for your test cases
when forked. This should be used when you provide your own XML APIs library. By default, it is
<code>no</code>.
</td>
</tr>
<tr>
<tr>
<td>testmatchpattern</td>
<td>Yes (required in test:match)</td>
<td>
@ -255,7 +255,7 @@ basedir=${basedir}]]></source>
tests that should run
</td>
</tr>
<tr>
<tr>
<td>testnotmatchpattern</td>
<td>Yes</td>
<td>
@ -263,7 +263,6 @@ basedir=${basedir}]]></source>
tests that shouldn't run
</td>
</tr>
</table>
</section>
</body>