documentation
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@124601 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
brett
parent
daf6a1bc33
commit
555a8c621d
@ -27,26 +27,49 @@
|
||||
<body>
|
||||
<section name="Goals">
|
||||
<table>
|
||||
<tr><th>Goal</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<th>Goal</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
|
||||
<a name="gump" />
|
||||
<tr>
|
||||
<td>gump</td>
|
||||
<td>
|
||||
The default goal. This goal simply executes the
|
||||
<a href="#gump:generate-descriptor">gump:generate-descriptor</a> goal
|
||||
</td>
|
||||
</tr>
|
||||
<a name="gump:gump"/>
|
||||
<tr>
|
||||
<td>gump:gump</td>
|
||||
<td>
|
||||
Generates a
|
||||
<code>gump.xml</code> file for Apache Gump
|
||||
that is usable directly for the current project.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<a name="gump:generate-descriptor" />
|
||||
<tr>
|
||||
<a name="gump:multiproject"/>
|
||||
<tr>
|
||||
<td>gump:multiproject</td>
|
||||
<td>
|
||||
Generates a
|
||||
<code>gump.xml</code> file for Apache Gump
|
||||
that is usable directly, aggregating all of your
|
||||
modules into one file.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<a name="gump"/>
|
||||
<tr>
|
||||
<td>gump</td>
|
||||
<td>
|
||||
The default goal. This is an alias for
|
||||
<a href="#gump:gump">gump:gump</a>.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<a name="gump:generate-descriptor"/>
|
||||
<tr>
|
||||
<td>gump:generate-descriptor</td>
|
||||
<td>
|
||||
Generates a <code>gump.xml</code> file for Apache Gump
|
||||
that is usable directly.
|
||||
<br />
|
||||
This is an alias for
|
||||
<a href="#gump:gump">gump:gump</a>.
|
||||
</td>
|
||||
</tr>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
</body>
|
||||
|
||||
@ -21,17 +21,72 @@
|
||||
|
||||
<properties>
|
||||
<title>Maven Gump Plug-in</title>
|
||||
<author email="jason@zenplex.com">Jason van Zyl</author>
|
||||
<author email="brett@apache.org">Brett Porter</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven Gump Plug-in">
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<subsection name="Using the plugin">
|
||||
<p>
|
||||
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:
|
||||
</p>
|
||||
<source><![CDATA[<gumpRepositoryId>apache-incubator-svn</gumpRepositoryId>]]></source>
|
||||
<p>
|
||||
If you are building a descriptor for a single Maven project, run:
|
||||
</p>
|
||||
<source>maven gump:gump</source>
|
||||
<p>
|
||||
If you are using a multiproject set up, and would like to aggregate all the projects into
|
||||
a single descriptor, run:
|
||||
</p>
|
||||
<source>maven gump:multiproject</source>
|
||||
<p>
|
||||
If you need to make any customisations to the output, see the "Dependencies and IDs" section that follows,
|
||||
and the <a href="properties.html">Properties Reference</a>.
|
||||
If the plugin does not support generating a structure that you need in the descriptor, please file an
|
||||
enhancement request in <a href="http://jira.codehaus.org/browse/MPGUMP">JIRA</a>.
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="Dependencies and IDs">
|
||||
<p>
|
||||
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
|
||||
<a href="http://wiki.apache.org/gump/MavenId">The Gump Wiki</a>. This page also explains
|
||||
the differences between Gump and Maven IDs.
|
||||
</p>
|
||||
<p>
|
||||
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 <code><gump.project></code>
|
||||
dependency property. For example:
|
||||
</p>
|
||||
<source><![CDATA[<dependency>
|
||||
<groupId>velocity</groupId>
|
||||
<artifactId>velocity</groupId>
|
||||
<version>1.4</version>
|
||||
<properties>
|
||||
<gump.project>jakarta-velocity</gump.project>
|
||||
</properties>
|
||||
</dependency>]]></source>
|
||||
<p>
|
||||
If you must also select a particular JAR id from Gump, you can add the <code><gump.id></code>
|
||||
dependency property. For example:
|
||||
</p>
|
||||
<source><![CDATA[<dependency>
|
||||
<groupId>axis</groupId>
|
||||
<artifactId>axis</groupId>
|
||||
<version>1.0</version>
|
||||
<properties>
|
||||
<gump.project>ws-axis</gump.project>
|
||||
<gump.id>axis</gump.id>
|
||||
</properties>
|
||||
</dependency>]]></source>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
@ -62,14 +62,21 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pom.dependencies</td>
|
||||
<td>maven.gump.descriptor</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Used to derive a list of projects that are depended on, which
|
||||
is the iterated to provide the <code>depend project</code>
|
||||
value for Gump.
|
||||
The filename of the descriptor to generate. The default is <code>${basedir}/gump.xml</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.gump.module.name</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Name to use for the <code><module/></code> element.
|
||||
The default is the artifact ID of the project.
|
||||
</td>
|
||||
</tr>
|
||||
<!--
|
||||
<tr>
|
||||
<td>pom.gumpRepositoryId</td>
|
||||
<td>Yes</td>
|
||||
@ -114,6 +121,7 @@
|
||||
Used to generate the <code>url</code> value for Gump
|
||||
</td>
|
||||
</tr>
|
||||
-->
|
||||
</table>
|
||||
</section>
|
||||
</body>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user