Author: bentmann
Date: Sat Sep 6 12:56:17 2008
New Revision: 692719
URL: http://svn.apache.org/viewvc?rev=692719&view=rev
Log:
o Polished docs
Modified:
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/ignoring-errors.apt
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/skipping-clean.apt
maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt
Modified:
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt?rev=692719&r1=692718&r2=692719&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt
(original)
+++
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt
Sat Sep 6 12:56:17 2008
@@ -29,7 +29,7 @@
Delete Additional Files Not Exposed to Maven
- The <<<maven-clean-plugin>>> will delete the <<<target>>> directory by
default. You may configure
+ The Maven Clean Plugin will delete the <<<target>>> directory by default.
You may configure
it to delete additional directories and files. The following example shows
how:
+--------
@@ -37,6 +37,7 @@
[...]
<plugin>
<artifactId>maven-clean-plugin</artifactId>
+ <version>2.2</version>
<configuration>
<filesets>
<fileset>
Modified:
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/ignoring-errors.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/ignoring-errors.apt?rev=692719&r1=692718&r2=692719&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/ignoring-errors.apt
(original)
+++
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/ignoring-errors.apt
Sat Sep 6 12:56:17 2008
@@ -28,13 +28,14 @@
Ignoring Clean Errors
- To ignore errors when running the cleanup for a particular project, set the
<<<failOnError>>> property to false.
+ To ignore errors when running the cleanup for a particular project, set the
<<<failOnError>>> property to <<<false>>>.
+--------
<build>
[...]
<plugin>
<artifactId>maven-clean-plugin</artifactId>
+ <version>2.2</version>
<configuration>
<failOnError>false</failOnError>
</configuration>
Modified:
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/skipping-clean.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/skipping-clean.apt?rev=692719&r1=692718&r2=692719&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/skipping-clean.apt
(original)
+++
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/skipping-clean.apt
Sat Sep 6 12:56:17 2008
@@ -28,13 +28,14 @@
Skipping Clean
- To skip running the cleanup for a particular project, set the <<<skip>>>
property to true.
+ To skip running the cleanup for a particular project, set the <<<skip>>>
property to <<<true>>>.
+--------
<build>
[...]
<plugin>
<artifactId>maven-clean-plugin</artifactId>
+ <version>2.2</version>
<configuration>
<skip>true</skip>
</configuration>
Modified: maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt?rev=692719&r1=692718&r2=692719&view=diff
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt Sat Sep 6
12:56:17 2008
@@ -25,27 +25,27 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Introduction
+Usage
The Maven Clean Plugin, as the name implies, attempts to clean the files and
- directories generated by maven during its build. While there are plugins
- that generate additional files, the clean plugin assumes that these files are
+ directories generated by Maven during its build. While there are plugins
+ that generate additional files, the Clean Plugin assumes that these files are
generated inside the <<<target>>> directory.
-* Cleaning a maven project using the command-line
+* Cleaning a Maven project using the command-line
- The clean plugin can be called to execute in the command-line without any
- additional configurations. Like the other plugins, to run the clean plugin,
+ The Clean Plugin can be called to execute in the command-line without any
+ additional configurations. Like the other plugins, to run the Clean Plugin,
you use:
+-----
mvn clean:clean
+-----
- where the first <<clean>> refers to the plugin's alias, and the second
- <<<clean>>> refers to a plugin goal, which is clean.
+ where the first <<<clean>>> refers to the plugin's alias, and the second
+ <<<clean>>> refers to the plugin goal.
- However, the clean plugin is a special plugin and is bound to its own special
+ However, the Clean Plugin is a special plugin and is bound to its own special
lifecycyle phase called <<<clean>>>. Thus, for simplicity, it can also be
executed by using:
@@ -59,12 +59,12 @@
mvn clean package site
+-----
-* Running the clean plugin automatically during a build
+* Running the Clean Plugin automatically during a build
- When for some reason, adding <<<clean>>> to the command-line is not option,
- the clean plugin can be put into a project's pom.xml so that it gets executed
- everytime the project is built. Below is a sample pom.xml for running the
- clean plugin in the <<<validate>>> phase everytime the project is built:
+ If for some reason, adding <<<clean>>> to the command-line is not option,
+ the Clean Plugin can be put into a project's <<<pom.xml>>> so that it gets
executed
+ everytime the project is built. Below is a sample <<<pom.xml>>> for running
the
+ Clean Plugin in the <<<initialize>>> phase everytime the project is built:
+-----
<project>
@@ -73,10 +73,11 @@
<plugins>
<plugin>
<artifactId>maven-clean-plugin</artifactId>
+ <version>2.2</version>
<executions>
<execution>
<id>auto-clean</id>
- <phase>validate</phase>
+ <phase>initialize</phase>
<goals>
<goal>clean</goal>
</goals>
@@ -87,4 +88,4 @@
</build>
[...]
</project>
-+-----
\ No newline at end of file
++-----
