From 555a8c621de20ded2a9397d8ec241dd998d3169b Mon Sep 17 00:00:00 2001 From: brett Date: Sat, 8 Jan 2005 02:01:29 +0000 Subject: [PATCH] documentation git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@124601 13f79535-47bb-0310-9956-ffa450edef68 --- gump/xdocs/goals.xml | 57 ++++++++++++++++++++++++----------- gump/xdocs/index.xml | 63 ++++++++++++++++++++++++++++++++++++--- gump/xdocs/properties.xml | 16 +++++++--- 3 files changed, 111 insertions(+), 25 deletions(-) diff --git a/gump/xdocs/goals.xml b/gump/xdocs/goals.xml index 2b3f0d8a..ac60aae3 100644 --- a/gump/xdocs/goals.xml +++ b/gump/xdocs/goals.xml @@ -27,26 +27,49 @@
- - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + - +
GoalDescription
gump - The default goal. This goal simply executes the - gump:generate-descriptor goal -
GoalDescription
gump:gump + Generates a + gump.xml file for Apache Gump + that is usable directly for the current project. +
gump:multiproject + Generates a + gump.xml file for Apache Gump + that is usable directly, aggregating all of your + modules into one file. +
gump + The default goal. This is an alias for + gump:gump. +
gump:generate-descriptor - Generates a gump.xml file for Apache Gump - that is usable directly. -
+ This is an alias for + gump:gump.
diff --git a/gump/xdocs/index.xml b/gump/xdocs/index.xml index de1aec32..8f3bd896 100644 --- a/gump/xdocs/index.xml +++ b/gump/xdocs/index.xml @@ -21,17 +21,72 @@ Maven Gump Plug-in - Jason van Zyl + Brett Porter

This plug-in generates a descriptor that allows your project to - participate in Gump builds. The use for this descriptor will soon be - negated by the use of the Maven Reactor but until the Reactor is - complete the generation of the Gump descriptor is somewhat useful. + participate in Gump builds.

+ +

+ Generating the gump descriptor should require few modifications to your project. + The most important addition is that of the Gump repository ID to your project file. + This tells Gump where to checkout the source code from. For example: +

+ apache-incubator-svn]]> +

+ If you are building a descriptor for a single Maven project, run: +

+ maven gump:gump +

+ If you are using a multiproject set up, and would like to aggregate all the projects into + a single descriptor, run: +

+ maven gump:multiproject +

+ If you need to make any customisations to the output, see the "Dependencies and IDs" section that follows, + and the Properties Reference. + If the plugin does not support generating a structure that you need in the descriptor, please file an + enhancement request in JIRA. +

+ + +

+ Ideally, the Maven project IDs should match those used by Gump - however this is not + always the case. For a list of known mismatches, see + The Gump Wiki. This page also explains + the differences between Gump and Maven IDs. +

+

+ Normally, the plugin will map the artifact ID of a dependency to the project name in Gump. The group ID is not + used. To force the plugin to match a certain Gump project, add the <gump.project> + dependency property. For example: +

+ + velocity + velocity + 1.4 + + jakarta-velocity + + ]]> +

+ If you must also select a particular JAR id from Gump, you can add the <gump.id> + dependency property. For example: +

+ + axis + axis + 1.0 + + ws-axis + axis + + ]]> +
diff --git a/gump/xdocs/properties.xml b/gump/xdocs/properties.xml index 2aafaa23..199dc830 100644 --- a/gump/xdocs/properties.xml +++ b/gump/xdocs/properties.xml @@ -62,14 +62,21 @@ - pom.dependencies + maven.gump.descriptor Yes - Used to derive a list of projects that are depended on, which - is the iterated to provide the depend project - value for Gump. + The filename of the descriptor to generate. The default is ${basedir}/gump.xml. + + maven.gump.module.name + Yes + + Name to use for the <module/> element. + The default is the artifact ID of the project. + + +