Author: veithen
Date: Sun Mar 14 23:24:22 2010
New Revision: 923005

URL: http://svn.apache.org/viewvc?rev=923005&view=rev
Log:
Updated the instructions for import of the Axis2 sources into Eclipse.

Modified:
    axis/axis2/java/core/trunk/modules/documentation/xdocs/svn.xml

Modified: axis/axis2/java/core/trunk/modules/documentation/xdocs/svn.xml
URL: 
http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/modules/documentation/xdocs/svn.xml?rev=923005&r1=923004&r2=923005&view=diff
==============================================================================
--- axis/axis2/java/core/trunk/modules/documentation/xdocs/svn.xml (original)
+++ axis/axis2/java/core/trunk/modules/documentation/xdocs/svn.xml Sun Mar 14 
23:24:22 2010
@@ -99,21 +99,61 @@
         <section name="Configuring your IDE">
             <p>
                 The Axis2 development team uses a variety of development tools
-                from vi to emacs to eclipse to Intellij/IDEA. The following 
section
+                from vi to emacs to Eclipse to Intellij/IDEA. The following 
section
                 is not an endorsement of a specific set of tools, it is simply
                 meant as a pointer to ease the process of getting started with
                 Axis2 development.
             </p>
-            <ul>
-                <li><strong>Intellij IDEA</strong> - type <strong>mvn
-                idea:idea</strong>. Generates the necessary IDEA .ipr, .iml
-                and .iws project files</li>
-                <li><strong>Eclipse</strong>- type <strong>mvn 
eclipse:eclipse</strong>. Then in Eclipse, setup a Classpath Variable
-                for MAVEN_REPO, and select File &gt; Import &gt; Existing 
Projects
-                into Workspace &gt; Select root directory. Selecting the root 
of
-                the Axis source discovers all the modules and allows them to be
-                imported as individual projects at once.</li>
-            </ul>
+            <subsection name="Intellij IDEA">
+                <p>
+                    Type <strong>mvn idea:idea</strong>. Generates the 
necessary IDEA .ipr, .iml
+                    and .iws project files.
+                </p>
+            </subsection>
+            <subsection name="Eclipse">
+                <p>
+                    We recommend using <a 
href="http://maven.apache.org/plugins/maven-eclipse-plugin/";>maven-eclipse-plugin</a>
+                    to import the Axis2 sources into Eclipse. This works best 
with the following
+                    combinations of versions and settings:
+                </p>
+                <ul>
+                    <li>
+                        Early versions of Maven 2 have issues with non 
standard packagings
+                        (<tt>bundle</tt>, <tt>aar</tt> and <tt>mar</tt> in the 
case of Axis2)
+                        in multi-module builds. While this has no impact on 
the normal Maven
+                        build, it prevents the Maven Eclipse plugin from 
identifying modules
+                        with these packagings as Java projects. Therefore it 
is recommended
+                        to use Maven 2.2.x to execute the Maven Eclipse plugin.
+                    </li>
+                    <li>
+                        By default, the Maven Eclipse plugin only imports 
generated sources
+                        and resources created during the 
<tt>generate-sources</tt> and
+                        <tt>generate-resources</tt> phases, but fails to 
locate them if they
+                        are generated during the 
<tt>generate-test-sources</tt> and
+                        <tt>generate-test-resources</tt> phases. This is due 
to a limitation in Maven 2 (see
+                        <a 
href="http://jira.codehaus.org/browse/MECLIPSE-37";>MECLIPSE-37</a>
+                        for more information). Therefore it is recommended to 
execute the
+                        <tt>eclipse:eclipse</tt> goal after the 
<tt>process-test-resources</tt>
+                        phase.
+                    </li>
+                    <li>
+                        There is a bug in the Maven Eclipse plugin version 2.8 
that causes
+                        it to fail on the Axis2 sources. However, version 2.7 
is known to work.
+                    </li>
+                </ul>
+                <p>
+                    To summarize, use the following command to prepare the 
Axis2 sources for
+                    import into Eclipse:
+                </p>
+                <pre>mvn process-test-resources 
org.apache.maven.plugins:maven-eclipse-plugin:2.7:eclipse</pre>
+                <p>
+                    As usual, before importing the projects into Eclipse, 
check that a Classpath Variable
+                    for <tt>M2_REPO</tt> is configured in Eclipse. Then select 
File &gt; Import &gt; Existing Projects
+                    into Workspace &gt; Select root directory. Selecting the 
root of
+                    the Axis source discovers all the modules and allows them 
to be
+                    imported as individual projects at once.
+                </p>
+            </subsection>
         </section>
     </body>
 </document>


Reply via email to