maven-plugins/ant/xdocs/properties.xml
2006-05-20 23:23:52 +00:00

137 lines
5.9 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2005 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>Properties</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
<author email="aheritier@apache.org">Arnaud Heritier</author>
</properties>
<body>
<section name="Maven Ant Plugin Settings">
<p>These settings allow you to customize the ant script generated with this plugin.</p>
<table>
<tr>
<th>Property name</th>
<th>Description</th>
<th>Available</th>
<th>Optional?</th>
<th>Default value</th>
</tr>
<tr>
<td>maven.ant.generate.script</td>
<td>The filename to use. Defaults to "build.xml". This file is expected to be a filename relative to the "maven.ant.generate.dir" property given.</td>
<td>since 1.10</td>
<td>Yes</td>
<td>"build.xml"</td>
</tr>
<tr>
<td>maven.ant.generate.dir</td>
<td>The directory where to generate the Ant script. Defaults to the current project's basedir.</td>
<td>since 1.10</td>
<td>Yes</td>
<td>${basedir}</td>
</tr>
<tr>
<td>maven.ant.generate.force</td>
<td>If the ant script file already exists the plugin ask you if you want to replace it. Setting this property to true, will force the plugin to overwrite this file without to ask the question.</td>
<td>since 1.10</td>
<td>Yes</td>
<td>false</td>
</tr>
<tr>
<td>maven.ant.excludeTests</td>
<td>
<span>Holds a comma separated list of source file patterns that will be excluded in the generated Ant build, e.g.</span>
<source>maven.ant.excludeTests=**/*Test.java,**/*Suite.java</source>
</td>
<td>since 1.2</td>
<td>Yes</td>
<td>
<i>&lt;empty&gt;</i>
</td>
</tr>
<tr>
<td>maven.ant.compatibility</td>
<td>Sets the compatibility for the generated script. Valid values are <code>1.5</code> or <code>1.6</code>. With Ant &gt;= 1.6 the user can define a user/password for proxy settings.</td>
<td>since 1.2</td>
<td>Yes</td>
<td>1.6</td>
</tr>
<tr>
<td>maven.ant.use.properties</td>
<td>
<span>The maven plugin for ant adds two lines at the top of the generated buildfile :</span>
<source>&lt;property file="build.properties"/&gt;
&lt;property file="${user.home}/build.properties"/&gt;</source>
<span>If you experience that your own properties are clashing with the ones used in the generated buildfile you can set this property to "false" to remove these 2 lines from the generated buildfile. Valid values are "true" or "false".</span>
</td>
<td>since 1.9</td>
<td>Yes</td>
<td>true</td>
</tr>
<tr>
<td>maven.ant.use.multirepo</td>
<td>Defines if you want to generate a script which will download dependencies from all your repositories. If false, the script will only download them from the first one (ibiblio by default).</td>
<td>since 1.10</td>
<td>Yes</td>
<td>true</td>
</tr>
<tr>
<td>maven.ant.execute.script</td>
<td>The buildfile to use. Defaults to ${maven.ant.generate.script}. This file is expected to be a filename relative to the "maven.ant.execute.dir" property given.</td>
<td>since 1.10</td>
<td>Yes</td>
<td>${maven.ant.generate.script}</td>
</tr>
<tr>
<td>maven.ant.execute.dir</td>
<td>The directory to use as a basedir for the Ant project. Defaults to ${maven.ant.generate.dir}. This will override the basedir setting of the called project.</td>
<td>since 1.10</td>
<td>Yes</td>
<td>${maven.ant.generate.dir}</td>
</tr>
<tr>
<td>maven.ant.execute.target</td>
<td>The target of the Ant project that should be executed. Defaults to the project's default target.</td>
<td>since 1.10</td>
<td>Yes</td>
<td>
<i>&lt;empty&gt;</i>
</td>
</tr>
<tr>
<td>maven.ant.generatebuild.file</td>
<td>
<b>!! REMOVED !!</b> Sets the name of the ant buildfile to create. Use "maven.ant.generate.script" and "maven.ant.generate.dir" instead.</td>
<td>since 1.0, removed in 1.10.</td>
<td>Yes</td>
<td>${basedir}/build.xml</td>
</tr>
</table>
</section>
<section name="Backward compatibility">
<p>In the version 1.10 of the ant plugin we removed the usage of the property "maven.ant.generatebuild.file" to replace it by the properties "maven.ant.generate.dir" and "maven.ant.generate.script".</p>
<p>If you used this property (for example you had : <code>maven.ant.generatebuild.file=myDir/myBuild.xml</code>) and you want to have a build which work with all the versions of this plugin you can set your properties like this :</p>
<source>maven.ant.generatebuild.file=${maven.ant.generate.dir}/${maven.ant.generate.script}
maven.ant.generate.dir=myDir
maven.ant.generate.script=myBuild.xml</source>
</section>
</body>
</document>