You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/08/05 15:11:10 UTC
svn commit: r801211 - in
/maven/plugins/trunk/maven-dependency-plugin/src/site:
apt/examples/preparing-dependencies.apt apt/index.apt fml/faq.fml site.xml
Author: vsiveton
Date: Wed Aug 5 13:11:09 2009
New Revision: 801211
URL: http://svn.apache.org/viewvc?rev=801211&view=rev
Log:
o fixed ambiguous links
o added Doxia xsd
Modified:
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/preparing-dependencies.apt
maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-dependency-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/preparing-dependencies.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/preparing-dependencies.apt?rev=801211&r1=801210&r2=801211&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/preparing-dependencies.apt (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/apt/examples/preparing-dependencies.apt Wed Aug 5 13:11:09 2009
@@ -13,8 +13,8 @@
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
-~~ under the License.
-
+~~ under the License.
+
------
Fixing Dependency Problems
------
@@ -24,9 +24,9 @@
------
How to prepare your dependencies before updating to Maven 2.0.6:
-
+
If you have dependencies in dependencyManagement that conflict with transitive dependencies, the fix for MNG-1577 may alter the version you get when running a build with 2.0.6. To ensure a smooth transition, there is a tool to detect these conditions.
-
+
In your project, run "mvn dependency:analyze" (be sure to use 2.0.5 or the plugin won't detect mismatches) This will display output similar to below:
+---+
@@ -58,7 +58,7 @@
[INFO] DepMgt : 2.3
[INFO] Resolved: 2.4
[WARNING] Potential problems found in Dependency Management
-+---+
++---+
In the sample above, you can see that I am actually getting versions different than what I'm asking for. In 2.0.6, I would suddenly be downgraded to commons-lang 1.0 from 2.3, commons-digester 1.6 from 1.7 and servlet-api 2.3 from 2.4. Depending on the jars and your project, this may manifest as compile errors or runtime errors.
When you see these mismatches, the suggested approach is to adjust your dependencyManagement section to have the version you are actually getting (in this case, 2.3,1.7 and 2.4 respectively). Then when you upgrade to 2.0.6, you will be getting the same versions in your build that you currently get in 2.0.5.
@@ -71,13 +71,11 @@
After upgrading to 2.0.6, you may want to remove workarounds to MNG-1577 that you have put in place. These usually would have been the introduction of a dependency to your pom that wasn't nessessary simply to override a transitive version. If you have workarounds in your pom, they will show up as Unused declared dependencies. Note that currently the test and runtime dependencies are excluded from the usage analysis.
Read more here:
-
- * {{{analyze-mojo.html}Analyze Mojo}}
- * {{{analyze-dep-mgt-mojo.html}Analyze-dep-mgt Mojo}}
+ * {{{./analyze-mojo.html}Analyze Mojo}}
- * {{{usage.html}Usage}}
-
- []
+ * {{{./analyze-dep-mgt-mojo.html}Analyze-dep-mgt Mojo}}
+ * {{{./usage.html}Usage}}
+ []
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?rev=801211&r1=801210&r2=801211&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/apt/index.apt Wed Aug 5 13:11:09 2009
@@ -34,93 +34,93 @@
The Dependency plugin has several goals:
- *{{{analyze-mojo.html}dependency:analyze}} analyzes the dependencies of this project and determines which are: used
+ *{{{./analyze-mojo.html}dependency:analyze}} analyzes the dependencies of this project and determines which are: used
and declared; used and undeclared; unused and declared.
- *{{{analyze-dep-mgt-mojo.html}dependency:analyze-dep-mgt}} analyzes your projects dependencies and lists mismatches
+ *{{{./analyze-dep-mgt-mojo.html}dependency:analyze-dep-mgt}} analyzes your projects dependencies and lists mismatches
between resolved dependencies and those listed in your dependencyManagement section.
- *{{{analyze-only-mojo.html}dependency:analyze-only}} is the same as analyze, but is meant to be bound in a pom. It
+ *{{{./analyze-only-mojo.html}dependency:analyze-only}} is the same as analyze, but is meant to be bound in a pom. It
does not fork the build and execute test-compile.
- *{{{analyze-report-mojo.html}dependency:analyze-report}} analyzes the dependencies of this project and produces a report
+ *{{{./analyze-report-mojo.html}dependency:analyze-report}} analyzes the dependencies of this project and produces a report
that summarises which are: used and declared; used and undeclared; unused and declared.
- *{{{analyze-duplicate-mojo.html}dependency:analyze-duplicate}} analyzes the <dependencies/> and <dependencyManagement/>
+ *{{{./analyze-duplicate-mojo.html}dependency:analyze-duplicate}} analyzes the <dependencies/> and <dependencyManagement/>
tags in the pom.xml and determines the duplicate declared dependencies.
- *{{{build-classpath-mojo.html}dependency:build-classpath}} tells
+ *{{{./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.
The classpath file may also be attached and installed/deployed along with the main artifact.
- *{{{copy-mojo.html}dependency:copy}} takes a list of artifacts defined in the plugin configuration section and
+ *{{{./copy-mojo.html}dependency:copy}} takes a list of artifacts defined in the plugin configuration section and
copies them to a specified location, renaming them or stripping the version if desired. This goal can resolve
the artifacts from remote repositories if they don't exist in local.
- *{{{copy-dependencies-mojo.html}dependency:copy-dependencies}} takes the list of project direct dependencies and
+ *{{{./copy-dependencies-mojo.html}dependency:copy-dependencies}} takes the list of project direct dependencies and
optionally transitive dependencies and copies them to a specified location, stripping the version if desired.
This goal can also be run from the command line.
- *{{{get-mojo.html}dependency:get}} downloads a single artifact transitively from a specified remote repository.
+ *{{{./get-mojo.html}dependency:get}} downloads a single artifact transitively from a specified remote repository.
- *{{{go-offline-mojo.html}dependency:go-offline}} tells Maven to resolve everything this project is dependent on
+ *{{{./go-offline-mojo.html}dependency:go-offline}} tells Maven to resolve everything this project is dependent on
(dependencies, plugins, reports) in preparation for going offline.
- *{{{list-mojo.html}dependency:list}} alias for resolve that lists the dependencies for this project.
+ *{{{./list-mojo.html}dependency:list}} alias for resolve that lists the dependencies for this project.
- *{{{purge-local-repository-mojo.html}dependency:purge-local-repository}} tells Maven to clear all dependency-artifact
+ *{{{./purge-local-repository-mojo.html}dependency:purge-local-repository}} tells Maven to clear all dependency-artifact
files out of the local repository, and optionally re-resolve them.
- *{{{resolve-mojo.html}dependency:resolve}} tells Maven to resolve all dependencies and displays the version.
+ *{{{./resolve-mojo.html}dependency:resolve}} tells Maven to resolve all dependencies and displays the version.
- *{{{resolve-plugins-mojo.html}dependency:resolve-plugins}} Tells Maven to resolve plugins and their dependencies.
+ *{{{./resolve-plugins-mojo.html}dependency:resolve-plugins}} Tells Maven to resolve plugins and their dependencies.
- *{{{sources-mojo.html}dependency:sources}} tells Maven to resolve all dependencies and their source attachments,
+ *{{{./sources-mojo.html}dependency:sources}} tells Maven to resolve all dependencies and their source attachments,
and displays the version.
- *{{{tree-mojo.html}dependency:tree}} displays the dependency tree for this project.
+ *{{{./tree-mojo.html}dependency:tree}} displays the dependency tree for this project.
- *{{{unpack-mojo.html}dependency:unpack}} removes the project dependencies from the local repository, and optionally
+ *{{{./unpack-mojo.html}dependency:unpack}} removes the project dependencies from the local repository, and optionally
re-resolve them.
- *{{{unpack-dependencies-mojo.html}dependency:unpack-dependencies}} like
+ *{{{./unpack-dependencies-mojo.html}dependency:unpack-dependencies}} like
copy-dependencies but unpacks.
[]
* Usage
- General instructions on how to use the Dependency Plugin can be found on the {{{usage.html}usage page}}. Some more
+ General instructions on how to use the Dependency Plugin can be found on the {{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not least, users occasionally contribute
additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/Dependency+Plugin}plugin's wiki page}}.
- In case you still have questions regarding the plugin's usage, please have a look at the {{{faq.html}FAQ}} and feel
- free to contact the {{{mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
+ In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
+ free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
- the {{{mail-lists.html}mail archive}}.
+ the {{{./mail-lists.html}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
- {{{issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
+ {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
- {{{source-repository.html}source repository}} and will find supplementary information in the
+ {{{./source-repository.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
* Examples
The following examples show how to use the dependency plugin in more advanced use-cases:
- * {{{examples/preparing-dependencies.html}Instructions on how to prepare your dependencies for upgrade to Maven 2.0.6 / 2.1}}.
+ * {{{./examples/preparing-dependencies.html}Instructions on how to prepare your dependencies for upgrade to Maven 2.0.6 / 2.1}}.
- * {{{examples/copying-artifacts.html}Copying Specific Artifacts}}
+ * {{{./examples/copying-artifacts.html}Copying Specific Artifacts}}
- * {{{examples/copying-project-dependencies.html}Copying Project Dependencies}}
+ * {{{./examples/copying-project-dependencies.html}Copying Project Dependencies}}
- * {{{examples/unpacking-artifacts.html}Unpacking Specific Artifacts}}
+ * {{{./examples/unpacking-artifacts.html}Unpacking Specific Artifacts}}
- * {{{examples/copying-project-dependencies.html}Unpacking the Project Dependencies}}
+ * {{{./examples/copying-project-dependencies.html}Unpacking the Project Dependencies}}
[]
@@ -132,6 +132,3 @@
* {{{http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html}Dependency Mechanism}}
[]
-
-
-
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?rev=801211&r1=801210&r2=801211&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/fml/faq.fml Wed Aug 5 13:11:09 2009
@@ -19,7 +19,10 @@
under the License.
-->
-<faqs id="FAQ" title="Frequently Asked Questions">
+<faqs xmlns="http://maven.apache.org/FML/1.0.1"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
+ id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="plugin name">
<question>What is the difference between dependency-maven-plugin and maven-dependency-plugin?</question>
@@ -27,47 +30,47 @@
<p>
Actually, they are the same, it's just that it was moved and renamed. The dependency-maven-plugin
is hosted at Mojo while maven-dependency-plugin is hosted at Apache. The recommended
- plugin to use is the maven-dependency-plugin.
+ plugin to use is the maven-dependency-plugin.
</p>
</answer>
</faq>
<faq id="cli">
<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>
+ <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:
- </pre>
- </p>
- </answer>
+ </pre>
+ </p>
+ </answer>
</faq>
<faq id="missing">
<question>Why am I getting errors that a documented goal or parameter is missing?</question>
<answer><p>The latest documents are published and may preceed the actual release. Check to make sure the goal/parameter is in the most recent version.
- <b> -OR- </b>
- Maven may be resolving the older codehaus version of the dependency plugin. See next question.</p>
+ <b> -OR- </b>
+ Maven may be resolving the older codehaus version of the dependency plugin. See next question.</p>
</answer>
</faq>
<faq id="question">
<question>Why is Maven resolving "dependency:xxx" to the older org.codehaus.mojo:dependency-maven-plugin?</question>
<answer><p>
- Due to a bug in Maven in versions prior to 2.0.7 (<a href="http://jira.codehaus.org/browse/MNG-2926">MNG-2926</a>) the search order was reversed and caused Mojo plugins to supercede ones with the same prefix at Apache.
- The metadata at mojo was cleaned up when the maven-dependency-plugin was released at Apache. If you are still experiencing this error, chances are you have
- old metadata in your local repository or in a proxy / internal repository. Removing /org/codehaus/mojo/maven-metadata.* from your repo/proxy will cause it to
- be refreshed. Alternatively, you can specify the groupId explicitely in your pom (if you are using a bound goal), or on the command line, use groupId:artifactId:version:mojo, ie mvn
+ Due to a bug in Maven in versions prior to 2.0.7 (<a href="http://jira.codehaus.org/browse/MNG-2926">MNG-2926</a>) the search order was reversed and caused Mojo plugins to supercede ones with the same prefix at Apache.
+ The metadata at mojo was cleaned up when the maven-dependency-plugin was released at Apache. If you are still experiencing this error, chances are you have
+ old metadata in your local repository or in a proxy / internal repository. Removing /org/codehaus/mojo/maven-metadata.* from your repo/proxy will cause it to
+ be refreshed. Alternatively, you can specify the groupId explicitely in your pom (if you are using a bound goal), or on the command line, use groupId:artifactId:version:mojo, ie mvn
org.apache.maven.plugins:maven-dependency-plugin:2.0-alpha-4:unpack
- </p>
+ </p>
</answer>
</faq>
<faq id="includes">
<question>Why am I having trouble unpacking only a specific file?</question>
<answer><p>
- The excludes will override the includes declaration. That means if you specify excludes=**/* ,includes=**/foo, you will exclude everything. If you only want foo, then just specify the includes. The plexus component used to unpack uses the following code to determing which files to unpack: return isIncluded( name ) AND !isExcluded( name );
- </p>
+ The excludes will override the includes declaration. That means if you specify excludes=**/* ,includes=**/foo, you will exclude everything. If you only want foo, then just specify the includes. The plexus component used to unpack uses the following code to determing which files to unpack: return isIncluded( name ) AND !isExcluded( name );
+ </p>
</answer>
</faq>
</part>
Modified: maven/plugins/trunk/maven-dependency-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/site.xml?rev=801211&r1=801210&r2=801211&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/site.xml Wed Aug 5 13:11:09 2009
@@ -19,7 +19,10 @@
under the License.
-->
-<project>
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"
+ name="Maven Dependency plugin">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
@@ -28,15 +31,15 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
- <item name="Preparing dependencies for Maven 2.0.6 / 2.1" href="examples/preparing-dependencies.html"/>
+ <item name="Preparing dependencies for Maven 2.0.6 / 2.1" href="examples/preparing-dependencies.html"/>
<item name="Copying specific artifacts" href="examples/copying-artifacts.html" />
<item name="Copying project dependencies" href="examples/copying-project-dependencies.html" />
<item name="Unpacking specific artifacts" href="examples/unpacking-artifacts.html" />
<item name="Unpacking the project dependencies" href="examples/unpacking-project-dependencies.html" />
<item name="Using project dependencies' sources" href="examples/using-dependencies-sources.html" />
- <item name="Failing the build on dependency analysis warnings" href="examples/failing-the-build-on-dependency-analysis-warnings.html"/>
- <item name="Filtering the dependency tree" href="examples/filtering-the-dependency-tree.html"/>
- <item name="Resolving conflicts using the dependency tree" href="examples/resolving-conflicts-using-the-dependency-tree.html"/>
+ <item name="Failing the build on dependency analysis warnings" href="examples/failing-the-build-on-dependency-analysis-warnings.html"/>
+ <item name="Filtering the dependency tree" href="examples/filtering-the-dependency-tree.html"/>
+ <item name="Resolving conflicts using the dependency tree" href="examples/resolving-conflicts-using-the-dependency-tree.html"/>
</menu>
<menu name="Resources">
<item name="Dependency Mechanism" href="http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html" />