You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by be...@apache.org on 2009/02/24 11:52:19 UTC
svn commit: r747333 - in /maven/plugins/trunk/maven-invoker-plugin/src:
main/java/org/apache/maven/plugin/invoker/InvokerReport.java
site/apt/examples/access-test-classes.apt.vm
site/apt/examples/post-build-script.apt.vm site/apt/usage.apt.vm
Author: bentmann
Date: Tue Feb 24 10:52:19 2009
New Revision: 747333
URL: http://svn.apache.org/viewvc?rev=747333&view=rev
Log:
o Tweaked documentation
Modified:
maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerReport.java
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/access-test-classes.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm
Modified: maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerReport.java?rev=747333&r1=747332&r2=747333&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerReport.java (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/InvokerReport.java Tue Feb 24 10:52:19 2009
@@ -42,9 +42,10 @@
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
- * Generate a report based on the results of it tests.
- * <b>This mojo doesn't fork any lifecycle, if you have a clean working copy,
- * you have to use a cli like : mvn clean integration-test site<b>
+ * Generate a report based on the results of the Maven invocations. <strong>Note:</strong> This mojo doesn't fork any
+ * lifecycle, if you have a clean working copy, you have to use a command like
+ * <code>mvn clean integration-test site</code> to ensure the build results are present when this goal is invoked.
+ *
* @goal report
* @author <a href="mailto:olamy@apache.org">olamy</a>
* @since 1.4
@@ -87,7 +88,7 @@
protected File outputDirectory;
/**
- * Base directory where all build reports are written to.
+ * Base directory where all build reports have been written to.
*
* @parameter expression="${invoker.reportsDirectory}" default-value="${project.build.directory}/invoker-reports"
*/
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/access-test-classes.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/access-test-classes.apt.vm?rev=747333&r1=747332&r2=747333&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/access-test-classes.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/access-test-classes.apt.vm Tue Feb 24 10:52:19 2009
@@ -58,7 +58,7 @@
Setting <<<addTestClassPath>>> to <<<true>>> will prepend the directories <<<$\{project.build.testOutputDirectory\}>>>,
<<<$\{project.build.outputDirectory\}>>> and all dependencies of your project to the class path of the script
interpreter. Among others, this allows you to create some utility classes in your test source tree and use this code
- for the integration tests.
+ for the hook scripts.
<Note:> Of course, this requires your test classes to be compiled before running the integration tests but this is
usually the case if you employ the Invoker Plugin during the lifecycle phase <<<integration-test>>>.
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm?rev=747333&r1=747332&r2=747333&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm Tue Feb 24 10:52:19 2009
@@ -42,13 +42,7 @@
<configuration>
<debug>true</debug>
<projectsDirectory>src/it</projectsDirectory>
- <pomIncludes>
- <pomInclude>**/pom.xml</pomInclude>
- </pomIncludes>
- <pomExcludes>
- <pomExclude>**/child*/pom.xml</pomExclude>
- <pomExclude>**/module*/pom.xml</pomExclude>
- </pomExcludes>
+ <preBuildHookScript>setup.bsh</preBuildHookScript>
<postBuildHookScript>verify.bsh</postBuildHookScript>
</configuration>
<executions>
@@ -65,7 +59,7 @@
</project>
-------------------
- Here is an example post-build BeanShell script (<<<verify.bsh>>>) that checks for the existence of a JAR file after
+ Below is an example post-build BeanShell script (<<<verify.bsh>>>) that checks for the existence of a JAR file after
the build has run. If the JAR file does not exist, the script throws an exception which causes the Invoker Plugin to
log that the build failed. More precisely, any return value which does not equal <<<true>>> will be interpreted as a
failure condition. And of course, if the script exists abnormally due to an exception, the plugin will flag the
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm?rev=747333&r1=747332&r2=747333&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm Tue Feb 24 10:52:19 2009
@@ -70,12 +70,12 @@
<version>${project.version}</version>
<configuration>
<projectsDirectory>src/it</projectsDirectory>
- <cloneProjectsTo>target/it</cloneProjectsTo>
+ <cloneProjectsTo>\${project.build.directory}/it</cloneProjectsTo>
<pomIncludes>
<pomInclude>*/pom.xml</pomInclude>
</pomIncludes>
<settingsFile>src/it/settings.xml</settingsFile>
- <localRepositoryPath>target/local-repo</localRepositoryPath>
+ <localRepositoryPath>\${project.build.directory}/local-repo</localRepositoryPath>
<postBuildHookScript>verify.bsh</postBuildHookScript>
</configuration>
<executions>