maven-plugins/eclipse/xdocs/properties.xml
2006-12-01 02:43:49 +00:00

268 lines
9.2 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2006 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>Plugin Properties</title>
<author email="vmassol@octo.com">Vincent Massol</author>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name="Plugin Properties">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.eclipse.workspace</td>
<td>Yes</td>
<td>
Location of the
<a href="http://www.eclipse.org">Eclipse</a>
workspace that holds your configuration and source.
<p>
On Windows, this will be the
<code>workspace</code>
directory under your eclipse installation. For example, if you installed eclipse into
<code>c:\eclipse</code>
, the workspace is
<code>c:\eclipse\workspace</code>
.
</p>
<p>
If this parameter is specified, the
<a href="goals.html#eclipse:external-tools">external-tools</a>
goal will use it as the destination to copy the generated file.
</p>
</td>
</tr>
<tr>
<td>maven.eclipse.goals</td>
<td>Yes (default=plugins)</td>
<td>
<p>
Generate Eclipse external tools mappings for the specified goals. This accepts two values: 'all' for all
the goals, and 'plugins' to generate only the plugins' default goals.
</p>
<p>
If this parameter is specified, the
<a href="goals.html#eclipse:external-tools">external-tools</a>
goal will use it as the destination to copy the generated file.
</p>
</td>
</tr>
<tr>
<td>maven.eclipse.junit</td>
<td>Yes (default=3.8.1)</td>
<td>
The version of JUnit you want added to your project. If this property is set to
<code>none</code>
then JUnit will not be added to your build classpath.
</td>
</tr>
<tr>
<td>maven.eclipse.output.dir</td>
<td>Yes (default=${maven.build.dest)</td>
<td>
The directory to which Eclipse should output its classes. By default this is the same directory as Maven
generates its code however this can be changed so that
<code>maven clean</code>
does not interfere with Eclipse's build.
</td>
</tr>
<tr>
<td>maven.eclipse.test.output.dir</td>
<td>Yes (default=${maven.test.dest} defined in test plugin)</td>
<td>The directory to which Eclipse should output its test classes.</td>
</tr>
<tr>
<td>maven.eclipse.classpath.include</td>
<td>Yes</td>
<td>
Comma delimited list of additional source directories to include in the classpath, like
<code>src/conf</code>
.
</td>
</tr>
<tr>
<td>maven.eclipse.resources.addtoclasspath</td>
<td>Yes</td>
<td>
Specify whether to include the resources defined in the POM in the Eclipse classpath. Defaults to false.
</td>
</tr>
<tr>
<td>maven.eclipse.conclasspath</td>
<td>Yes</td>
<td>
Comma delimited list of additional kind "con" path to include in the classpath description file like
<code>org.eclipse.pde.core.requiredPlugins</code>
</td>
</tr>
<tr>
<td>maven.eclipse.buildcommands</td>
<td>Yes</td>
<td>
Comma delimited list of additional build commands to include in the project description file. The java
builder will automatically be added if a java source dir is set (if not already specified in the list).
</td>
</tr>
<tr>
<td>maven.eclipse.projectnatures</td>
<td>Yes</td>
<td>
Comma delimited list of additional project natures to include in the project description file. These natures
will be added after the java nature (if the java nature is not already specified in the list).
</td>
</tr>
<tr>
<td>maven.eclipse.project.name</td>
<td>Yes</td>
<td>
Name of the generated project on Eclipse. Defaults to
<code>${artifactId}</code>
.
</td>
</tr>
<tr>
<td>maven.gen.src</td>
<td>Yes (default=${maven.build.dir}/generated-sources)</td>
<td>
The directory that generated source code is placed. Maven will select any directories under this as source
code. This prevents the generated source from being removed whenever Eclipse does a clean build, and allows
the generated code to be clearly in the build directory.
</td>
</tr>
<tr>
<td>maven.eclipse.src.extension</td>
<td>
Yes (default=
<code>zip</code>
)
</td>
<td>
The extension used for source attachments. Deprecated, source attachment are expected now at
<code>MAVEN_REPO${groupId}/java-sources/${artifactId}-${version}-sources.jar</code>
</td>
</tr>
<tr>
<td>maven.eclipse.src.download</td>
<td>
Yes (default=
<code>true</code>
)
</td>
<td>
Specify if java sources archives need to be downloaded from the configured remote repositories. Defaults to
true.
</td>
</tr>
<tr>
<td>maven.eclipse.javadoc.download</td>
<td>
Yes (default=
<code>true</code>
)
</td>
<td>
Specify if javadocs archives need to be downloaded from the configured remote repositories, when no source
archive is available. Defaults to true.
</td>
</tr>
<tr>
<td>maven.eclipse.multiproject.basedir</td>
<td>Yes</td>
<td>
<p>
This is the base directory that the plugin will use when searching for projects to be processed. It is
also the 'current directory' for relative paths
</p>
<p>
Default value is
<code>${maven.multiproject.basedir}</code>
.
</p>
</td>
</tr>
<tr>
<td>maven.eclipse.multiproject.ignoreFailures</td>
<td>Yes</td>
<td>
<p>Set this to true to allow the plugin to continue when any project fails during processing.</p>
<p>
Default value is
<code>${maven.multiproject.ignoreFailures}</code>
.
</p>
</td>
</tr>
<tr>
<td>maven.eclipse.multiproject.includes</td>
<td>Yes</td>
<td>
<p>
This is the list of file specifications to be included when searching for projects to be processed by the
plugin.
</p>
<strong>
The 'top-level' project that you use to run
<code>maven eclipse:multiproject</code>
must not be included in the set of projects to be processed.
</strong>
<p>
Default value is
<code>${maven.multiproject.includes}</code>
.
</p>
</td>
</tr>
<tr>
<td>maven.eclipse.multiproject.excludes</td>
<td>Yes</td>
<td>
<p>
This is the list of file specifications to be excluded when searching for projects to be processed by the
plugin
</p>
<p>
Default value is
<code>${maven.multiproject.excludes}</code>
.
</p>
</td>
</tr>
</table>
<p>
Note that you will need to defined a
<code>MAVEN_REPO</code>
Java Classpath variable in Eclipse. This is done by selecting the Window menu, then Preferences. In the dialog
box, select the Java node and then Classpath Variables. Create a new variable named
<code>MAVEN_REPO</code>
that points to your local Maven repository.
</p>
</section>
</body>
</document>