dion 2002/10/04 20:51:50
Modified: src/plugins-build/java/xdocs changes.xml index.xml
navigation.xml
Added: src/plugins-build/java/xdocs goals.xml
Log:
Added more docs
Revision Changes Path
1.3 +3 -0 jakarta-turbine-maven/src/plugins-build/java/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/java/xdocs/changes.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- changes.xml 29 Sep 2002 14:16:35 -0000 1.2
+++ changes.xml 5 Oct 2002 03:51:50 -0000 1.3
@@ -7,6 +7,9 @@
<body>
<release version="1.1" date="in CVS">
+ <action dev="dion" type="fix">
+ Added <a href="goals.html">goals documentation</a>
+ </action>
<action dev="dion" type="add">
Added maven.compile.source, maven.compile.target,
maven.compile.executable, maven.compile.fork and maven.compile.compilerargs
1.2 +9 -0 jakarta-turbine-maven/src/plugins-build/java/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/java/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 4 Aug 2002 14:53:11 -0000 1.1
+++ index.xml 5 Oct 2002 03:51:50 -0000 1.2
@@ -11,6 +11,15 @@
<p>
This plug-in provides your basic Javac and Jar facilities.
</p>
+ <p>
+ For more information on the functionality provided by this plugin,
+ please see the <a href="goals.html">Goals</a> document.
+ </p>
+ <p>
+ For more information on how to customise the functionality provided
+ by this plugin, please see the <a href="properties.html">properties</a>
+ document.
+ </p>
</section>
</body>
</document>
1.2 +1 -0
jakarta-turbine-maven/src/plugins-build/java/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/java/xdocs/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 9 Sep 2002 05:19:15 -0000 1.1
+++ navigation.xml 5 Oct 2002 03:51:50 -0000 1.2
@@ -9,6 +9,7 @@
<item name="Java" href="http://java.sun.com/"/>
</links>
<menu name="Overview">
+ <item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" />
</menu>
</body>
1.1 jakarta-turbine-maven/src/plugins-build/java/xdocs/goals.xml
Index: goals.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven Java Plug-in Goals</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<section name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>java:prepare-filesystem</td>
<td>
Creates the directories necessary for compilation
</td>
</tr>
<tr>
<td>java:compile</td>
<td>
<p>
Compiles the Java source code for the project
</p>
<p>
The source code directory is specified in the
<a
href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html#build";>build</a>
element of your <code>project.xml</code>
file.
</p>
</td>
</tr>
<tr>
<td>java:jar-resources</td>
<td>
<p>
Copies any resources that must be present in the deployed JAR
file, from the directory specified by
<a href="properties.html">maven.jarResources.basedir</a> to the
build directory, where class files are stored.
</p>
<p>
The <a href="properties.html">maven.jar.resources.set</a>
property is used to determine which files from the base directory
are included
</p>
</td>
</tr>
<tr>
<td>java:jar</td>
<td>
Creates a jar file in the Maven build directory with the
form <code>${project.id}-${project.currentVersion}.jar</code> where
the id and currentVersion are taken from the <code>project.xml</code>
of the project being built.
</td>
</tr>
<tr>
<td>jar:snapshot</td>
<td>
Creates a jar file in the Maven build directory with the
form <code>${project.id}-YYYYMMDD.hhmmss.jar</code> where
<ul>
<li>
id - taken from the <code>project.xml</code>
of the project being built
</li>
<li>YYYYMMDD - The current year in 8 digit format</li>
<li>hhmmss - the current time in 6 digit format</li>
</ul>
</td>
</tr>
<tr>
<td>jar:deploy-snapshot</td>
<td>
Deploy a snapshot jar to the remote repository
</td>
</tr>
<tr>
<td>jar:deploy</td>
<td>
Deploy a jar to the remote repository. The jar is built using
the <code>java:jar</code> goal
</td>
</tr>
<tr>
<td>jar:install</td>
<td>
Install a jar into the local repository. The jar is built using
the <code>java:jar</code> goal
</td>
</tr>
<tr>
<td>clean</td>
<td>
This goal is a shortcut to the <code>clean:clean</code> goal
</td>
</tr>
<tr>
<td>clean:clean</td>
<td>
Removes the <a href="properties.html">maven.build.dir</a> and
<a href="properties.html">maven.test.reportsDirectory</a> directories
</td>
</tr>
</table>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
