Author: epunzalan
Date: Fri Jun 30 03:48:13 2006
New Revision: 418229
URL: http://svn.apache.org/viewvc?rev=418229&view=rev
Log:
PR: MCLEAN-13
Improved the docs and implemented docck rules
Added:
maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples.apt
- copied, changed from r417921,
maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt
maven/plugins/trunk/maven-clean-plugin/src/site/apt/faq.apt
maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt
Removed:
maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt
Modified:
maven/plugins/trunk/maven-clean-plugin/pom.xml
maven/plugins/trunk/maven-clean-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-clean-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/pom.xml?rev=418229&r1=418228&r2=418229&view=diff
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-clean-plugin/pom.xml Fri Jun 30 03:48:13 2006
@@ -12,6 +12,9 @@
<name>Maven Clean Plugin</name>
<version>2.1.1-SNAPSHOT</version>
<inceptionYear>2001</inceptionYear>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
@@ -40,4 +43,20 @@
<name>Jesse McConnell</name>
</contributor>
</contributors>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </reporting>
</project>
Copied: maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples.apt (from
r417921, 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/examples.apt?p2=maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples.apt&p1=maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt&r1=417921&r2=418229&rev=418229&view=diff
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/apt/howto.apt (original)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples.apt Fri Jun 30
03:48:13 2006
@@ -1,12 +1,12 @@
------
- Maven 2 Clean Plugin: Usage
+ Maven 2 Clean Plugin: Examples
------
Mike Perham
<[EMAIL PROTECTED]>
------
June 20th, 2006
-Usage
+Configuration
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:
@@ -27,6 +27,8 @@
</build>
[...]
+---------
+
+Example
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:
Added: maven/plugins/trunk/maven-clean-plugin/src/site/apt/faq.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/apt/faq.apt?rev=418229&view=auto
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/apt/faq.apt (added)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/apt/faq.apt Fri Jun 30
03:48:13 2006
@@ -0,0 +1,24 @@
+ ------
+ Maven 2 Clean Plugin: FAQ
+ ------
+ Edwin Punzalan
+ ------
+ June 29th, 2006
+
+
+Frequently Asked Questions
+
+ [[1]] {{{#1.} I already ran <<<mvn clean>>> but the directory (<<<put dir
+ name here>>>) is still there. What should I do?}}
+
+* Answers
+
+ {1.} I already ran <<<mvn clean>>> but the directory (<<<put dir name
+ here>>>) is still there. What should I do?
+
+ Some files-generating plugins can generate their files outside of the
+ default directories being deleted by the clean plugin. You should add
+ the location of such files in the clean plugin configuration or change
+ the configuration of those plugins to put their files inside the
+ <<<project.build.directory>>> which is by default, the <<<target>>>
+ directory.
Added: 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=418229&view=auto
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt (added)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/apt/usage.apt Fri Jun 30
03:48:13 2006
@@ -0,0 +1,71 @@
+ ------
+ Maven 2 Clean Plugin: Usage
+ ------
+ Edwin Punzalan
+ ------
+ June 29th, 2006
+
+
+Introduction
+
+ 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
+ generated inside the <<<target>>> directory.
+
+* 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,
+ 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.
+
+ 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:
+
++-----
+ mvn clean
++-----
+
+ or with other phases/goals like:
+
++-----
+ mvn clean package site
++-----
+
+* 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:
+
++-----
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-clean-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>auto-clean</id>
+ <phase>validate</phase>
+ <goals>
+ <goal>clean</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++-----
\ No newline at end of file
Modified: 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=418229&r1=418228&r2=418229&view=diff
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/site.xml Fri Jun 30
03:48:13 2006
@@ -16,7 +16,9 @@
</links>
<menu name="Overview">
- <item name="How to Use" href="howto.html"/>
+ <item name="How to Use" href="usage.html"/>
+ <item name="Examples" href="examples.html"/>
+ <item name="FAQ" href="faq.html"/>
</menu>
${reports}
