Author: brianf
Date: Tue Mar 13 20:26:03 2007
New Revision: 517985
URL: http://svn.apache.org/viewvc?view=rev&rev=517985
Log:
merging site updates to trunk because they apply to 2.0-alpha-2
Modified:
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/copying-artifacts.apt
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/unpacking-artifacts.apt
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml
Modified:
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/copying-artifacts.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/copying-artifacts.apt?view=diff&rev=517985&r1=517984&r2=517985
==============================================================================
---
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/copying-artifacts.apt
(original)
+++
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/copying-artifacts.apt
Tue Mar 13 20:26:03 2007
@@ -21,7 +21,7 @@
Allan Ramirez
Brian Fox
------
- Nov 2006
+ Mar 2007
------
Copying Specific Artifacts
@@ -71,7 +71,7 @@
+---+
Then after executing <<<mvn package>>> the artifact (junit) is copied to
the
- givin alternateLocation.
+ given alternateLocation.
The <<<dependency:copy>>> goal can also be used to copy the just built
artifact to a custom location if desired. It must be bound after the
@@ -113,3 +113,41 @@
</project>
+---+
+{Copying From the Command Line}:
+
+ If you intend to configure this mojo for execution on the command line
using:
+
++---+
+mvn dependency:copy
++---+
+
+ you must not put the configuration inside the <executions> tag. Your
configuration should look like this:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>[ groupId ]</groupId>
+ <artifactId>[ artifactId ]</artifactId>
+ <version>[ version ]</version>
+ <type>[ packaging ]</type>
+ <overWrite>[ true or false ]</overWrite>
+ <outputDirectory>[ output directory ]</outputDirectory>
+ <destFileName>[ filename ]</destFileName>
+ </artifactItem>
+ </artifactItems>
+ <!-- other configurations here -->
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
Modified:
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/unpacking-artifacts.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/unpacking-artifacts.apt?view=diff&rev=517985&r1=517984&r2=517985
==============================================================================
---
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/unpacking-artifacts.apt
(original)
+++
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/unpacking-artifacts.apt
Tue Mar 13 20:26:03 2007
@@ -74,6 +74,44 @@
And after invoking <<<mvn package>>>, the artifacts are unpacked. Because
checking the existence of an unpacked archive
is difficult to do reliably, marker files are used instead. The location of
the marker files is controlled by the
{{{unpack-dependencies-mojo.html#markersDirectory}markersDirectory}} parameter.
+{Unpacking From the Command Line}:
+
+ If you intend to configure this mojo for execution on the command line using:
+
++---+
+mvn dependency:unpack
++---+
+
+ you must not put the configuration inside the <executions> tag. Your
configuration should look like this:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>[ groupId ]</groupId>
+ <artifactId>[ artifactId ]</artifactId>
+ <version>[ version ]</version>
+ <type>[ packaging ]</type>
+ <overWrite>[ true or false ]</overWrite>
+ <outputDirectory>[ output directory ]</outputDirectory>
+ <destFileName>[ filename ]</destFileName>
+ </artifactItem>
+ </artifactItems>
+ <!-- other configurations here -->
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
Modified: maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt?view=diff&rev=517985&r1=517984&r2=517985
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt
(original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt Tue Mar
13 20:26:03 2007
@@ -21,7 +21,7 @@
Allan Ramirez
Brian Fox
------
- Jan 2007
+ Mar 2007
------
Maven Dependency Plugin
@@ -32,7 +32,7 @@
* Goals Overview
- Dependency plugin has 10 goals:
+ Dependency plugin has several goals:
*{{{copy-mojo.html}dependency:copy}} takes a list of artifacts defined in
the plugin configuration section and copies them to a specified location,
@@ -67,6 +67,8 @@
*{{{build-classpath-mojo.html}dependency:build-classpath}} tells
Maven to output the path of the dependencies from the local repository in a
classpath format to be used in java -cp
+ ~~*{{{analyze-mojo.html}dependency:analyze}} analyzes your project's
dependencies and lists dependencies that should be declared, but are not, and
dependencies that are declared but unused.
+ *Coming soon in 2.0-alpha-3: dependency:analyze analyzes your project's
dependencies and lists dependencies that should be declared, but are not, and
dependencies that are declared but unused.
[]
Modified: maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt?view=diff&rev=517985&r1=517984&r2=517985
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt
(original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt Tue Mar
13 20:26:03 2007
@@ -21,7 +21,7 @@
Allan Ramirez
Brian Fox
------
- Jan 2007
+ Mar 2007
------
Usage
@@ -54,7 +54,7 @@
[]
- Configure the plugin something like this:
+ Configure the plugin something like this if you intend to bind it to
execute along with your build:
+---+
<project>
@@ -93,6 +93,43 @@
[...]
</project>
+---+
+
+ If you intend to configure this mojo for execution on the command line
using:
+
++---+
+mvn dependency:copy
++---+
+
+ you must not put the configuration inside the <executions> tag. Your
configuration should look like this:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>[ groupId ]</groupId>
+ <artifactId>[ artifactId ]</artifactId>
+ <version>[ version ]</version>
+ <type>[ packaging ]</type>
+ <overWrite>[ true or false ]</overWrite>
+ <outputDirectory>[ output directory ]</outputDirectory>
+ <destFileName>[ filename ]</destFileName>
+ </artifactItem>
+ </artifactItems>
+ <!-- other configurations here -->
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
* The <<<dependency:copy-dependencies>>> mojo
@@ -168,7 +205,9 @@
The artifact version is optional. If not set, the plugin will attempt to
resolve it from the
project dependencies and then the dependencyManagement section.
-
+
+ Configure the plugin something like this if you intend to bind it to
execute along with your build:
+
+---+
<project>
[...]
@@ -196,6 +235,44 @@
</project>
+---+
+ If you intend to configure this mojo for execution on the command line
using:
+
++---+
+mvn dependency:unpack
++---+
+
+ you must not put the configuration inside the <executions> tag. Your
configuration should look like this:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>[ groupId ]</groupId>
+ <artifactId>[ artifactId ]</artifactId>
+ <version>[ version ]</version>
+ <type>[ packaging ]</type>
+ <overWrite>[ true or false ]</overWrite>
+ <outputDirectory>[ output directory ]</outputDirectory>
+ <destFileName>[ filename ]</destFileName>
+ </artifactItem>
+ </artifactItems>
+ <!-- other configurations here -->
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
+
+
* The <<<dependency:unpack-dependencies>>> mojo
This goal can be bound to a lifecycle and configured in your pom.xml.
@@ -458,4 +535,36 @@
[...]
</project>
+---+
+
+* The <<<dependency:analyze>>> mojo
+
+ Coming soon in 2.0-alpha-3:
+ This mojo can be executed from the command line:
+
++---+
+mvn dependency:analyze
++---+
+
+ Sample output:
+
++---+
+[INFO] [dependency:analyze]
+[INFO] Used declared dependencies:
+[INFO] org.codehaus.plexus:plexus-archiver:jar:1.0-alpha-7:compile
+[INFO] junit:junit:jar:3.8.1:test
+[INFO] org.codehaus.plexus:plexus-container-default:jar:1.0-alpha-9:compile
+[INFO] org.apache.maven:maven-model:jar:2.0.5:compile
+[INFO] org.apache.maven:maven-project:jar:2.0.5:compile
+[INFO] org.apache.maven.shared:file-management:jar:1.1:compile
+[INFO] org.codehaus.plexus:plexus-utils:jar:1.1:compile
+[INFO] org.apache.maven:maven-artifact:jar:2.0.5:compile
+[INFO] org.apache.maven:maven-plugin-api:jar:2.0.5:compile
+[INFO]
org.apache.maven.shared:maven-plugin-testing-harness:jar:1.0-beta-1:test
+[INFO]
org.apache.maven.shared:maven-dependency-analyzer:jar:1.0-SNAPSHOT:compile
+[INFO] Used undeclared dependencies:
+[INFO] None
+[INFO] Unused declared dependencies:
+[INFO] None
++---+
+
Modified: maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml?view=diff&rev=517985&r1=517984&r2=517985
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml Tue Mar 13
20:26:03 2007
@@ -29,6 +29,24 @@
plugin to use is the maven-dependency-plugin.
</p>
</answer>
- </faq>
+ </faq>
+ <faq id="question">
+ <question>When executing mvn dependency:unpack or dependency:copy from
the command line, I get "One or more required plugin parameters are
invalid/missing for 'dependency:unpack'"</question>
+ <answer>
+ <p>
+ In order for this to work, you must configure the
ArtifactItems as shown <a href="examples\copying-artifacts.html#Copying From
the Command Line">here</a>. Note that when executing a plugin from
+ the command line, you must put the configuration tag
outside of the executions.
+
+ If you haven't done this correctly, the error will look
like this:
+ <pre>
+ [0] inside the definition for plugin:
'maven-dependency-plugin'specify the following:
+ <configuration>
+ ...
+ <artifactItems>VALUE</artifactItems>
+ </configuration>.
+ </pre>
+ </p>
+ </answer>
+ </faq>
</part>
</faqs>
