maven-plugins/ant/xdocs/goals.xml

64 lines
2.5 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>Goals</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
<author email="aheritier@apache.org">Arnaud Heritier</author>
</properties>
<body>
<section name="Goals">
<table>
<tr>
<th>Goal</th>
<th>Available</th>
<th>Description</th>
</tr>
<tr>
<td>ant</td>
<td>since 1.0</td>
<td>This is the default goal of the plugin and simply attains the <code>ant:generate-build</code> goal.
</td>
</tr>
<tr>
<td>ant:generate-build</td>
<td>since 1.0</td>
<td>Generates an <a href="http://ant.apache.org/">ant</a> build file in the current directory which has targets to
<ul>
<li>Compile the java source code</li>
<li>Create a jar from the compiled java code</li>
<li>Create a distribution</li>
<li>Run unit tests</li>
<li>Generate JavaDoc</li>
<li>Download all required jar files</li>
<li>Download and install Maven</li>
</ul>
<p>The generated file is located at ${maven.ant.generate.dir}/${maven.ant.generate.script}. If the file already exists the plugin ask to the user if he wants to overwrite it (except if the property <code>maven.ant.generate.force</code> is setted to true).</p>
</td>
</tr>
<tr>
<td>ant:execute</td>
<td>since 1.10</td>
<td>Execute the <a href="http://ant.apache.org/">ant</a> build file located at <code>${maven.ant.execute.dir}/${maven.ant.execute.script}</code>. <b>Be careful</b>, in this case ant uses the classpath given by maven, thus you can have a different behaviour if you use this task instead of the real ant application.</td>
</tr>
</table>
</section>
</body>
</document>