Update/Refactor documentation
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@481133 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier
parent
14d371108c
commit
198d9404c2
@ -24,6 +24,7 @@
|
|||||||
</properties>
|
</properties>
|
||||||
<body>
|
<body>
|
||||||
<release version="1.11.1-SNAPSHOT" date="In SVN">
|
<release version="1.11.1-SNAPSHOT" date="In SVN">
|
||||||
|
<action dev="aheritier" type="add" issues="MPECLIPSE-127">Add basic support (jar,war) for WTP 1.5</action>
|
||||||
<action dev="aheritier" type="fix">WTP configuration : tld dependencies weren't deployed in ${maven.war.tld.dir} but in WEB-INF/lib</action>
|
<action dev="aheritier" type="fix">WTP configuration : tld dependencies weren't deployed in ${maven.war.tld.dir} but in WEB-INF/lib</action>
|
||||||
<action dev="aheritier" type="add">New goal eclipse:multiclean</action>
|
<action dev="aheritier" type="add">New goal eclipse:multiclean</action>
|
||||||
<action dev="aheritier" type="add">New goal eclipse:multiproject</action>
|
<action dev="aheritier" type="add">New goal eclipse:multiproject</action>
|
||||||
|
|||||||
@ -1,98 +1,122 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<!--
|
<!--
|
||||||
/*
|
/*
|
||||||
* Copyright 2001-2004 The Apache Software Foundation.
|
* Copyright 2001-2006 The Apache Software Foundation.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
* You may obtain a copy of the License at
|
* You may obtain a copy of the License at
|
||||||
*
|
*
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
*
|
*
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
* See the License for the specific language governing permissions and
|
* See the License for the specific language governing permissions and
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<faqs title="Frequently Asked Questions">
|
<faqs title="FAQs">
|
||||||
|
|
||||||
<part id="general">
|
<part id="general">
|
||||||
<title>General</title>
|
<title>General</title>
|
||||||
|
|
||||||
<faq id="junit">
|
<faq id="junit">
|
||||||
<question>
|
<question>I can't seem to get JUnit to show up in the classpath. What gives?</question>
|
||||||
I can't seem to get JUnit to show up in the classpath. What gives?
|
|
||||||
</question>
|
|
||||||
<answer>
|
<answer>
|
||||||
<p>
|
<p>You must have some unit tests for your project, otherwise JUnit is ignored.</p>
|
||||||
You must have some unit tests for your project, otherwise JUnit
|
</answer>
|
||||||
is ignored.
|
</faq>
|
||||||
</p>
|
|
||||||
|
<faq id="project dependencies">
|
||||||
|
<question>How can I define dependencies as eclipse projects ?</question>
|
||||||
|
<answer>
|
||||||
|
<p>The dependencies defined in the POM don't need to be jars strictly. They can be projects in the eclipse workspace. If a dependency is an eclipse project a property needs to be added to that dependency to indicate so.</p>
|
||||||
|
<source>
|
||||||
|
<![CDATA[
|
||||||
|
<dependency>
|
||||||
|
<groupId>group</groupId>
|
||||||
|
<artifactId>artifact</artifactId>
|
||||||
|
<version>version</version>
|
||||||
|
<properties>
|
||||||
|
<eclipse.dependency>true</eclipse.dependency>
|
||||||
|
</properties>
|
||||||
|
</dependency>
|
||||||
|
]]>
|
||||||
|
</source>
|
||||||
|
<p>This indicates that the dependency is another project in the workspace. Note that the name of the referenced project is the artifactId.</p>
|
||||||
|
<p>The inverse also works. If you have included extra jars that shouldn't be in the eclipse classpath then you can set <code>eclipse.dependency=false</code></p>
|
||||||
|
</answer>
|
||||||
|
</faq>
|
||||||
|
</part>
|
||||||
|
|
||||||
|
<part id="source">
|
||||||
|
<title>Source Code Integration w/ Eclipse</title>
|
||||||
|
|
||||||
|
<faq id="source-dep">
|
||||||
|
<question>How can I attach source code to libraries defined in dependencies ?</question>
|
||||||
|
<answer>
|
||||||
|
<p>Frequently you will want to include for compiled jars the source .java files to help with debugging.</p>
|
||||||
|
<p>The plugin is able to download sources archive at <code>${groupId}/java-sources/${artifactId}-${version}-sources.jar</code> from the repository. This behavior can be disabled by configuring the <code>maven.eclipse.src.download</code> property. As an example, the source archive for the dependency <code>MAVEN_REPO/eclipse/<em>jars</em>/eclipse-ui-3.0.0<em>.jar</em></code> will be mapped to <code>MAVEN_REPO/eclipse/<em>java-sources</em>/eclipse-ui-3.0.0<em>-sources.jar</em></code> </p>
|
||||||
|
<p>For backward compatibility the plugin still accepts source archives located at <code>MAVEN_REPO/${groupId}/src/${artifactId}-${version}.${maven.eclipse.src.extension}</code> but it won't download them from the repository. </p>
|
||||||
|
</answer>
|
||||||
|
</faq>
|
||||||
|
|
||||||
|
<faq id="generated-sources">
|
||||||
|
<question>How must I setup generated source code ?</question>
|
||||||
|
<answer>
|
||||||
|
<p>When Eclipse is not generating source code for you there is a conflict between Maven generating the source code and then Eclipse treating it as compiled code. Typically when generating code using Maven the code ends up in the target/classes directory. This is fine as long as Maven is doing the build. However, if Eclipse is then setup to do the build, when Eclipse performs a clean build all the generated code in target/classes will be removed.</p>
|
||||||
|
<p>The alternatives typically are to place the generated code in the /src/java directory and allow Maven and Eclipse to treat it the same. However, this leads to a tendency to check generated code into source control, which typically is not appropriate for generated code. Alternatively, it can be placed in some sort of /src/generated or target/generated directory. In Maven2, generated code lives in target/generated-sources, in a manner similiar to generated xdoc's live in target/generated-xdocs. Within the target/generated-sources would be each type of generated code.</p>
|
||||||
|
<p>By default, the plugin will load as seperate source folders any directory found in <code>${maven.build.dir}/generated-sources</code>. So, if you generate your mock objects into <code>${maven.build.dir}/generated-sources/mocks</code> and your wsdl classes into <code>${maven.build.dir}/generated-sources/wsdl</code> then each of these directories will be mounted as source folders. Note: You must have already created these directories, otherwise the plugin won't know to add them as source folders. Before running <code>maven eclipse</code> just ensure you have already generated all of your source code.</p>
|
||||||
|
<p>For example, if you used the XDoclet Plugin for Maven to generate Hibernate mapping files, they would be placed in <code>/target/generated-sources/xdoclet/</code>. While, if you used the Hibernate Plugin for Maven to generate the SQL scripts for generating a database then that would be placed in <code>/target/generated-sources/schema/</code>.<br />Settings in project.properties:</p>
|
||||||
|
<source>
|
||||||
|
maven.xdoclet.hibernatedoclet.destDir=${maven.build.dir}/generated-sources/xdoclet
|
||||||
|
maven.hibernate.output.dir=${maven.build.dir}/generated-sources/schema
|
||||||
|
</source>
|
||||||
</answer>
|
</answer>
|
||||||
</faq>
|
</faq>
|
||||||
|
|
||||||
</part>
|
</part>
|
||||||
|
|
||||||
<part id="project-organization">
|
<part id="eclipse-multiproject">
|
||||||
<faq id="eclipse-multiproject">
|
<title>Multiproject support</title>
|
||||||
<question>
|
<faq id="hierarchical">
|
||||||
Eclipse doesn't support hierarchical project structure. How am i supposed to organize my multiproject ?
|
<question>Eclipse doesn't support hierarchical project structure. How am i supposed to organize my multiproject ?</question>
|
||||||
</question>
|
|
||||||
<answer>
|
<answer>
|
||||||
<p>
|
<p>If you use Eclipse, you may already have encountered the Infamous Layout Issue: Eclipse doesn't handle (yet ?) overlapping projects. Thus if you work in a multiproject context with a classical non flat layout, Eclipse integration becomes quite problematic. You surely don't want to use one big Eclipse project because you'll then lose visibility on dependencies (inter-project dependencies as well as library dependencies) and this will quickly become quite hard to manage - and promotes cycles.</p>
|
||||||
If you use Eclipse, you may already have encountered the Infamous Layout Issue:
|
<p>Best solution found so far is to refactor your project structure to rather use a flat layout, as described below:</p>
|
||||||
Eclipse doesn't handle (yet ?) overlapping projects. Thus if you work in a
|
<source>
|
||||||
multiproject context with a classical non flat layout, Eclipse integration becomes
|
<pre>
|
||||||
quite problematic. You surely don't want to use one big Eclipse project because
|
|
||||||
you'll then lose visibility on dependencies (inter-project dependencies as well
|
|
||||||
as library dependencies) and this will quickly become quite hard to manage - and
|
|
||||||
promotes cycles.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
Best solution found so far is to refactor your project structure to rather
|
|
||||||
use a flat layout, as described below:
|
|
||||||
<source>
|
|
||||||
<pre>
|
|
||||||
/project-root | /project-root
|
/project-root | /project-root
|
||||||
+- subproject1 | +- project.xml
|
+- subproject1 | +- project.xml
|
||||||
+- project.xml ===> /subproject1
|
+- project.xml ===> /subproject1
|
||||||
+- subproject2 | +- project.xml
|
+- subproject2 | +- project.xml
|
||||||
+- project.xml | /subproject2
|
+- project.xml | /subproject2
|
||||||
+- project.xml | +- project.xml
|
+- project.xml | +- project.xml
|
||||||
|
</pre>
|
||||||
</pre>
|
</source>
|
||||||
</source>
|
<p>And alter your properties in a similar way than the example below:</p>
|
||||||
</p>
|
<source>
|
||||||
<p>
|
maven.multiproject.basedir=${basedir}/..
|
||||||
And alter your properties in a similar way than the example below:
|
maven.multiproject.includes=*/project.xml
|
||||||
<source>
|
maven.multiproject.excludes=project-root/project.xml
|
||||||
maven.multiproject.basedir=${basedir}/..
|
</source>
|
||||||
maven.multiproject.includes=*/project.xml
|
<p>If you really can't (or don't want to) flatten your layout, the only solutions that are offered to you are a few tricks, each with its own drawback.</p>
|
||||||
maven.multiproject.excludes=project-root/project.xml
|
<ul>
|
||||||
</source>
|
<li>
|
||||||
</p>
|
Edit root files outside Eclipse - almost safe but implies switching between tools. Note that initial
|
||||||
<p>
|
checkout must be done through command line in this case, because parent project shouldn't be in the
|
||||||
If you really can't (or don't want to) flatten your layout, the only solutions that are offered to you are a few tricks, each with its own drawback.
|
workspace folder.
|
||||||
<ul>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Edit root files outside Eclipse - almost safe but implies switching between tools.
|
Create a virtual project which contains links to root files - doesn't support refactoring well, and
|
||||||
Note that initial checkout must be done through command line in this case, because
|
implies identical paths on every developer machines.
|
||||||
parent project shouldn't be in the workspace folder.
|
</li>
|
||||||
</li>
|
</ul>
|
||||||
<li>
|
<p><i>Use those tricks at your own risk</i></p>
|
||||||
Create a virtual project which contains links to root files - doesn't
|
<p>if this issue really annoys you, then please vote for <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=35973">https://bugs.eclipse.org/bugs/show_bug.cgi?id=35973</a></p>
|
||||||
support refactoring well, and implies identical paths on every developer machines.
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<i>Use those tricks at your own risk</i>
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
if this issue really annoys you, then please vote for <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=35973">https://bugs.eclipse.org/bugs/show_bug.cgi?id=35973</a>
|
|
||||||
</p>
|
|
||||||
</answer>
|
</answer>
|
||||||
</faq>
|
</faq>
|
||||||
</part>
|
</part>
|
||||||
</faqs>
|
</faqs>
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
<!--
|
<!--
|
||||||
/*
|
/*
|
||||||
* Copyright 2001-2004 The Apache Software Foundation.
|
* Copyright 2001-2006 The Apache Software Foundation.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
@ -20,7 +20,7 @@
|
|||||||
<document>
|
<document>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<title>Eclipse Plugin Goals</title>
|
<title>Plugin Goals</title>
|
||||||
<author email="dion@apache.org">dIon Gillard</author>
|
<author email="dion@apache.org">dIon Gillard</author>
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
|
|||||||
@ -1,26 +1,26 @@
|
|||||||
<?xml version="1.0"?>
|
<?xml version="1.0"?>
|
||||||
<!--
|
<!--
|
||||||
/*
|
/*
|
||||||
* Copyright 2001-2004 The Apache Software Foundation.
|
* Copyright 2001-2006 The Apache Software Foundation.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
* You may obtain a copy of the License at
|
* You may obtain a copy of the License at
|
||||||
*
|
*
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
*
|
*
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
* See the License for the specific language governing permissions and
|
* See the License for the specific language governing permissions and
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<document>
|
<document>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<title>Maven Eclipse Plugin</title>
|
<title>About</title>
|
||||||
<author email="vmassol@octo.com">Vincent Massol</author>
|
<author email="vmassol@octo.com">Vincent Massol</author>
|
||||||
<author email="dion@apache.org">dIon Gillard</author>
|
<author email="dion@apache.org">dIon Gillard</author>
|
||||||
</properties>
|
</properties>
|
||||||
@ -28,104 +28,24 @@
|
|||||||
<body>
|
<body>
|
||||||
<section name="Maven Eclipse Plugin">
|
<section name="Maven Eclipse Plugin">
|
||||||
<p>
|
<p>
|
||||||
This plug-in provides the ability to generate Eclipse project files
|
This plug-in provides the ability to generate Eclipse project files (
|
||||||
(<code>.classpath</code> and <code>.project</code> files), as well as
|
<code>.classpath</code>
|
||||||
configure Eclipse to use Maven as an <i>External Tool</i>.
|
and
|
||||||
|
<code>.project</code>
|
||||||
|
files), as well as configure Eclipse to use Maven as an
|
||||||
|
<i>External Tool</i>
|
||||||
|
.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
For more information on the functionality provided by this plugin,
|
For more information on the functionality provided by this plugin, please see the
|
||||||
please see the <a href="goals.html">Goals</a> document.
|
<a href="goals.html">Goals</a>
|
||||||
|
document.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
For more information on how to customise the functionality provided
|
For more information on how to customise the functionality provided by this plugin, please see the
|
||||||
by this plugin, please see the <a href="properties.html">properties</a>
|
<a href="properties.html">properties</a>
|
||||||
document.
|
document.
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
</body>
|
||||||
<section name="Defining dependencies as eclipse projects">
|
|
||||||
<p>
|
|
||||||
The dependencies defined in the POM need not to be jars strictly. They can
|
|
||||||
be projects in the eclipse workspace. If a dependency is an eclipse project
|
|
||||||
a property needs to be added to that dependency to indicate so.
|
|
||||||
</p>
|
|
||||||
<source><![CDATA[
|
|
||||||
<dependency>
|
|
||||||
<groupId>group</groupId>
|
|
||||||
<artifactId>artifact</artifactId>
|
|
||||||
<version>version</version>
|
|
||||||
<properties>
|
|
||||||
<eclipse.dependency>true</eclipse.dependency>
|
|
||||||
</properties>
|
|
||||||
</dependency>
|
|
||||||
]]></source>
|
|
||||||
<p>
|
|
||||||
This indicates that the dependency is another project in the workspace.
|
|
||||||
Note that the name of the referenced project is the artifactId.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
The inverse also works. If you have included extra jars that shouldn't be
|
|
||||||
in the eclipse classpath then you can set <code>eclipse.dependency=false</code>
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
<section name="Source Code Integration w/ Eclipse">
|
|
||||||
<subsection name="Artifact Sources">
|
|
||||||
<p>
|
|
||||||
Frequently you will want to include for compiled jars the source .java files to help
|
|
||||||
with debugging.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
The plugin is able to download sources archive at <code>${groupId}/java-sources/${artifactId}-${version}-sources.jar</code>
|
|
||||||
from the repository. This behavior can be disabled by configuring the <code>maven.eclipse.src.download</code> property.
|
|
||||||
As an example, the source archive for the dependency <code>MAVEN_REPO/eclipse/<em>jars</em>/eclipse-ui-3.0.0<em>.jar</em></code>
|
|
||||||
will be mapped to <code>MAVEN_REPO/eclipse/<em>java-sources</em>/eclipse-ui-3.0.0<em>-sources.jar</em></code>
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
For backward compatibility the plugin still accepts source archives located at
|
|
||||||
<code>MAVEN_REPO/${groupId}/src/${artifactId}-${version}.${maven.eclipse.src.extension}</code> but it won't
|
|
||||||
download them from the repository.
|
|
||||||
</p>
|
|
||||||
</subsection>
|
|
||||||
<subsection name="Generated Source Code">
|
|
||||||
<p>
|
|
||||||
When Eclipse is not generating source code for you there is a conflict between
|
|
||||||
Maven generating the source code and then Eclipse treating it as compiled code.
|
|
||||||
Typically when generating code using Maven the code ends up in the target/classes
|
|
||||||
directory. This is fine as long as Maven is doing the build. However, if Eclipse
|
|
||||||
is then setup to do the build, when Eclipse performs a clean build all the generated
|
|
||||||
code in target/classes will be removed.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
The alternatives typically are to place the generated code in the /src/java directory
|
|
||||||
and allow Maven and Eclipse to treat it the same. However, this leads to a tendency
|
|
||||||
to check generated code into source control, which typically is not appropriate for
|
|
||||||
generated code. Alternatively, it can be placed in some sort of /src/generated or
|
|
||||||
target/generated directory. In Maven2, generated code lives in target/generated-sources,
|
|
||||||
in a manner similiar to generated xdoc's live in target/generated-xdocs. Within the
|
|
||||||
target/generated-sources would be each type of generated code.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
By default, the plugin will load as seperate source folders any directory found in
|
|
||||||
<code>${maven.build.dir}/generated-sources</code>. So, if you generate your mock objects into
|
|
||||||
<code>${maven.build.dir}/generated-sources/mocks</code> and your wsdl classes into
|
|
||||||
<code>${maven.build.dir}/generated-sources/wsdl</code> then each of these directories will be mounted
|
|
||||||
as source folders. Note: You must have already created these directories, otherwise the
|
|
||||||
plugin won't know to add them as source folders. Before running <code>maven eclipse</code>
|
|
||||||
just ensure you have already generated all of your source code.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
For example, if you used the XDoclet Plugin for Maven to generate Hibernate mapping files,
|
|
||||||
they would be placed in <code>/target/generated-sources/xdoclet/</code>. While, if you used the
|
|
||||||
Hibernate Plugin for Maven to generate the SQL scripts for generating a database then that
|
|
||||||
would be placed in <code>/target/generated-sources/schema/</code>.
|
|
||||||
<br/>
|
|
||||||
Settings in project.properties:
|
|
||||||
</p>
|
|
||||||
<source>
|
|
||||||
maven.xdoclet.hibernatedoclet.destDir=${maven.build.dir}/generated-sources/xdoclet
|
|
||||||
maven.hibernate.output.dir=${maven.build.dir}/generated-sources/schema
|
|
||||||
</source>
|
|
||||||
</subsection>
|
|
||||||
</section>
|
|
||||||
</body>
|
|
||||||
</document>
|
</document>
|
||||||
|
|||||||
@ -1,38 +1,39 @@
|
|||||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
<!--
|
<!--
|
||||||
/*
|
/*
|
||||||
* Copyright 2001-2004 The Apache Software Foundation.
|
* Copyright 2001-2006 The Apache Software Foundation.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
* You may obtain a copy of the License at
|
* You may obtain a copy of the License at
|
||||||
*
|
*
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
*
|
*
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
* See the License for the specific language governing permissions and
|
* See the License for the specific language governing permissions and
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
-->
|
-->
|
||||||
<project name="Maven Eclipse Plugin">
|
<project name="Maven Eclipse Plugin">
|
||||||
<title>Maven Eclipse Plugin</title>
|
<title>Maven Eclipse Plugin</title>
|
||||||
<body>
|
<body>
|
||||||
<breadcrumbs>
|
<breadcrumbs>
|
||||||
<item name="Apache" href="http://www.apache.org"/>
|
<item name="Apache" href="http://www.apache.org" />
|
||||||
<item name="Maven" href="http://maven.apache.org/"/>
|
<item name="Maven" href="http://maven.apache.org/" />
|
||||||
<item name="Maven 1.x" href="http://maven.apache.org/maven-1.x/"/>
|
<item name="Maven 1.x" href="http://maven.apache.org/maven-1.x/" />
|
||||||
<item name="Plugins" href="http://maven.apache.org/maven-1.x/plugins/"/>
|
<item name="Plugins" href="http://maven.apache.org/maven-1.x/plugins/" />
|
||||||
<item name="Bundled" href="http://maven.apache.org/maven-1.x/plugins/bundled/"/>
|
<item name="Bundled" href="http://maven.apache.org/maven-1.x/plugins/bundled/" />
|
||||||
</breadcrumbs>
|
</breadcrumbs>
|
||||||
<links>
|
<links>
|
||||||
<item name="Eclipse" href="http://www.eclipse.org/"/>
|
<item name="Eclipse" href="http://www.eclipse.org/" />
|
||||||
</links>
|
</links>
|
||||||
<menu name="Overview">
|
<menu name="Maven 1.x Eclipse Plugin">
|
||||||
<item name="Goals" href="/goals.html"/>
|
<item name="About" href="/index.html" />
|
||||||
<item name="Properties" href="/properties.html"/>
|
<item name="Goals" href="/goals.html" />
|
||||||
<item name="FAQ" href="/faq.html"/>
|
<item name="Properties" href="/properties.html" />
|
||||||
|
<item name="FAQs" href="/faq.html"/>
|
||||||
</menu>
|
</menu>
|
||||||
</body>
|
</body>
|
||||||
</project>
|
</project>
|
||||||
|
|||||||
@ -1,49 +1,58 @@
|
|||||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
<!--
|
<!--
|
||||||
/*
|
/*
|
||||||
* Copyright 2001-2006 The Apache Software Foundation.
|
* Copyright 2001-2006 The Apache Software Foundation.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
* You may obtain a copy of the License at
|
* You may obtain a copy of the License at
|
||||||
*
|
*
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
*
|
*
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
* See the License for the specific language governing permissions and
|
* See the License for the specific language governing permissions and
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<document>
|
<document>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<title>Eclipse Properties</title>
|
<title>Plugin Properties</title>
|
||||||
<author email="vmassol@octo.com">Vincent Massol</author>
|
<author email="vmassol@octo.com">Vincent Massol</author>
|
||||||
<author email="dion@apache.org">dIon Gillard</author>
|
<author email="dion@apache.org">dIon Gillard</author>
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
<section name="Eclipse Settings">
|
<section name="Plugin Properties">
|
||||||
<table>
|
<table>
|
||||||
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
<tr>
|
||||||
|
<th>Property</th>
|
||||||
|
<th>Optional?</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.workspace</td>
|
<td>maven.eclipse.workspace</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
Location of the <a href="http://www.eclipse.org">Eclipse</a>
|
Location of the
|
||||||
|
<a href="http://www.eclipse.org">Eclipse</a>
|
||||||
workspace that holds your configuration and source.
|
workspace that holds your configuration and source.
|
||||||
<p>
|
<p>
|
||||||
On Windows, this will be the <code>workspace</code> directory
|
On Windows, this will be the
|
||||||
under your eclipse installation. For example, if you installed
|
<code>workspace</code>
|
||||||
eclipse into <code>c:\eclipse</code>, the workspace is
|
directory under your eclipse installation. For example, if you installed eclipse into
|
||||||
<code>c:\eclipse\workspace</code>.
|
<code>c:\eclipse</code>
|
||||||
|
, the workspace is
|
||||||
|
<code>c:\eclipse\workspace</code>
|
||||||
|
.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
If this parameter is specified, the <a href="goals.html#eclipse:external-tools">
|
If this parameter is specified, the
|
||||||
external-tools</a> goal will use it as the destination to copy the generated file.
|
<a href="goals.html#eclipse:external-tools">external-tools</a>
|
||||||
|
goal will use it as the destination to copy the generated file.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -52,13 +61,13 @@
|
|||||||
<td>Yes (default=plugins)</td>
|
<td>Yes (default=plugins)</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
Generate Eclipse external tools mappings for the specified goals.
|
Generate Eclipse external tools mappings for the specified goals. This accepts two values: 'all' for all
|
||||||
This accepts two values: 'all' for all the goals,
|
the goals, and 'plugins' to generate only the plugins' default goals.
|
||||||
and 'plugins' to generate only the plugins' default goals.
|
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
If this parameter is specified, the <a href="goals.html#eclipse:external-tools">
|
If this parameter is specified, the
|
||||||
external-tools</a> goal will use it as the destination to copy the generated file.
|
<a href="goals.html#eclipse:external-tools">external-tools</a>
|
||||||
|
goal will use it as the destination to copy the generated file.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -66,50 +75,47 @@
|
|||||||
<td>maven.eclipse.junit</td>
|
<td>maven.eclipse.junit</td>
|
||||||
<td>Yes (default=3.8.1)</td>
|
<td>Yes (default=3.8.1)</td>
|
||||||
<td>
|
<td>
|
||||||
The version of JUnit you want added to your project. If this
|
The version of JUnit you want added to your project. If this property is set to
|
||||||
property is set to <code>none</code> then JUnit will not be added to your
|
<code>none</code>
|
||||||
build classpath.
|
then JUnit will not be added to your build classpath.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.output.dir</td>
|
<td>maven.eclipse.output.dir</td>
|
||||||
<td>Yes (default=${maven.build.dest)</td>
|
<td>Yes (default=${maven.build.dest)</td>
|
||||||
<td>
|
<td>
|
||||||
The directory to which Eclipse should output its classes.
|
The directory to which Eclipse should output its classes. By default this is the same directory as Maven
|
||||||
By default this is the same directory as Maven generates its code
|
generates its code however this can be changed so that
|
||||||
however this can be changed so that <code>maven clean</code>
|
<code>maven clean</code>
|
||||||
does not interfere with Eclipse's build.
|
does not interfere with Eclipse's build.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.test.output.dir</td>
|
<td>maven.eclipse.test.output.dir</td>
|
||||||
<td>Yes (default=${maven.test.dest} defined in test plugin)</td>
|
<td>Yes (default=${maven.test.dest} defined in test plugin)</td>
|
||||||
<td>
|
<td>The directory to which Eclipse should output its test classes.</td>
|
||||||
The directory to which Eclipse should output its test classes.
|
|
||||||
</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.classpath.include</td>
|
<td>maven.eclipse.classpath.include</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
Comma delimited list of additional source directories to include in
|
Comma delimited list of additional source directories to include in the classpath, like
|
||||||
the classpath, like <code>src/conf</code>.
|
<code>src/conf</code>
|
||||||
|
.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.resources.addtoclasspath</td>
|
<td>maven.eclipse.resources.addtoclasspath</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
Specify whether to include the resources defined in the POM in the
|
Specify whether to include the resources defined in the POM in the Eclipse classpath. Defaults to false.
|
||||||
Eclipse classpath. Defaults to false.
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.conclasspath</td>
|
<td>maven.eclipse.conclasspath</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
Comma delimited list of additional kind "con" path
|
Comma delimited list of additional kind "con" path to include in the classpath description file like
|
||||||
to include in the classpath description file like
|
|
||||||
<code>org.eclipse.pde.core.requiredPlugins</code>
|
<code>org.eclipse.pde.core.requiredPlugins</code>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -117,17 +123,15 @@
|
|||||||
<td>maven.eclipse.buildcommands</td>
|
<td>maven.eclipse.buildcommands</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
Comma delimited list of additional build commands
|
Comma delimited list of additional build commands to include in the project description file. The java
|
||||||
to include in the project description file. The java builder will automatically be added if a java source
|
builder will automatically be added if a java source dir is set (if not already specified in the list).
|
||||||
dir is set (if not already specified in the list).
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.projectnatures</td>
|
<td>maven.eclipse.projectnatures</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
Comma delimited list of additional project natures
|
Comma delimited list of additional project natures to include in the project description file. These 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).
|
will be added after the java nature (if the java nature is not already specified in the list).
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -135,56 +139,69 @@
|
|||||||
<td>maven.eclipse.project.name</td>
|
<td>maven.eclipse.project.name</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
Name of the generated project on Eclipse.
|
Name of the generated project on Eclipse. Defaults to
|
||||||
Defaults to <code>${artifactId}</code>.
|
<code>${artifactId}</code>
|
||||||
|
.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.gen.src</td>
|
<td>maven.gen.src</td>
|
||||||
<td>Yes (default=${maven.build.dir}/generated-sources)</td>
|
<td>Yes (default=${maven.build.dir}/generated-sources)</td>
|
||||||
<td>
|
<td>
|
||||||
The directory that generated source code is placed. Maven will select
|
The directory that generated source code is placed. Maven will select any directories under this as source
|
||||||
any directories under this as source code. This prevents the generated
|
code. This prevents the generated source from being removed whenever Eclipse does a clean build, and allows
|
||||||
source from being removed whenever Eclipse does a clean build, and allows
|
|
||||||
the generated code to be clearly in the build directory.
|
the generated code to be clearly in the build directory.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.src.extension</td>
|
<td>maven.eclipse.src.extension</td>
|
||||||
<td>Yes (default=<code>zip</code>)</td>
|
|
||||||
<td>
|
<td>
|
||||||
The extension used for source attachments.
|
Yes (default=
|
||||||
Deprecated, source attachment are expected now at
|
<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>
|
<code>MAVEN_REPO${groupId}/java-sources/${artifactId}-${version}-sources.jar</code>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.src.download</td>
|
<td>maven.eclipse.src.download</td>
|
||||||
<td>Yes (default=<code>true</code>)</td>
|
|
||||||
<td>
|
<td>
|
||||||
Specify if java sources archives need to be downloaded from the configured
|
Yes (default=
|
||||||
remote repositories. Defaults to true.
|
<code>true</code>
|
||||||
|
)
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Specify if java sources archives need to be downloaded from the configured remote repositories. Defaults to
|
||||||
|
true.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.javadoc.download</td>
|
<td>maven.eclipse.javadoc.download</td>
|
||||||
<td>Yes (default=<code>true</code>)</td>
|
|
||||||
<td>
|
<td>
|
||||||
Specify if javadocs archives need to be downloaded from the configured
|
Yes (default=
|
||||||
remote repositories, when no source archive is available. Defaults to true.
|
<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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<td>maven.eclipse.multiproject.basedir</td>
|
<td>maven.eclipse.multiproject.basedir</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
This is the base directory that the plugin will use when searching for
|
This is the base directory that the plugin will use when searching for projects to be processed. It is
|
||||||
projects to be processed. It is also the 'current directory' for relative paths
|
also the 'current directory' for relative paths
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
Default value is <code>${maven.multiproject.basedir}</code>.
|
Default value is
|
||||||
|
<code>${maven.multiproject.basedir}</code>
|
||||||
|
.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -192,12 +209,11 @@
|
|||||||
<td>maven.eclipse.multiproject.ignoreFailures</td>
|
<td>maven.eclipse.multiproject.ignoreFailures</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
|
<p>Set this to true to allow the plugin to continue when any project fails during processing.</p>
|
||||||
<p>
|
<p>
|
||||||
Set this to true to allow the plugin to continue
|
Default value is
|
||||||
when any project fails during processing.
|
<code>${maven.multiproject.ignoreFailures}</code>
|
||||||
</p>
|
.
|
||||||
<p>
|
|
||||||
Default value is <code>${maven.multiproject.ignoreFailures}</code>.
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -206,15 +222,18 @@
|
|||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
This is the list of file specifications to be included when searching for
|
This is the list of file specifications to be included when searching for projects to be processed by the
|
||||||
projects to be processed by the plugin.
|
plugin.
|
||||||
</p>
|
</p>
|
||||||
<strong>
|
<strong>
|
||||||
The 'top-level' project that you use to run <code>maven eclipse:multiproject</code>
|
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.
|
must not be included in the set of projects to be processed.
|
||||||
</strong>
|
</strong>
|
||||||
<p>
|
<p>
|
||||||
Default value is <code>${maven.multiproject.includes}</code>.
|
Default value is
|
||||||
|
<code>${maven.multiproject.includes}</code>
|
||||||
|
.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -223,19 +242,24 @@
|
|||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
This is the list of file specifications to be excluded when searching for
|
This is the list of file specifications to be excluded when searching for projects to be processed by the
|
||||||
projects to be processed by the plugin
|
plugin
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Default value is
|
||||||
|
<code>${maven.multiproject.excludes}</code>
|
||||||
|
.
|
||||||
</p>
|
</p>
|
||||||
<p>Default value is <code>${maven.multiproject.excludes}</code>.</p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<p>
|
<p>
|
||||||
Note that you will need to defined a <code>MAVEN_REPO</code> Java
|
Note that you will need to defined a
|
||||||
Classpath variable in Eclipse. This is done by selecting the Window
|
<code>MAVEN_REPO</code>
|
||||||
menu, then Preferences. In the dialog box, select the Java node and
|
Java Classpath variable in Eclipse. This is done by selecting the Window menu, then Preferences. In the dialog
|
||||||
then Classpath Variables. Create a new variable named
|
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.
|
<code>MAVEN_REPO</code>
|
||||||
|
that points to your local Maven repository.
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user