maven-plugins/gump/xdocs/properties.xml
2005-09-13 22:18:53 +00:00

88 lines
2.6 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "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.
*/
-->
<document>
<properties>
<title>Gump Properties</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name="Gump Settings">
<p>
There are no settings available to tailor the output
from the Gump plugin, however it does use the following
project descriptor settings
</p>
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.gump.ant.generate</td>
<td>Yes</td>
<td>
Set to true to generate an ant element. By default, none is added to the descriptor.
</td>
</tr>
<tr>
<td>maven.gump.maven.generate</td>
<td>Yes</td>
<td>
Set to false to not generate a maven element. By default, a maven element is added to the descriptor.
</td>
</tr>
<tr>
<td>maven.gump.ant.target</td>
<td>Yes</td>
<td>
The target to execute. Defaults to dist.
</td>
</tr>
<tr>
<td>maven.gump.maven.goals</td>
<td>Yes</td>
<td>
The goals to execute. Defaults to jar.
</td>
</tr>
<tr>
<td>maven.gump.descriptor</td>
<td>Yes</td>
<td>
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>&lt;module/&gt;</code> element.
The default is the artifact ID of the project.
</td>
</tr>
<tr>
<td>maven.gump.svn.dir</td>
<td>Yes</td>
<td>If Subversion is used as SCM, set this property to define the directory to use (for example trunk).</td>
</tr>
</table>
</section>
</body>
</document>