You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ar...@apache.org on 2006/07/19 08:27:24 UTC
svn commit: r423383 - in /maven/plugins/trunk/maven-resources-plugin/src:
main/java/org/apache/maven/plugin/resources/ site/ site/apt/
site/apt/examples/ site/fml/
Author: aramirez
Date: Tue Jul 18 23:27:24 2006
New Revision: 423383
URL: http://svn.apache.org/viewvc?rev=423383&view=rev
Log:
PR: MRESOURCES-23
Submitted By: Franz Allan Valencia See
Modified:
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/examples/encoding.apt
maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/filter.apt
maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/include-exclude.apt
maven/plugins/trunk/maven-resources-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-resources-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-resources-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-resources-plugin/src/site/site.xml
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=423383&r1=423382&r2=423383&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 Tue Jul 18 23:27:24 2006
@@ -42,7 +42,7 @@
import java.util.Properties;
/**
- * Copy application resources.
+ * Copy resources for the main source code to the main output directory.
*
* @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/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=423383&r1=423382&r2=423383&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 Tue Jul 18 23:27:24 2006
@@ -21,7 +21,7 @@
*/
/**
- * Copy test resources
+ * Copy resources for the test source code to the test output directory.
*
* @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/examples/encoding.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/encoding.apt?rev=423383&r1=423382&r2=423383&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/encoding.apt (original)
+++ maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/encoding.apt Tue Jul 18 23:27:24 2006
@@ -25,7 +25,7 @@
<artifactId>maven-resources-plugin</artifactId>
<configuration>
...
- <encoding>UTF-8</aggregate>
+ <encoding>UTF-8</encoding>
...
</configuration>
</plugin>
Modified: maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/filter.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/filter.apt?rev=423383&r1=423382&r2=423383&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/filter.apt (original)
+++ maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/filter.apt Tue Jul 18 23:27:24 2006
@@ -10,7 +10,7 @@
Filtering
Variables can be included in your resources. These variables, denoted by the
- ${...} delimeters, can come from the System properties, your project
+ $\{...\} delimiters, can come from the System properties, your project
properties, from your filter resources and from the command lines.
For example, if we have a resource src/main/resources/hello.txt containing
@@ -98,7 +98,7 @@
Furthermore, we are not limited to use pre-defined project variables. We can
specify our own variables and their values under the properties tag. For
example, if we want to change the variable from "name" to "your.name", we can
- sdo so by adding a "your.name" tag under the "properties" tag.
+ do so by adding a "your.name" tag under the "properties" tag.
+-----+
<project>
Modified: maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/include-exclude.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/include-exclude.apt?rev=423383&r1=423382&r2=423383&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/include-exclude.apt (original)
+++ maven/plugins/trunk/maven-resources-plugin/src/site/apt/examples/include-exclude.apt Tue Jul 18 23:27:24 2006
@@ -13,7 +13,7 @@
be used. Thus, we may have to specify only the files that we want to inlcude or
specify the files that we want to exclude.
- To include a file, we only need to add an includes tag.
+ To include a resource, we only need to add an includes tag.
+-----+
<project>
@@ -42,7 +42,7 @@
</project>
+-----+
- And to excludes a resource, we only need to add an exclude tag.
+ And to exclude a resource, we only need to add an excludes tag.
+-----+
<project>
@@ -57,10 +57,10 @@
<directory> [your directory] </directory>
<excludes>
<exclude> [non-resource file #1] </exclude>
- <exclude> [non-resource file #1] </exclude>
- <exclude> [non-resource file #1] </exclude>
+ <exclude> [non-resource file #2] </exclude>
+ <exclude> [non-resource file #3] </exclude>
[...]
- <exclude> [non-resource file #1] </exclude>
+ <exclude> [non-resource file #n] </exclude>
</excludes>
</resource>
[...]
@@ -72,8 +72,7 @@
+-----+
For example, if we want to include all text and rtf files under our
- src/my-resources directory and in all its
- subdirectory, we can do the
+ src/my-resources directory and in all its subdirectory, we can do the
following
+-----+
@@ -130,8 +129,8 @@
+-----+
Of course, we can also have both includes and exclude tags. For example, if we
- want to include all text files that
- does not contain the word "test" in their filename
+ want to include all text files that does not contain the word "test" in their
+ filename
+-----+
<project>
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=423383&r1=423382&r2=423383&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 Tue Jul 18 23:27:24 2006
@@ -9,24 +9,23 @@
Maven 2 Resources Plugin
- The Resources Plugin handles the copying or transfering of project resources to
- the output directory. Resources are categorized into two: main resources and
- test resources. The difference is that the main resources are the resources
- associated to the main code while the test resources are that of the test code.
+ The Resources Plugin handles the copying of project resources to the output
+ directory. Resources come in two: main resources and test resources. The
+ difference is that the main resources are the resources associated to the main
+ source code while the test resources are that for the test code.
- This, thus, allows the separation of resources of the main code (what your
- plugin actually does) and its unit
- tests.
+ Thus, this allows the separation of resources for the main source code and its
+ unit tests.
* Goals Overview
The Resources Plugin has two goals:
- * {{{resources-mojo.html}resources:resources}} transfers / copies the resources of
- the main source code to the main output directory.
+ * {{{resources-mojo.html}resources:resources}} copies the
+ resources for the main source code to the main output directory.
- * {{{testResources-mojo.html}resources:testResources}} transfers / copies the
- resources of the test source code to the test output directory.
+ * {{{testResources-mojo.html}resources:testResources}} copies the
+ resources for the test source code to the test output directory.
* Usage
@@ -35,7 +34,7 @@
* Examples
- The following examples show how to use the Javadoc Plugin in more advanced
+ The following examples show how to use the Resources Plugin in more advanced
usecases:
* {{{examples/encoding.html}Specifying a character encoding scheme}}
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=423383&r1=423382&r2=423383&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 Tue Jul 18 23:27:24 2006
@@ -8,25 +8,29 @@
Usage
- The Resources Plugin handles the copying or transfering of project resources to
- the output directory. The following examples
- describe the basic usage of the Plugin.
+ The Resources Plugin handles the copying of project resources to the output
+ directory. The following examples describe the basic usage of the Plugin.
-* Transfer or Copy resources of the main code
+* Copy resources for the main source code
+-----+
mvn resources:resources
+-----+
- Upon executing this command, the resources of your main code would be copied to
- the resources of your main output build. This does not affect the resources of your
- test code.
+ Upon executing this command, the resources for your main source code would be
+ copied to the resources for your main output build. This does not affect the
+ resources for your test code.
+
+ Moreover, this goal is bounded to the process-resources phase.
-* Transfer or Copy resources of the unit tests
+* Copy resources for the unit tests
+-----+
mvn resources:testResources
+-----+
- Like the first goal, this goal copies the resources of your test code to your
- test output build. Also, this does not affect the resources of the main code.
+ Like the first goal, this goal copies the resources for your test code to your
+ test output build. Also, this does not affect the resources for the main source
+ code.
+
+ Furthermore, this is bounded to the process-test-resources
Modified: maven/plugins/trunk/maven-resources-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/site/fml/faq.fml?rev=423383&r1=423382&r2=423383&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-resources-plugin/src/site/fml/faq.fml Tue Jul 18 23:27:24 2006
@@ -15,10 +15,10 @@
When should I use the resouces plugin's goal outside a lifecycle?
</question>
<answer>
- <p>The maven resource plugin simply transfers or copies resources from
- your source to your build output (with the optional filtering). So if
- that's the only operation you are interested in, you can skip the
- other phases such as compilation and testing and simply do mvn
+ <p>The maven resource plugin simply copies resources from your source to
+ your build output (with the optional filtering). So if that's the only
+ operation you are interested in, you can skip the other phases such as
+ compilation and testing and simply do mvn
resources:resources.</p>
<p>For example, if you just debugged your configuration file and you
want to manually test it in your container if it works, you can simply
@@ -43,7 +43,7 @@
What encoding values are allowed?
</question>
<answer>
- <p>The Maven Resource Plugin only allwos encoding values representing
+ <p>The Maven Resource Plugin only allows encoding values representing
the charsets supported by the Java platform, namely US-ASCII,
ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE, and UTF-16</p>
</answer>
Modified: maven/plugins/trunk/maven-resources-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-resources-plugin/src/site/site.xml?rev=423383&r1=423382&r2=423383&view=diff
==============================================================================
--- maven/plugins/trunk/maven-resources-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-resources-plugin/src/site/site.xml Tue Jul 18 23:27:24 2006
@@ -18,9 +18,9 @@
*/
-->
-<project name="Maven Resources Report">
+<project name="Maven Resources Plugin">
<bannerLeft>
- <name>Maven Resources Report</name>
+ <name>Maven Resources Plugin</name>
<src>http://maven.apache.org/images/apache-maven-project.png</src>
<href>http://maven.apache.org/</href>
</bannerLeft>