Author: epunzalan
Date: Mon Jul 17 05:09:03 2006
New Revision: 422694
URL: http://svn.apache.org/viewvc?rev=422694&view=rev
Log:
PR: MECLIPSE-64
- completed plugin docs
- added some examples
- added faqs
Added:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/attach-library-sources.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/prevent-module-references.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt
(contents, props changed)
- copied, changed from r421077,
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/overview.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/
maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml
Removed:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/overview.apt
Modified:
maven/plugins/trunk/maven-eclipse-plugin/pom.xml
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipseCleanMojo.java
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-eclipse-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/pom.xml?rev=422694&r1=422693&r2=422694&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-eclipse-plugin/pom.xml Mon Jul 17 05:09:03 2006
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>org.apache.maven.plugins</groupId>
@@ -10,6 +10,9 @@
<packaging>maven-plugin</packaging>
<name>Maven Eclipse Plugin</name>
<version>2.3-SNAPSHOT</version>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
<issueManagement>
<system>JIRA</system>
<url>http://jira.codehaus.org/browse/MECLIPSE</url>
Modified:
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipseCleanMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipseCleanMojo.java?rev=422694&r1=422693&r2=422694&view=diff
==============================================================================
---
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipseCleanMojo.java
(original)
+++
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipseCleanMojo.java
Mon Jul 17 05:09:03 2006
@@ -16,13 +16,13 @@
* limitations under the License.
*/
-import java.io.File;
-import java.io.IOException;
-
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.codehaus.plexus.util.FileUtils;
+import java.io.File;
+import java.io.IOException;
+
/**
* Deletes the .project, .classpath, .wtpmodules files and .settings folder
used by Eclipse.
*
@@ -76,6 +76,8 @@
private String packaging;
/**
+ * The root directory of the project
+ *
* @parameter expression="${basedir}"
*/
private File basedir;
Modified:
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java?rev=422694&r1=422693&r2=422694&view=diff
==============================================================================
---
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
(original)
+++
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
Mon Jul 17 05:09:03 2006
@@ -16,14 +16,6 @@
* limitations under the License.
*/
-import java.io.File;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Set;
-import java.util.TreeSet;
-
import org.apache.maven.artifact.handler.ArtifactHandler;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.MojoExecutionException;
@@ -40,6 +32,14 @@
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.StringUtils;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Set;
+import java.util.TreeSet;
+
/**
* Generates the following eclipse configuration files:
* <ul>
@@ -49,7 +49,7 @@
* valid version (WTP configuration is not generated by default)</li>
* </ul>
* If this goal is run on a multiproject root, dependencies between modules
will be configured as direct project
- * dependencies in Eclipse (unless <code>useProjectReferences</code> is set to
<code>false</code>)
+ * dependencies in Eclipse (unless <code>useProjectReferences</code> is set to
<code>false</code>).
*
* @author <a href="mailto:[EMAIL PROTECTED]">Trygve Laugstøl</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Fabrizio Giustina</a>
@@ -155,9 +155,9 @@
* container is added. Configuration example:
* <pre>
* <classpathContainers>
- *
<buildcommand>org.eclipse.jdt.launching.JRE_CONTAINER</buildcommand>
- *
<buildcommand>org.eclipse.jst.server.core.container/org.eclipse.jst.server.tomcat.runtimeTarget/Apache
Tomcat v5.5</buildcommand>
- *
<buildcommand>org.eclipse.jst.j2ee.internal.web.container/artifact</buildcommand>
+ *
<classpathContainer>org.eclipse.jdt.launching.JRE_CONTAINER</classpathContainer>
+ *
<classpathContainer>org.eclipse.jst.server.core.container/org.eclipse.jst.server.tomcat.runtimeTarget/Apache
Tomcat v5.5</classpathContainer>
+ *
<classpathContainer>org.eclipse.jst.j2ee.internal.web.container/artifact</classpathContainer>
* </classpathContainers>
* </pre>
*
@@ -166,8 +166,10 @@
private List classpathContainers;
/**
+ * Enables/disables the downloading of source attachments. Defaults to
false.
+ *
* @parameter expression="${eclipse.downloadSources}"
- * @deprecated use <code>downloadSources</code>
+ * @deprecated use downloadSources
*/
private boolean eclipseDownloadSources;
Added:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/attach-library-sources.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/attach-library-sources.apt?rev=422694&view=auto
==============================================================================
---
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/attach-library-sources.apt
(added)
+++
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/attach-library-sources.apt
Mon Jul 17 05:09:03 2006
@@ -0,0 +1,44 @@
+ ------
+ Attach Library Sources
+ ------
+ Edwin Punzalan
+ ------
+ 14 July 2006
+ ------
+
+
+Attach Library Sources
+
+ Artifacts with sources deployed can be attached to Eclipse libraries using
+ <<<downloadSources>>>. The sources of the libraries <must> exist in the
+ repository so that the plugin can download it and attach it.
+
+ The following example shows how to do this in the command-line:
+
++-----
+mvn eclipse:eclipse -DdownloadSources=true
++-----
+
+ or in your pom.xml:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-eclipse-plugin</artifactId>
+ <configuration>
+ <downloadSources>true</downloadSources>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
Added:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/prevent-module-references.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/prevent-module-references.apt?rev=422694&view=auto
==============================================================================
---
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/prevent-module-references.apt
(added)
+++
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/prevent-module-references.apt
Mon Jul 17 05:09:03 2006
@@ -0,0 +1,43 @@
+ ------
+ Prevent Project References
+ ------
+ Edwin Punzalan
+ ------
+ 14 July 2006
+ ------
+
+
+Prevent Project References
+
+ By default, the Eclipse Plugin will create sub-projects for dependencies that
+ exists in the reactor. If you don't want to work with the development code
+ and prefer to use the deployed packages, you can still do so by disabling the
+ project references like so:
+
++-----
+mvn eclipse:eclipse -Declipse.useProjectReferences=false
++-----
+
+ or in your pom.xml:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-eclipse-plugin</artifactId>
+ <configuration>
+ <eclipse.useProjectReferences>false</eclipse.useProjectReferences>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
Added:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt?rev=422694&view=auto
==============================================================================
---
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt
(added)
+++
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt
Mon Jul 17 05:09:03 2006
@@ -0,0 +1,75 @@
+ ------
+ Provide Build Commands
+ ------
+ Edwin Punzalan
+ ------
+ 14 July 2006
+ ------
+
+
+Provide Project Natures And Build Commands for Eclipse
+
+ The default project nature by projects created by the Eclipse Plugin is
+ <<<org.eclipse.jdt.core.javanature>>> and the default build command is
+ <<<org.eclipse.jdt.core.javabuilder>>>. Additional project natures and build
+ commands are also added as needed when WTP is enabled.
+
+ If you want to provide additional project natures and build commands for your
+ project, i.e. Spring project, you can add them in your pom.xml like:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-eclipse-plugin<artifactId>
+ <configuration>
+ <additionalProjectnatures>
+
<projectnature>org.springframework.ide.eclipse.core.springnature</projectnature>
+ </additionalProjectnatures>
+ <additionalBuildcommands>
+
<buildcommand>org.springframework.ide.eclipse.core.springbuilder</buildcommand>
+ </additionalBuildcommands>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
+
+ To provide your own project natures and build commands which will override
+ the defaults, you can put them in your pom.xml as follows:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-eclipse-plugin<artifactId>
+ <configuration>
+ <projectnatures>
+ <projectnature>my.own.project.nature</projectnature>
+ </projectnatures>
+ <buildcommands>
+ <buildcommand>my.own.build.command</buildcommand>
+ </buildcommands>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
Added: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt?rev=422694&view=auto
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt (added)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt Mon Jul 17
05:09:03 2006
@@ -0,0 +1,42 @@
+ ------
+ Introduction
+ ------
+ Edwin Punzalan
+ ------
+ 12 July 2006
+ ------
+
+
+Maven Eclipse Plugin
+
+ The Eclipse Plugin is used to generate Eclipse IDE files (*.classpath,
+ *.wtpmodules and the .settings folder) for use with a project.
+
+* Goals Overview
+
+ The Maven Eclipse Plugin has three goals:
+
+ * {{{add-maven-repo-mojo.html}eclipse:add-maven-repo}} is used to add the
+ classpath variable MAVEN_REPO to Eclipse which points to your local
+ repository.
+
+ * {{{clean-mojo.html}eclipse:clean}} is used to delete the files used by the
+ Eclipse IDE.
+
+ * {{{eclipse-mojo.html}eclipse:eclipse}} generates the eclipse configuration
+ files.
+
+* Usage
+
+ Instructions on how to use the Eclipse Plugin can be found
{{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding on some usages of the Eclipse
Plugin,
+ you can take a look into the following examples:
+
+ * {{{examples/prevent-module-references.html}Prevent Module References}}
+
+ * {{{examples/attach-library-sources.html}Attach Library Sources}}
+
+ * {{{examples/provide-project-natures-and-build-commands.html}Provide
Project Natures and Build Commands}}
Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt?rev=422694&r1=422693&r2=422694&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt (original)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt Mon Jul
17 05:09:03 2006
@@ -11,44 +11,45 @@
* Project layout
- Due to the workspace idea many eclipse users are used to a flat
-layout and therefore want to keep this structure.
- The following sample shows how to handle maven multiple module projects with
eclipse
-both with the standard maven hierachical project layout than with a flat
eclipse-like layout.
+ Due to the workspace idea many eclipse users are used to a flat layout and
+ therefore want to keep this structure. The following sample shows how to
+ handle maven multiple module projects with eclipse for both the standard
+ maven hierachical project layout and the flat eclipse-like layout.
** Hierachical project layout
- Supposing eclipse is your favorite SCM client, this step by step
-example shows how to set up a new mutiple module project.
+ Suppose eclipse is your favorite SCM client, this step by step example shows
+ how to set up a new mutiple module project.
- [[1]] Set up a new eclipse workspace called <step-by-step> and add
-the <M2_REPO> classpath variable.
+ [[1]] Set up a new eclipse workspace called <step-by-step> and add the
+ <M2_REPO> classpath variable.
- [[1]] Open the command line shell and change to the newly created workspace
directory.
+ [[1]] Open the command line shell and change to the newly created workspace
+ directory.
- [[1]] From the command line change to newly created <step-by-step>
-workspace and create a new maven project using the archetype plugin.
+ [[1]] From the command line change to newly created <step-by-step> workspace
+ and create a new maven project using the archetype plugin.
+----+
mvn archetype:create -DgroupId=guide.ide.eclipse -DartifactId=guide-ide-eclipse
+----+
[[1]] Create a new simple project <guide-ide-eclipse> inside the
-<step-by-step> workspace with eclipse (From the menu bar, select
-File >New >Project. Select Simple >Project). Eclipse will
-create a simple <.project>-file for your <guide-ide-eclipse>-project
-and you should be able to see the <pom.xml>-file.
+ <step-by-step> workspace with eclipse (From the menu bar, select File >New >
+ Project. Select Simple > Project). Eclipse will create a simple
+ <.project>-file for your <guide-ide-eclipse>-project and you should be able to
+ see the <pom.xml>-file.
- [[1]] Delete the <src>-folder and open the <pom.xml>-file to change
-the packaging of your parent project to <pom>
+ [[1]] Delete the <src>-folder and open the <pom.xml>-file to change the
+ packaging of your parent project to <pom>.
+----+
<packaging>pom</packaging>
+----+
[[1]] From the command line change to the <guide-ide-eclipse> project
-directory and create some modules.
+ directory and create some modules.
+----+
cd guide-ide-eclipse
@@ -87,17 +88,18 @@
</dependency>
+----+
- [[1]] Install the project in your local repository and generate the eclipse
files:
+ [[1]] Install the project in your local repository and generate the eclipse
+ files:
+----+
mvn install
mvn eclipse:eclipse
+----+
- [[1]] Check in your project using the eclipse team support (select
-from the context menu Team >Share Project). <Note:> Don not check
-in the generated eclipse files. If you use CVS you should have a
-<.cvsignore>-file with the following entries for each module:
+ [[1]] Check in your project using the eclipse team support (select from the
+ context menu Team > Share Project). <Note:> Do not check in the generated
+ eclipse files. If you use CVS you should have a <.cvsignore>-file with the
+ following entries for each module:
+----+
target
@@ -106,42 +108,41 @@
.wtpmodules
+----+
- Even the parent project should have this <.cvsignore>-file. Eclipse
-will automatically generate a new simple <.project>-file when you
-check out the project from the repository.
+ Even the parent project should have this <.cvsignore>-file. Eclipse will
+ automatically generate a new simple <.project>-file when you check out the
+ project from the repository.
[]
- From now on you have different options to proceed. If you are working
-on all modules simultanously and you rather have eclipse project
-dependencies than binary dependencies, you should set up a new workspace
-and import all projects form <step-by-step/guide-ide-eclipse>. Note,
-you have to delete the <.project>-file of your parent project
-before. The result is equals to checking out the whole project from
-the command line, running <mvn eclipse:eclipse> and finally importing
-the projects into your eclipse workspace. In both cases you will be
-able to synchronize your changes using eclipse.
-
- In case of large projects whith many people it can be quite tedious
-to check out all modules and keep them up to date. Especially if you
-are only interested in one or two modules. In this case using binary
-dependencies is much more comfortable. Just check out the modules you
-want to work on with eclipse and run <mvn eclipse:eclipse> for each
-module (see also {{{#Maven as an external tool}Maven as an external
-tool}}). Of course all referenced artifacts have to be available from
-your maven repository.
+ From now on you have different options to proceed. If you are working on all
+ modules simultanously and you'd rather have eclipse project dependencies than
+ binary dependencies, you should set up a new workspace and import all projects
+ from <step-by-step/guide-ide-eclipse>. Note, you have to delete the
+ <.project>-file of your parent project before. The result is the same as
+ checking out the whole project from the command line, running
+ <mvn eclipse:eclipse> and finally importing the projects into your eclipse
+ workspace. In both cases you will be able to synchronize your changes using
+ eclipse.
+
+ In case of large projects with many developers involved, it can be tedious to
+ check out all modules and keep them up to date. Especially if you are only
+ interested in one or two modules. In this case using binary dependencies is
+ much more comfortable. Just check out the modules you want to work on with
+ eclipse and run <mvn eclipse:eclipse> for each module (see also {{{#Maven as
+ an external tool}Maven as an external tool}}). Of course, all referenced
+ artifacts must be available from your maven repository.
** {Flat Project Layout}
- It is possible to move the parent POM in its own directory on the
-same level with the referenced modules.
+ It is possible to move the parent POM in its own directory on the same level
+ with the referenced modules, thus resulting to a Flat Project Layout.
Using a Flat Project Layout you can checkout and edit the parent POM without
-checking out the whole project.
+ checking out the whole project.
[[1]] Create a new directory under <guide-ide-eclipse> called
-<guide-ide-eclipse-project> and move the parent POM to it.
+ <guide-ide-eclipse-project> and move the parent POM to it.
[[1]] Change the module references in the parent POM to:
@@ -155,4 +156,4 @@
[]
<<Issue:>> The release plugin does not support the flat structure
-({{{http://jira.codehaus.org/browse/MRELEASE-6}MRELEASE-6}})
+({{{http://jira.codehaus.org/browse/MRELEASE-6}MRELEASE-6}}).
Copied: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt (from
r421077, maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/overview.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt?p2=maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt&p1=maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/overview.apt&r1=421077&r2=422694&rev=422694&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/overview.apt
(original)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt Mon Jul 17
05:09:03 2006
@@ -1,74 +1,68 @@
------
- Guide to using Eclipse with Maven 2.x
+ Usage
------
Bernd Mau, [EMAIL PROTECTED]
------
28 October 2005
------
-Guide to using Eclipse with Maven 2.x
+Maven Eclipse Plugin: Usage
- This mini guide explains howto use Maven 2 in Eclipse IDE.
+ This mini guide explains howto use Maven in Eclipse IDE.
- * {{{#Maven 2 repository}Maven 2 repository}}
+ * {{{#Maven repository}Maven repository}}
* {{{#Maven as an external tool}Maven as an external tool}}
* {{{#Simple Project}Simple Project}}
-* {Maven 2 repository}
+* {Maven repository}
- Eclipse needs to know the path to the local maven
-repository. Therefore the classpath variable <M2_REPO> has to be
-set. Execute the following command:
+ Eclipse needs to know the path to the local maven repository. Therefore the
+ classpath variable <M2_REPO> has to be set. Execute the following command:
+----+
-
-mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo
-
+mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo
+----+
- You can also define a new classpath variable inside eclipse: From the
-menu bar, select Window > Preferences. Select the Java > Build Path >
-Classpath Variables page.
+ You can also define a new classpath variable inside eclipse: From the menu
+ bar, select Window > Preferences. Select the Java > Build Path > Classpath
+ Variables page.
* {Maven as an external tool}
- You might want to execute some maven goals from inside eclipse. This
-is possible by configuring an external launcher.
+ You might want to execute some maven goals from inside eclipse. This is
+ possible by configuring an external launcher.
- It is best practice to prepare eclipse by adding a variable, which points to
your local
-maven excutable (mvn.bat/mvn).
+ It is best practice to prepare eclipse by adding a variable, which points to
+ your local maven excutable (mvn.bat/mvn).
- From the menu bar, select Window > Preferences.
- Select the Run/Debug > String Substitution. Add a new variable e.g.
<maven_exec>.
+ From the menu bar, select Window > Preferences. Select the Run/Debug > String
+ Substitution. Add a new variable e.g. <maven_exec>.
- When you set up a new external launcher (from the menu bar, select Run >
External Tools. Select Program) you
-can refer to <maven_exec> in the location field.
+ When you set up a new external launcher (from the menu bar, select Run >
+ External Tools. Select Program) you can refer to <maven_exec> in the location
+ field.
- Furhtermore refer to <project_loc> as the working directory and specify the
maven goals of
-your choice as arguments, e.g. <eclipse:eclipse>.
+ Furthermore refer to <project_loc> as the working directory and specify the
+ maven goals of your choice as arguments, e.g. <eclipse:eclipse>.
For further information please refer to the eclipse help.
* {Simple Project}
- If you have a simple java project which is made up of only one
-module, using eclipse is very simple. To generate the eclipse project
-files from your POM you execute the following command:
+ If you have a simple java project which is made up of only one module, using
+ eclipse is very simple. To generate the eclipse project files from your POM
+ you execute the following command:
+----+
-
mvn eclipse:eclipse
-
+----+
- If you have created or checked out the project with eclipse, you only
-have to refresh the project in your workspace. Otherwise you have to
-import the project into your eclipse workspace (From the menu bar,
-select File >Import >Existing Projects into Workspace). In the
-latter case the project (directory) should not be located in your
-workspace, because eclipse might come into trouble, especially if you
-want to use eclipse as the scm client.
-
+ If you have created or checked out the project with eclipse, you only have to
+ refresh the project in your workspace. Otherwise you have to import the
+ project into your eclipse workspace (From the menu bar, select File > Import >
+ Existing Projects into Workspace). In the latter case the project (directory)
+ should not be located in your workspace, because eclipse might come into
+ trouble, especially if you want to use eclipse as the scm client.
\ No newline at end of file
Propchange: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt?rev=422694&r1=422693&r2=422694&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt (original)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt Mon Jul 17
05:09:03 2006
@@ -8,31 +8,37 @@
WTP support
- The eclipse plugin supports creating configurations for eclipse WTP (Web
Tools Project).
- Projects with a WAR packaging are setup as WTP dynamic web projects and
runtime dependencies are configured to be used
- when running them using eclipse internal servers.
+ The eclipse plugin supports creating configurations for eclipse WTP (Web Tools
+ Project). Projects with a WAR packaging can be setup as WTP dynamic web
+ projects and runtime dependencies are configured to be used when running them
+ using eclipse internal servers.
* WTP 1.0 warning
- Unfortunately WTP 1.0 has been shipped bug which prevents external
dependencies from work.
+ Unfortunately WTP 1.0 has been shipped with a bug which prevents external
+ dependencies from working.
- <<This means that only project-dependencies (in a multi-module build) will
work, but any other dependency in the POM
- will be ignored when running the web application inside eclipse>>
+ <<This means that only project-dependencies (in a multi-module build) will
+ work, but any other dependency in the POM will be ignored when running the web
+ application inside eclipse.>>
- This bug has been fixed in release 1.0.1, so if you are still using WTP 1.0
be sure to update it to the 1.0.1 (or newer)
- release.
+ This bug has been fixed in release 1.0.1, so if you are still using WTP 1.0 be
+ sure to update it to the 1.0.1 (or newer) release.
- You can download a working copy of WTP from
{{{http://download.eclipse.org/webtools/downloads/}http://download.eclipse.org/webtools/downloads/}}
+ You can download a working copy of WTP
+ {{{http://download.eclipse.org/webtools/downloads/}here}}
* WTP versions
- In order to create a configuration for WTP you <always> need to specify the
version of WTP you are using.
+ In order to create a configuration for WTP you have to specify the version of
+ WTP you are using.
- The plugin actually supports creating WTP R7 and 1.0 configuration files (and
WTP 1.5 builds, since configuration files
- are not changed after 1.0)
+ The plugin actually supports creating WTP R7 and 1.0 configuration files (and
+ WTP 1.5 builds, since configuration files are not changed after 1.0).
- Note that R7/1.0 configuration files are totally different, so be sure to
check the version you are using.
+ Note that R7/1.0 configuration files are totally different, so be sure to
+ check the version you are using.
In order to generate WTP configuration files simply run:
@@ -40,15 +46,9 @@
mvn -Dwtpversion=R7 eclipse:eclipse
+-----------------------------------------------------+
- Where wtpversion can be <<<R7>>>, <<<1.0>>> or <<<none>>> (default)
+ Where wtpversion can be <<<R7>>>, <<<1.0>>> or <<<none>>> (default).
- <Note that in the 2.0 version of the plugin the default was R7 and WTP
configuration was always generated. Now that
- different incompatible versions are out the default is to not to generate WTP
configuration if the user doesn't specify
- the desired version>
-
-
-
-
-
-
-
\ No newline at end of file
+ <Note that in the 2.0 version of the plugin the default was R7 and WTP
+ configuration was always generated. Now that different incompatible versions
+ are out the default is to not to generate WTP configuration if the user
+ doesn't specify the desired version.>
Added: maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml?rev=422694&view=auto
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml Mon Jul 17
05:09:03 2006
@@ -0,0 +1,45 @@
+<?xml version="1.0"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="eclipse-plugin">
+ <question>Is this the Eclipse Plugin that allows me to run maven commands
from within Eclipse IDE?</question>
+ <answer>
+ <p>No. This is a maven plugin to generate eclipse files for a maven
project. This is not an Eclipse Plugin for Maven.</p>
+ </answer>
+ </faq>
+ <faq id="import-project">
+ <question>I already did <i>mvn eclipse:eclipse</i> but when I open
Eclipse, my project is not there. Where is it?</question>
+ <answer>
+ <p>You may also need to import the project created by Maven Eclipse
Plugin. More information can be found <a href="usage.html#Simple
Project">here</a>.</p>
+ </answer>
+ </faq>
+ <faq id="use-add-maven-repo">
+ <question>After runnning <i>mvn eclipse:eclipse</i>, the generated
dependencies are pointing to a non-existing file. What needs to be
done?</question>
+ <answer>
+ <p>Before you can setup any maven project to your eclipse IDE, you need
to define first the location of your local repository to Eclipse. This is done
by using:</p><pre>eclipse:add-maven-repo</pre>
+ </answer>
+ </faq>
+ <faq id="import-javadoc">
+ <question>Can I make the eclipse plugin to download and attach javadocs
to my libraries?</question>
+ <answer>
+ <p>Quoting what Fabrizio said in the mailing list...</p>
+ <i>
+ <p>"The current revision in svn of the eclipse plugin (which is expected
+ to be released as soon as an usable wtp 1.0.1 build will be out) has
+ support for javadoc attachments, as an alternative to source jars."</p>
+
+ <p>"When using the downloadSources flag if a source jar is not found the
+ plugin will look for a javadoc jar. This is expecially useful for non
+ open source projects and when used with eclipse 3.2 (in eclipse 3.2 M4
+ javadoc view and editor tooltips also work with javadoc archives)."</p>
+
+ <p>"I didn't find useful to have both sources and javadocs attached,
since
+ javadocs are automatically extracted by eclipse: if you think this
+ should be needed please post an enhancement request in Jira with the
+ reasons... "</p>
+ </i>
+ <p>To go the the mailing list thread of this topic, click <a
href="http://www.nabble.com/forum/ViewPost.jtp?post=2370602&framed=y";>here</a></p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml?rev=422694&r1=422693&r2=422694&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml Mon Jul 17
05:09:03 2006
@@ -1,22 +1,23 @@
-<project name="Maven Eclipse plugin">
- <bannerLeft>
- <name>Maven Eclipse plugin</name>
- <src>http://maven.apache.org/images/apache-maven-project.png</src>
- <href>http://maven.apache.org/</href>
- </bannerLeft>
- <bannerRight>
- <src>http://maven.apache.org/images/maven-small.gif</src>
- </bannerRight>
- <body>
+<body>
<links>
- <item name="Maven 2" href="http://maven.apache.org/"/>
+ <item name="Maven" href="http://maven.apache.org/maven2/"/>
</links>
<menu name="Overview">
- <item name="Maven 2 and Eclipse" href="overview.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ <item name="FAQ" href="faq.html"/>
<item name="Multiple Module Projects" href="reactor.html"/>
- <item name="WTP" href="wtp.html"/>
+ <item name="WTP Support" href="wtp.html"/>
</menu>
+
+ <menu name="Examples">
+ <item name="Prevent Module References"
href="examples/prevent-module-references.html"/>
+ <item name="Attach Library Sources"
href="examples/attach-library-sources.html"/>
+ <item name="Provide Project Natures And Build Commands"
href="examples/provide-project-natures-and-build-commands.html"/>
+ </menu>
+
${reports}
+
</body>
-</project>
