Initial revision
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112724 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
jvanzyl
1
java/xdocs/.cvsignore
Normal file
1
java/xdocs/.cvsignore
Normal file
@@ -0,0 +1 @@
|
||||
stylesheets
|
||||
61
java/xdocs/changes.xml
Normal file
61
java/xdocs/changes.xml
Normal file
@@ -0,0 +1,61 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
<properties>
|
||||
<title>Changes</title>
|
||||
<author email="dion@multitask.com.au">dIon Gillard</author>
|
||||
<author email="kschrader@karmalab.org">Kurt Schrader</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<release version="1.2" date="in cvs">
|
||||
<action dev="kschrader" type="add">
|
||||
Added the jar:install-snapshot goal to install a SNAPSHOT
|
||||
version jar in the local repository.
|
||||
</action>
|
||||
<action dev="dion" type="add" due-to="Daigo Moriwaki">
|
||||
Added maven.compile.encoding property
|
||||
</action>
|
||||
<action dev="dion" type="fix">
|
||||
Added docs on properties
|
||||
</action>
|
||||
</release>
|
||||
<release version="1.1" date="2002-10-06">
|
||||
<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
|
||||
properties to allow people with generics to build with Maven
|
||||
</action>
|
||||
<action dev="vmassol" type="fix">
|
||||
Compilation now only happens if java source is present
|
||||
</action>
|
||||
<action dev="dion" type="fix">
|
||||
Applied fix for MAVEN-102, which allows a manifest file to be
|
||||
specified, as well as the defaults when jar'ing.
|
||||
</action>
|
||||
<action dev="smor" type="update">
|
||||
Added goals installing and deploying the plugin:
|
||||
<ol>
|
||||
<li>plugin:install installs the plugin in Maven's plugins dir</li>
|
||||
<li>
|
||||
plugin:deploy installs an unpacked version of the plugin in
|
||||
Maven's plugins dir
|
||||
</li>
|
||||
</ol>
|
||||
<p>
|
||||
This is meant to ease the installation of plugins without having
|
||||
to bootstrap or manually copy the generated plugin to Maven's
|
||||
plugins dir.
|
||||
</p>
|
||||
</action>
|
||||
</release>
|
||||
<release version="1.0" date="2002-08-04">
|
||||
<action dev="jvanzyl" type="add">
|
||||
Initial plugin created
|
||||
</action>
|
||||
</release>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
118
java/xdocs/goals.xml
Normal file
118
java/xdocs/goals.xml
Normal file
@@ -0,0 +1,118 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Java Plug-in Goals</title>
|
||||
<author email="dion@multitask.com.au">dIon Gillard</author>
|
||||
<author email="kschrader@karmalab.org">Kurt Schrader</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>jar:install-snapshot</td>
|
||||
<td>
|
||||
Install a jar into the local repository. The jar is built using
|
||||
the <code>jar:snapshot</code> goal and copied into the local
|
||||
repository as the -SNAPSHOT version.
|
||||
</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>
|
||||
25
java/xdocs/index.xml
Normal file
25
java/xdocs/index.xml
Normal file
@@ -0,0 +1,25 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Java Plug-in</title>
|
||||
<author email="jason@zenplex.com">Jason van Zyl</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven Java Plug-in">
|
||||
<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>
|
||||
16
java/xdocs/navigation.xml
Normal file
16
java/xdocs/navigation.xml
Normal file
@@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<project name="Maven Java Plugin">
|
||||
|
||||
<title>Maven Java Plugin</title>
|
||||
|
||||
<body>
|
||||
<links>
|
||||
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
|
||||
<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>
|
||||
</project>
|
||||
317
java/xdocs/properties.xml
Normal file
317
java/xdocs/properties.xml
Normal file
@@ -0,0 +1,317 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Properties</title>
|
||||
<author email="smor@apache.org">Stéphane MOR</author>
|
||||
<author email="dion@multitask.com.au">dIon Gillard</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Compile Settings">
|
||||
<table>
|
||||
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td>maven.compile.aspects</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies that Aspects are included during compilation.
|
||||
Used by the "java:compile" goal.
|
||||
The default value is <code>false</code>. Please
|
||||
refer to the <a href="http://www.aspectj.org/">AspectJ</a>
|
||||
web site for more information on Aspect-Oriented
|
||||
Programming.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.compilerargs</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Provides arguments to a compiler when <code>maven.compile.fork</code>
|
||||
is set to true
|
||||
</p>
|
||||
<p>
|
||||
Corresponds to the nested <code>compilerarg</code> element for the ant
|
||||
<a href="http://jakarta.apache.org/ant/manual/CoreTasks/javac.html">javac</a>
|
||||
task.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.debug</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies wether to include debugging information in the compiled
|
||||
class files; the default value is <code>on</code>.
|
||||
Used by the "java:compile" goal.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.deprecation</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies wether source should be compiled with deprecation
|
||||
information; the default value is <code>off</code>.
|
||||
Used by the "java:compile" goal.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.encoding</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Sets the encoding of the .java files being compiled
|
||||
</p>
|
||||
<p>
|
||||
Corresponds to the <code>encoding</code> attribute for the ant
|
||||
<a href="http://jakarta.apache.org/ant/manual/CoreTasks/javac.html">javac</a>
|
||||
task.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.executable</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Names the program to be invoked as the java compiler
|
||||
</p>
|
||||
<p>
|
||||
Corresponds to the <code>executable</code> attribute for the ant
|
||||
<a href="http://jakarta.apache.org/ant/manual/CoreTasks/javac.html">javac</a>
|
||||
task.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.fork</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Runs the compiler in a separate process
|
||||
</p>
|
||||
<p>
|
||||
Corresponds to the <code>fork</code> attribute for the ant
|
||||
<a href="http://jakarta.apache.org/ant/manual/CoreTasks/javac.html">javac</a>
|
||||
task.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.optimize</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies whether source should be compiled with optimization; the
|
||||
default value is <code>off</code>.
|
||||
Used by the "java:compile" goal.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.source</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Provide source compatibility with a specific release
|
||||
</p>
|
||||
<p>
|
||||
Corresponds to the <code>source</code> attribute for the ant
|
||||
<a href="http://jakarta.apache.org/ant/manual/CoreTasks/javac.html">javac</a>
|
||||
task.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.src.set</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The source directories maven uses to compile java code.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.compile.target</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Generate class files for a specific JVM version
|
||||
</p>
|
||||
<p>
|
||||
Corresponds to the <code>target</code> attribute for the ant
|
||||
<a href="http://jakarta.apache.org/ant/manual/CoreTasks/javac.html">javac</a>
|
||||
task.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pom.build.sourceModifications</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
This property is the list of the
|
||||
<source><![CDATA[
|
||||
<build>
|
||||
<sourceModification>
|
||||
<sourceModification>
|
||||
<className></className>
|
||||
<excludes>
|
||||
<exclude></exclude>
|
||||
</excludes>
|
||||
</sourceModification>
|
||||
</sourceModification>
|
||||
</build>
|
||||
]]></source>
|
||||
source modifications in your
|
||||
<a href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html">
|
||||
project descriptor</a>. This property is used during compilation to exclude or
|
||||
include classes from compilation depending on whether a named class is available
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
<section name="Jar Settings">
|
||||
<table>
|
||||
<tr>
|
||||
<td>maven.has.jar.resource.patterns</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
This is a calculated property based on the value of the
|
||||
<source><![CDATA[
|
||||
<build>
|
||||
<resources>
|
||||
</resources>
|
||||
</build>
|
||||
]]></source>
|
||||
section of your
|
||||
<a href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html">
|
||||
project descriptor</a>. If there are <code>includes</code> or <code>excludes</code>
|
||||
elements, this property will be set to true
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.jar.excludes</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies a list of patterns to exclude from the jar process.
|
||||
The default value is <code>**/package.html</code>, and is used
|
||||
by the "java:jar" goal.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.jar.manifest</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies the manifest to be used in the creation of a jar.
|
||||
This file is 'merged' with the default manifest created by
|
||||
Maven. Any values specified in the file referenced by this
|
||||
property will override Maven's defaults.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.jarResources.basedir</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The base directory from which resources to be included in a jar can be found.
|
||||
Defaults to the base directory of the project.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.jar.resources.set</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
This is the Ant <code>patternset</code> of all the <code>include</code>s and
|
||||
<code>exclude</code>s from the
|
||||
<source><![CDATA[
|
||||
<build>
|
||||
<resources>
|
||||
</resources>
|
||||
</build>
|
||||
]]></source>
|
||||
section of your
|
||||
<a href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html">
|
||||
project descriptor</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
<section name="Deploy Settings">
|
||||
<table>
|
||||
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td>maven.repo.central</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Central repository for maven artifacts
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.repo.central.directory</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Directory to deploy jars into on the remote repository
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.repo.local</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The local repository to store maven artifacts, including jar file
|
||||
dependencies
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.username</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
This is the user name used to log in to the remote repository
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
<section name="Other Settings">
|
||||
<table>
|
||||
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td>maven.build.dest</td>
|
||||
<td>Yes</td>
|
||||
<td>The directory for compiled classes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.build.dir</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Used by the <code>java:jar</code> goal for
|
||||
<ul>
|
||||
<li>a temporary manifest file, if one is not specified</li>
|
||||
<li>the assembled jar file</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.dependency.classpath</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
This property holds the Ant <code>path</code> of all the dependent jar
|
||||
files listed in the <code>dependencies</code> block of your
|
||||
<a href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html">
|
||||
project descriptor</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.final.name</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Usually this property is set to <code>${project.id}-${project.currentVersion}</code>
|
||||
but the snapshot goal overwrites it to be the snapshot signature
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>user.name</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Used by the <code>java:jar</code> goal as the default value of the
|
||||
<code>Built-By</code> attribute of the manifest if one is not specified.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
Reference in New Issue
Block a user