56cf6c2c8d
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@155674 13f79535-47bb-0310-9956-ffa450edef68
130 lines
5.2 KiB
XML
130 lines
5.2 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* 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>Ant Settings</title>
|
|
<author email="aheritier@apache.org">Arnaud Heritier</author>
|
|
</properties>
|
|
<body>
|
|
<section name="Information about the generated Ant build file">
|
|
<subsection name="Properties">
|
|
<p>When you generate the build file with maven, if the property <a href="properties.html">
|
|
<code>"maven.ant.use.properties"</code>
|
|
</a> is setted to true (default behaviour), the build file will load successively the properties stored in files <code>"build.properties"</code> located in :</p>
|
|
<ol>
|
|
<li>the project's root directory,</li>
|
|
<li>the user's home directory.</li>
|
|
</ol>
|
|
<p>If this property is setted to false the generated build file doesn't load this properties, so it will help you to avoid conflicts.</p>
|
|
<p>The following properties are defined in the build files and thus can be overridden in the files described previously : </p>
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Description</th>
|
|
<th>Default value</th>
|
|
</tr>
|
|
<tr>
|
|
<td>defaulttargetdir</td>
|
|
<td>The directory where the generated files are stored</td>
|
|
<td>${basedir}/target</td>
|
|
</tr>
|
|
<tr>
|
|
<td>libdir</td>
|
|
<td>The directory where are downloaded dependencies (default maven local repository). If you prefer you can use something like <code>${basedir}/target/lib</code>.</td>
|
|
<td>${user.home}/.maven/repository</td>
|
|
</tr>
|
|
<tr>
|
|
<td>classesdir</td>
|
|
<td>The directory where compiled classes are stored</td>
|
|
<td>${basedir}/target/classes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>testclassesdir</td>
|
|
<td>The directory where compiled classes for unit tests are stored (only if there are unit tests classes in your project)</td>
|
|
<td>${basedir}/target/test-classes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>testreportdir</td>
|
|
<td>The directory where tests reports are stored (only if there are unit tests classes in your project)</td>
|
|
<td>${basedir}/target/test-reports</td>
|
|
</tr>
|
|
<tr>
|
|
<td>distdir</td>
|
|
<td>The directory where the distribution is created</td>
|
|
<td>${basedir}/dist</td>
|
|
</tr>
|
|
<tr>
|
|
<td>javadocdir</td>
|
|
<td>The directory where is stored the javadoc</td>
|
|
<td>${basedir}/dist/docs/api</td>
|
|
</tr>
|
|
<tr>
|
|
<td>final.name</td>
|
|
<td>The name used for the generated jar</td>
|
|
<td>${maven.final.name}</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<i>${dep.artifactId}</i>.jar</td>
|
|
<td>A property is created for each project's dependency (for example : <code>activation.jar</code>). This property can be used to override the default url used to download the dependency (for example : <code>activation.jar=http://myhost/repository/sun/jars/activation-1.0.2.jar</code>).</td>
|
|
<td/>
|
|
</tr>
|
|
<tr>
|
|
<td>proxy.host</td>
|
|
<td>The proxy host used to download dependencies.</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>proxy.port</td>
|
|
<td>The proxy port.</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>proxy.username</td>
|
|
<td>The username used to connect on proxy. (only if the ant file was generated with a 1.6 compatibility)</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>proxy.password</td>
|
|
<td>The password used to connect on proxy. (only if the ant file was generated with a 1.6 compatibility)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</subsection>
|
|
<subsection name="Targets">
|
|
<p>The main targets defined in the generated ant's buildfile are : </p>
|
|
<ul>
|
|
<li>
|
|
<b>clean</b> : to delete generated directories (${defaulttargetdir} and ${distdir}).</li>
|
|
<li>
|
|
<b>compile</b> : to compile the code.</li>
|
|
<li>
|
|
<b>test</b> : to run the test cases.</li>
|
|
<li>
|
|
<b>jar</b> : to create the jar.</li>
|
|
<li>
|
|
<b>javadoc</b> : to generate the project's javadoc.</li>
|
|
<li>
|
|
<b>dist</b> : to create the distribution. It contains the jar, the javadoc, licenses(LICENCE.*) and readme (README.*).</li>
|
|
</ul>
|
|
</subsection>
|
|
</section>
|
|
</body>
|
|
</document>
|