You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ep...@apache.org on 2006/07/05 08:29:45 UTC

svn commit: r419175 - in /maven/plugins/trunk/maven-clean-plugin/src/site: apt/examples.apt apt/examples/ apt/examples/delete_additional_files.apt apt/index.apt site.xml

Author: epunzalan
Date: Tue Jul  4 23:29:45 2006
New Revision: 419175

URL: http://svn.apache.org/viewvc?rev=419175&view=rev
Log:
PR: MCLEAN-14

- created index.apt to replace the generated index.html
- created a menu for examples in the left navigation bar

Added:
    maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/
    maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt
    maven/plugins/trunk/maven-clean-plugin/src/site/apt/index.apt
Removed:
    maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples.apt
Modified:
    maven/plugins/trunk/maven-clean-plugin/src/site/site.xml

Added: 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=419175&view=auto
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt (added)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/apt/examples/delete_additional_files.apt Tue Jul  4 23:29:45 2006
@@ -0,0 +1,38 @@
+ ------
+ Maven 2 Clean Plugin: Examples
+ ------
+ Mike Perham
+ <mp...@apache.org>
+ ------
+ June 20th, 2006
+
+Delete Additional Files Not Exposed to Maven
+
+  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/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clean-plugin/src/site/apt/index.apt?rev=419175&view=auto
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/apt/index.apt (added)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/apt/index.apt Tue Jul  4 23:29:45 2006
@@ -0,0 +1,37 @@
+ ------
+ Maven Clean Plugin
+ ------
+ Edwin Punzalan
+ ------
+ 03 July 2006
+ ------
+
+
+Overview
+
+  The Clean Plugin is used when you want to remove files generated at
+  build-time in a project's directory.
+
+* Goals Overview
+
+  The Clean Plugin only has one goal.
+
+  * {{{clean-mojo.html}clean:clean}} attempts to clean a project's working
+  directory of the files that we're generated at build-time.  By default, it
+  discovers and deletes the directories configured in
+  <<<project.build.directory>>>, <<<project.build.outputDirectory>>>,
+  <<<project.build.testOutputDirectory>>>, and
+  <<<project.reporting.outputDirectory>>>.
+
+* Usage
+
+  Instructions on the basic usage of the Clean Plugin can be found
+  {{{usage.html}here}}.
+
+* Examples
+
+  To provide you with better understanding on some usages of the Clean Plugin,
+  you can take a look into the following examples:
+
+  * {{{delete_additional_files.html}How to delete additional files outside of
+  the default directories}}
\ 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=419175&r1=419174&r2=419175&view=diff
==============================================================================
--- maven/plugins/trunk/maven-clean-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-clean-plugin/src/site/site.xml Tue Jul  4 23:29:45 2006
@@ -21,6 +21,10 @@
       <item name="FAQ" href="faq.html"/>
     </menu>
 
+    <menu name="Examples">
+      <item name="Delete Additional File" href="examples/delete_additional_files.html"/>
+    </menu>
+
     ${reports}
 
   </body>