Author: mperham
Date: Fri Jun 23 11:59:59 2006
New Revision: 416795
URL: http://svn.apache.org/viewvc?rev=416795&view=rev
Log:
PR: MCLEAN-12
Add site documentation
Added:
maven/plugins/trunk/maven-clean-plugin/src/site/
maven/plugins/trunk/maven-clean-plugin/src/site/apt/
maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt
maven/plugins/trunk/maven-clean-plugin/src/site/site.xml (with props)
Added: maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt?rev=416795&view=auto
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt (added)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt Fri Jun 23
11:59:59 2006
@@ -0,0 +1,58 @@
+ ------
+ Maven 2 Clean Plugin: Usage
+ ------
+ Mike Perham
+ <[EMAIL PROTECTED]>
+ ------
+ June 20th, 2006
+
+Usage
+
+ Cleans the local filesystem of any Maven-specific artifacts within this
module. To
+ configure the clean plugin, add it in your <<<pom.xml>>> under the
<<<build>>> section:
+
++--------
+<project>
+ [...]
+ <build>
+ <plugins>
+ [...]
+ <plugin>
+ <artifactId>maven-clean-plugin</artifactId>
+ <configuration>
+ [...]
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+[...]
++---------
+
+ 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:
+
++--------
+<build>
+ [...]
+ <plugin>
+ <artifactId>maven-clean-plugin</artifactId>
+ <configuration>
+ <filesets>
+ <fileset>
+ <directory>some/relative/path</directory>
+ <includes>
+ <include>**/*.tmp</include>
+ <include>**/*.log</include>
+ </includes>
+ <excludes>
+ <exclude>**/important.log</exclude>
+ <exclude>**/another-important.log</exclude>
+ </excludes>
+ <followSymlinks>false</followSymlinks>
+ </fileset>
+ </filesets>
+ </configuration>
+ </plugin>
+ [...]
+</build>
++---------
Added: maven/plugins/trunk/maven-clean-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/site.xml?rev=416795&view=auto
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/site.xml (added)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/site.xml Fri Jun 23
11:59:59 2006
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<project name="Maven Clean Plugin">
+ <bannerLeft>
+ <name>Maven Clean Plugin</name>
+ <src>http://maven.apache.org/images/apache-maven-project.png</src>
+ <href>http://maven.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight>
+ <publishDate format="dd MMM yyyy" />
+ <body>
+ <links>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+ </links>
+
+ <menu name="Overview">
+ <item name="How to Use" href="howto.html"/>
+ </menu>
+
+ ${reports}
+
+ </body>
+</project>
Propchange: maven/plugins/trunk/maven-clean-plugin/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native
