2004-10-15 09:45:05 +00:00

132 lines
4.6 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 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>Eclipse Plugin Goals</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<goals>
<goal>
<name>eclipse</name>
<description>
The default goal. This goal simply executes the
<a href="#eclipse:generate-project">eclipse:generate-project</a> and
<a href="#eclipse:generate-classpath">eclipse:generate-classpath</a> goals.
</description>
</goal>
<goal>
<name>eclipse:clean</name>
<description>
Deletes the <code>.project</code> and <code>.classpath</code> files.
</description>
</goal>
<goal>
<name>eclipse:generate-project</name>
<description>
Generates a <code>.project</code> file for eclipse describing
the project and 'marking' it as a java project
</description>
</goal>
<goal>
<name>eclipse:generate-classpath</name>
<description>
Generates a <code>.classpath</code> file for the eclipse project
with classpath entries for
<ol>
<li>the build source directory</li>
<li>the build unit test source directory</li>
<li>the JRE being used</li>
<li>the appropriate version of JUnit</li>
<li>each Maven project <code>dependency</code></li>
<li>an output directory for compiled code:
<code>target\classes</code>
</li>
<li>any .zip source archives</li>
</ol>
</description>
</goal>
<goal>
<name>eclipse:external-tools</name>
<description>
<p>
Generates an external tool entry for each default goal available to
a Maven project into a file named <code>externaltools.xml</code>
</p>
<p>
If the <a href="properties.html">${maven.eclipse.workspace}</a>
property is set, the file is copied to the correct location within
that workspace
</p>
<p>
If the <a href="properties.html">${maven.eclipse.workspace}</a>
is <strong>not</strong> set, the file is created in the current
directory, and should be manually copied to
<source>
${eclipse workspace}/.metadata/.plugins/org.eclipse.ui.externaltools/externaltools.xml
</source>
</p>
</description>
</goal>
<goal>
<name>eclipse:external-tools-21</name>
<description>
<p>
Generates an external tool file for each default goal available to
a Maven project into the <code>${maven.build.dir}/eclipse/</code> directory
</p>
<p>
If the <a href="properties.html">${maven.eclipse.workspace}</a>
property is set, the file is copied to the correct location within
that workspace
</p>
<p>
If the <a href="properties.html">${maven.eclipse.workspace}</a>
is <strong>not</strong> set, the files should be manually copied to
<source>
${your eclipse workspace}/.metadata/.plugins/org.eclipse.debug.core/.launches/
</source>
</p>
</description>
</goal>
<a name="eclipse:add-maven-repo" />
<goal>
<name>eclipse:add-maven-repo</name>
<description>
Ensures that the classpath variable <code>MAVEN_REPO</code>
exists in the Eclipse environment.
<br />
The <a href="properties.html">${maven.eclipse.workspace}</a>
property <strong>must</strong> be set for this to succeed, and
Eclipse must not be running.
</description>
</goal>
</goals>
</body>
</document>