You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by ah...@apache.org on 2005/01/21 00:27:34 UTC
svn commit: r125859 - /maven/maven-1/plugins/trunk/ant/xdocs/index.xml
Author: aheritier
Date: Thu Jan 20 15:27:33 2005
New Revision: 125859
URL: http://svn.apache.org/viewcvs?view=rev&rev=125859
Log:
More documentations. MPANT-20 example.
Modified:
maven/maven-1/plugins/trunk/ant/xdocs/index.xml
Modified: maven/maven-1/plugins/trunk/ant/xdocs/index.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/ant/xdocs/index.xml?view=diff&rev=125859&p1=maven/maven-1/plugins/trunk/ant/xdocs/index.xml&r1=125858&p2=maven/maven-1/plugins/trunk/ant/xdocs/index.xml&r2=125859
==============================================================================
--- maven/maven-1/plugins/trunk/ant/xdocs/index.xml (original)
+++ maven/maven-1/plugins/trunk/ant/xdocs/index.xml Thu Jan 20 15:27:33 2005
@@ -16,14 +16,12 @@
* limitations under the License.
*/
-->
-
<document>
-
<properties>
<title>Maven Ant Plug-in</title>
<author email="jason@zenplex.com">Jason van Zyl</author>
+ <author email="aheritier@apache.org">Arnaud Heritier</author>
</properties>
-
<body>
<section name="Maven Ant Plug-in">
<p>
@@ -41,5 +39,55 @@
document.
</p>
</section>
- </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>
+ <ul>
+ <li>
+ <b>defaulttargetdir</b> : the directory where the generated files are stored <i>(default = ${project.home}/target)</i>.</li>
+ <li>
+ <b>libdir</b> : the directory where are downloaded dependencies <i>(default = ${project.home}/target/lib)</i>.</li>
+ <li>
+ <b>classesdir</b> : the directory where compiled classes are stored <i>(default = ${project.home}/target/classes)</i>.</li>
+ <li>
+ <b>testclassesdir</b> (only if there are unit tests classes in your project) : the directory where compiled classes for unit tests are stored <i>(default = ${project.home}/target/test-classes)</i>.</li>
+ <li>
+ <b>testreportdir</b> (only if there are unit tests classes in your project) : the directory where tests reports are stored <i>(default = ${project.home}/target/test-reports)</i>.</li>
+ <li>
+ <b>distdir</b> : the directory where the distribution is created <i>(default = ${project.home}/dist)</i>.</li>
+ <li>
+ <b>javadocdir</b> : the directory where is stored the javadoc <i>(default = ${project.home}/dist/docs/api)</i>.</li>
+ <li>
+ <b>final.name</b> : the name used for the generated jar <i>(default = ${maven.final.name}</i>.</li>
+ <li>
+ <b>${dep.artifactId}.jar</b> : 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>).</li>
+ </ul>
+ </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>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org