maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From denn...@apache.org
Subject svn commit: r1057406 - in /maven/plugins/trunk/maven-resources-plugin/src: main/java/org/apache/maven/plugin/resources/ site/apt/
Date Mon, 10 Jan 2011 22:43:24 GMT
Author: dennisl
Date: Mon Jan 10 22:43:23 2011
New Revision: 1057406

URL: http://svn.apache.org/viewvc?rev=1057406&view=rev
Log:
[MRESOURCES-122] Documentation improvements
Submitted by: Marshall Schor
Reviewed by: Dennis Lundberg

o Patch applied with modifications

Modified:
    maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/CopyResourcesMojo.java
    maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/ResourcesMojo.java
    maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/TestResourcesMojo.java
    maven/plugins/trunk/maven-resources-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-resources-plugin/src/site/apt/usage.apt

Modified: maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/CopyResourcesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/CopyResourcesMojo.java?rev=1057406&r1=1057405&r2=1057406&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/CopyResourcesMojo.java
(original)
+++ maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/CopyResourcesMojo.java
Mon Jan 10 22:43:23 2011
@@ -45,7 +45,8 @@ public class CopyResourcesMojo
     private File outputDirectory;
 
     /**
-     * The list of resources we want to transfer.
+     * The list of resources we want to transfer. See the Maven Model for a
+     * description of how to code the resources element.
      *
      * @parameter 
      * @required

Modified: maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/ResourcesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/ResourcesMojo.java?rev=1057406&r1=1057405&r2=1057406&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/ResourcesMojo.java
(original)
+++ maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/ResourcesMojo.java
Mon Jan 10 22:43:23 2011
@@ -46,6 +46,7 @@ import java.util.List;
 
 /**
  * Copy resources for the main source code to the main output directory.
+ * Always uses the project.build.resources element to specify the resources to copy.
  *
  * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
  * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
@@ -168,7 +169,7 @@ public class ResourcesMojo
     protected boolean includeEmptyDirs;
     
     /**
-     * Additionnal file extensions to not apply filtering (already defined are : jpg, jpeg,
gif, bmp, png)
+     * Additional file extensions to not apply filtering (already defined are : jpg, jpeg,
gif, bmp, png)
      * @parameter 
      * @since 2.3
      */

Modified: maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/TestResourcesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/TestResourcesMojo.java?rev=1057406&r1=1057405&r2=1057406&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/TestResourcesMojo.java
(original)
+++ maven/plugins/trunk/maven-resources-plugin/src/main/java/org/apache/maven/plugin/resources/TestResourcesMojo.java
Mon Jan 10 22:43:23 2011
@@ -24,6 +24,7 @@ import java.util.List;
 
 /**
  * Copy resources for the test source code to the test output directory.
+ * Always uses the project.build.testResources element to specify the resources to copy.
  *
  * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
  * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>

Modified: maven/plugins/trunk/maven-resources-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/site/apt/index.apt?rev=1057406&r1=1057405&r2=1057406&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-resources-plugin/src/site/apt/index.apt Mon Jan 10 22:43:23
2011
@@ -41,15 +41,27 @@ Maven Resources Plugin
 
 * Goals Overview
 
+   The Resources Plugin copies files specified by Resource elements, to an output directory.
 The three
+   variations below only differ in how the resource and output directory elements are specified
or defaulted.
    The Resources Plugin has three goals:
 
    * {{{./resources-mojo.html}resources:resources}} copies the
      resources for the main source code to the main output directory.
+     
+     This goal usually executes automatically, because it is bound by default to the process-resources
life-cycle phase.
+     It always uses the project.build.resources element to specify the resources, and by
default uses the 
+     project.build.outputDirectory to specify the copy destination.
 
    * {{{./testResources-mojo.html}resources:testResources}} copies the
      resources for the test source code to the test output directory.
+     
+     This goal usually executes automatically, because it is bound by default to the process-test-resources
life-cycle phase.
+     It always uses the project.build.testResources element to specify the resources, and
by default uses the 
+     project.build.testOutputDirectory to specify the copy destination.
 
    * {{{./copy-resources-mojo.html}resources:copy-resources}} copies resources to an output
directory.
+     
+     This goal requires that you configure the resources to be copied, and specify the outputDirectory.
 
 * Usage
 

Modified: maven/plugins/trunk/maven-resources-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/site/apt/usage.apt?rev=1057406&r1=1057405&r2=1057406&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-resources-plugin/src/site/apt/usage.apt Mon Jan 10 22:43:23
2011
@@ -37,7 +37,8 @@ Usage
 mvn resources:resources
 +-----+
 
- Upon executing this command, the resources for your main source code will be
+ Upon executing this command, the resources for your main source code,
+ as specified by the \<resources> element, will be
  copied to your main build output directory. This does not affect the
  resources for your test code.
 
@@ -50,7 +51,21 @@ mvn resources:testResources
 +-----+
 
  Like the first goal this goal copies resources, but this time for your test source code
to your
- test build output directory. Also, this does not affect the resources for the main source
+ test build output directory, as specified by the \<testResources> element. 
+ Also, this does not affect the resources for the main source
  code.
 
  Furthermore, this is bound to the <<<process-test-resources>>> phase.
+
+* Copy resources specified by a \<resources> configuration element
+
++-----+
+mvn resources:copy-resources
++-----+
+
+ Rather than using the \<resources> or \<testResources> elements or their
+ defaults, this uses a \<resources> element that is specified as part of the
+ configuration.
+ 
+ See the examples for how to configure this.  See the Maven Model for 
+ how to write \<resources> elements.
\ No newline at end of file



Mime
View raw message