svn commit: r685597 - in /maven/plugins/trunk/maven-invoker-plugin/src: main/java/org/apache/maven/plugin/invoker/InvokerMojo.java site/apt/advance-usage.apt

[be...@apache.org]

Author: bentmann
Date: Wed Aug 13 09:11:18 2008
New Revision: 685597

URL: http://svn.apache.org/viewvc?rev=685597&view=rev
Log:
o Polished documentation

Modified:
    maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerMojo.java
    maven/plugins/trunk/maven-invoker-plugin/src/site/apt/advance-usage.apt

Modified: maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerMojo.java?rev=685597&r1=685596&r2=685597&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerMojo.java (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerMojo.java Wed Aug 13 09:11:18 2008
@@ -186,8 +186,8 @@
      * The name of the project-specific file that contains the enumeration of goals to execute for that test.
      * 
      * @parameter expression="${invoker.goalsFile}" default-value="goals.txt"
-     * @deprecated As of version 1.2 the properties file specified by the parameter invokerPropertiesFile should be used
-     *             instead.
+     * @deprecated As of version 1.2, the key {@code invoker.goals} from the properties file specified by the parameter
+     *             {@link #invokerPropertiesFile} should be used instead.
      */
     private String goalsFile;
 
@@ -227,9 +227,9 @@
 
     /**
      * Common set of test properties to pass in on each IT's command line, via -D parameters.
-     *
+     * 
      * @parameter
-     * @deprecated Use properties parameter instead.
+     * @deprecated As of version 1.1, use the {@link #properties} parameter instead.
      */
     private Properties testProperties;
 
@@ -315,8 +315,8 @@
      * 
      * @parameter expression="${invoker.profilesFile}" default-value="profiles.txt"
      * @since 1.1
-     * @deprecated As of version 1.2 the properties file specified by the parameter invokerPropertiesFile should be used
-     *             instead.
+     * @deprecated As of version 1.2, the key {@code invoker.profiles} from the properties file specified by the
+     *             parameter {@link #invokerPropertiesFile} should be used instead.
      */
     private String profilesFile;
 

Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/advance-usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/advance-usage.apt?rev=685597&r1=685596&r2=685597&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/advance-usage.apt (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/advance-usage.apt Wed Aug 13 09:11:18 2008
@@ -28,23 +28,25 @@
 
 Advanced Usage
 
-* Goals File Interpolation
+* Goals File Filtering
 
-  The goals files can be interpolated with some values:
+  The goals files will be filtered such that tokens of the form <<<$\{expression}>>> are replaced with some values:
   
-  * Values from the project POM (you must use <<<$\{pom.groupId}>>> notation in your goals file)
+  * Values from the project POM like <<<project.version>>>
   
-  * In the plugin configuration you can add some properties in an <<<\<interpolationsProperties\>>>> element
+  * In the plugin configuration you can add some properties in the <<<\<filterProperties\>>>> element
+  
+  * Values from the <<<\<properties\>>>> section of your project POM
 
-* IT POM Interpolation 
+* IT POM Filtering
 
-  IT POMs can be interpolated with some values:
+  IT POMs will be filtered such that tokens of the form <<<@expression@>>> are replaced with some values:
     
-  * Values from the project POM (you must use <<<@pom.groupId@>>> notation in your POM file)
+  * Values from the project POM like <<<project.version>>>
   
-  * In the plugin configuration you can add some properties in an <<<\<interpolationsProperties\>>>> element
+  * In the plugin configuration you can add some properties in the <<<\<filterProperties\>>>> element
   
-  * Properties from <<<pom.properties>>>
+  * Values from the <<<\<properties\>>>> section of your project POM
 
 * Running Only Some Tests