Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation

Browse Source 
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 2005-01-08 02:01:29 +00:00
parent daf6a1bc33
commit 555a8c621d
3 changed files with 111 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
gump/xdocs/goals.xml
View File

@ -27,26 +27,49 @@
<body> <body>
<section name="Goals"> <section name="Goals">
<table> <table>
<tr><th>Goal</th><th>Description</th></tr> <tr>
<th>Goal</th>
<th>Description</th>
</tr>
<a name="gump" /> <a name="gump:gump"/>
<tr> <tr>
<td>gump</td> <td>gump:gump</td>
<td> <td>
The default goal. This goal simply executes the Generates a
<a href="#gump:generate-descriptor">gump:generate-descriptor</a> goal <code>gump.xml</code> file for Apache Gump
</td> that is usable directly for the current project.
</tr> </td>
</tr>
<a name="gump:generate-descriptor" /> <a name="gump:multiproject"/>
<tr> <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>gump:generate-descriptor</td>
<td> <td>
Generates a <code>gump.xml</code> file for Apache Gump This is an alias for
that is usable directly. <a href="#gump:gump">gump:gump</a>.
<br />
</td> </td>
</tr> </tr>
</table> </table>
</section> </section>
</body> </body>

63
gump/xdocs/index.xml
View File

@ -21,17 +21,72 @@
<properties> <properties>
<title>Maven Gump Plug-in</title> <title>Maven Gump Plug-in</title>
<author email="jason@zenplex.com">Jason van Zyl</author> <author email="brett@apache.org">Brett Porter</author>
</properties> </properties>
<body> <body>
<section name="Maven Gump Plug-in"> <section name="Maven Gump Plug-in">
<p> <p>
This plug-in generates a descriptor that allows your project to This plug-in generates a descriptor that allows your project to
participate in Gump builds. The use for this descriptor will soon be participate in Gump builds.
negated by the use of the Maven Reactor but until the Reactor is
complete the generation of the Gump descriptor is somewhat useful.
</p> </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>&lt;gump.project&gt;</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>&lt;gump.id&gt;</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> </section>
</body> </body>
</document> </document>

16
gump/xdocs/properties.xml
View File

@ -62,14 +62,21 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td>pom.dependencies</td> <td>maven.gump.descriptor</td>
<td>Yes</td> <td>Yes</td>
<td> <td>
Used to derive a list of projects that are depended on, which The filename of the descriptor to generate. The default is <code>${basedir}/gump.xml</code>.
is the iterated to provide the <code>depend project</code>
value for Gump.
</td> </td>
</tr> </tr>
<tr>
<td>maven.gump.module.name</td>
<td>Yes</td>
<td>
Name to use for the <code>&lt;module/&gt;</code> element.
The default is the artifact ID of the project.
</td>
</tr>
<!--
<tr> <tr>
<td>pom.gumpRepositoryId</td> <td>pom.gumpRepositoryId</td>
<td>Yes</td> <td>Yes</td>
@ -114,6 +121,7 @@
Used to generate the <code>url</code> value for Gump Used to generate the <code>url</code> value for Gump
</td> </td>
</tr> </tr>
-->
</table> </table>
</section> </section>
</body> </body>