From fda88665cfe6d8a2c5b7d696318c3e6100f83640 Mon Sep 17 00:00:00 2001
From: jjensen <jjensen@13f79535-47bb-0310-9956-ffa450edef68>
Date: Thu, 6 Dec 2007 04:16:22 +0000
Subject: [PATCH] Clarify and correct maven.test.haltafterfailure explanation.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@601604 13f79535-47bb-0310-9956-ffa450edef68
---
 test/xdocs/properties.xml | 46 +++++++++++++++++++++------------------
 1 file changed, 25 insertions(+), 21 deletions(-)
diff --git a/test/xdocs/properties.xml b/test/xdocs/properties.xml
index d80a7fdc..86684696 100644
--- a/test/xdocs/properties.xml
+++ b/test/xdocs/properties.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!-- 
+<!--
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -7,9 +7,9 @@
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -20,7 +20,7 @@
 <document>
   <properties>
     <title>Test Properties</title>
-    <author email="smor@apache.org">Stéphane MOR</author>  
+    <author email="smor@apache.org">Stéphane MOR</author>
   </properties>
   <body>
     <section name="Test Settings">
@@ -35,7 +35,7 @@
           <td>Yes</td>
           <td>
             The directory to invoke the VM in. (ignored if fork is disabled).
-	    The default value is <code>${basedir}</code>.
+        The default value is <code>${basedir}</code>.
           </td>
         </tr>
         <tr>
@@ -44,7 +44,7 @@
           <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. 
+            Each variable is describe in sub properties.
             Sample :
             <source><![CDATA[
 maven.junit.envvars=LD_LIBRARY_PATH
@@ -86,7 +86,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
           <td>
             NOTE: Ignored in maven &lt; 1.1.
             Controls how many Java Virtual Machines get created if you want
-            to fork some tests. Possible values are "perTest" (the default), 
+            to fork some tests. Possible values are "perTest" (the default),
             and "once". "once" creates only a single Java VM for
             all tests while "perTest" creates a new VM for each TestCase class.
             Note that only tests with the same settings of
@@ -110,7 +110,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
           <td>maven.junit.printSummary</td>
           <td>Yes</td>
           <td>
-            If this value is set to false, JUnit test run details will not 
+            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.
@@ -147,7 +147,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
           <td>maven.test.compile.encoding</td>
           <td>Yes</td>
           <td>
-            Specifies source encoding to be used for tests compilation. 
+            Specifies source encoding to be used for tests compilation.
             Defaults to ${maven.compile.encoding}.
           </td>
         </tr>
@@ -158,15 +158,15 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
             Names the program to be invoked as the java compiler for test classes.
             Defaults to ${maven.compile.executable}.
           </td>
-        </tr>       
+        </tr>
         <tr>
           <td>maven.test.compile.fork</td>
           <td>Yes</td>
           <td>
-            Runs the test classes compiler in a separate process.              
+            Runs the test classes compiler in a separate process.
             Defaults to ${maven.compile.fork}.
           </td>
-        </tr>          
+        </tr>
         <tr>
           <td>maven.test.compile.source</td>
           <td>Yes</td>
@@ -174,7 +174,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
             Specifies the source version for the Java compiler for test classes.
             Defaults to ${maven.compile.source}.
           </td>
-        </tr>           
+        </tr>
         <tr>
           <td>maven.test.compile.target</td>
           <td>Yes</td>
@@ -182,7 +182,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
             Generate class files for test classes for a specific JVM version.
             Defaults to ${maven.compile.target}.
           </td>
-        </tr>          
+        </tr>
         <tr>
           <td>maven.test.compile.verbose</td>
           <td>Yes</td>
@@ -190,7 +190,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
             Asks the compiler for verbose output.
             Defaults to ${maven.compile.verbose}.
           </td>
-        </tr>               
+        </tr>
         <tr>
           <td>maven.test.classpath</td>
           <td>Yes</td>
@@ -214,7 +214,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
           <td>
             Specifies the unit test classes directory.  This is the
             location where the java classes for the test source
-            code will be generated to.  The default value is 
+            code will be generated to.  The default value is
             <code>${maven.build.dir}/test-classes</code>.
           </td>
         </tr>
@@ -248,8 +248,12 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
           <td>Yes</td>
           <td>
             Set this to <code>true</code> to halt the build on any test failures
-            (note: errors are considered failures as well), but <strong>after</strong>
-            all tests have been run. Default value is <code>false</code>.
+            <strong>after</strong> all tests have run.
+            maven.test.haltafterfailure is only obeyed if
+            maven.test.failure.ignore=true, so you have to use them together.
+            To also halt the build on any test errors after
+            all tests have run, set maven.test.error.ignore=true too.
+            Default value is <code>false</code>.
           </td>
         </tr>
         <tr>
@@ -277,7 +281,7 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
               Provide source compatibility with a specific release
             </p>
             <p>
-              Corresponds to the <code>source</code> attribute for the ant 
+              Corresponds to the <code>source</code> attribute for the ant
               <a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
               task.
             </p>
@@ -289,9 +293,9 @@ maven.junit.jvmargs=-Xmx160m -verbose]]></source>
           <td>
             Use this property elements to specify system properties required
             by the class. These properties will be made available to the VM during
-            the execution of the test (either Maven's VM or the forked VM, if fork is enabled). 
+            the execution of the test (either Maven's VM or the forked VM, if fork is enabled).
             You can specify system properties separate by space.
-            Each properties is describe in sub properties. 
+            Each properties is describe in sub properties.
             Sample :
             <source><![CDATA[
 maven.junit.sysproperties=prop1 basedir
