idarwin 2004/08/27 14:56:50
Modified: webapps/docs building.xml
Log:
Add some notes on building the code under Eclipse. Based on several
emails from Costin - thanks!
Revision Changes Path
1.3 +68 -0 jakarta-tomcat-catalina/webapps/docs/building.xml
Index: building.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/building.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- building.xml 21 Sep 2003 15:36:53 -0000 1.2
+++ building.xml 27 Aug 2004 21:56:49 -0000 1.3
@@ -141,5 +141,73 @@
</section>
+<section name="Building with Eclipse">
+
+<p>
+<b>Important:</b>
+This is not a supported means of building Tomcat; this information is
+provided without warranty :-).
+The only supported means of building Tomcat is with the "ant build"
+described above.
+However, some developers like to work on Java code with a Java IDE,
+and the following steps have been used by some developers.
+
+<p>
+Note that you <b>must</b> complete all the above steps to fetch
+the repositories and build some JAR files the first time.
+After you have completed the above steps, you can set up a
+series of Eclipse 3 projects.
+<b>Note</b> that this will not let you build everything under Eclipse;
+the build process requires use of Ant for the many stages that aren't
+simple Java compilations.
+However, it will allow you to view and edit the Java code,
+get warnings, reformat code, perform refactorings, run Tomcat
+under the IDE, and so on.
+</p>
+
+<p>
+Use File->New Project to create a new Java project
+for each of the binaries repository (e.g., /usr/share/java),
+tomcat-connectors, tomcat-catalina, jasper, servletapi.
+Unless you thought ahead to make the ${tomcat.source} directory be under
+your Workspace folder, tell Eclipse the external location.
+The obvious dependencies will be needed; the "repository" project
+needs to export all its jars, and be referred to by the other projects.
+Eclipse will find all source trees and jars, and
+hopefully compile without problems
+You will need to add ${ant-home}/lib/ant.jar as an "External Jar"
+under Project Properties for some of these projects (notably those that fail
+to compile for want of BuildException).
+</p>
+
+<p>
+To run Tomcat without a special IDE plug-in, you can simply use Run->Run...
+enter "org.apache.catalina.startup.Catalina" as the main class,
+"start" as program arguments, and
+"-Dcatalina.home=..." (with the name of your build directory)
+as VM arguments.
+</p>
+
+<p>
+Note also that due to the way the Tomcat source is assembled
+from several CVS projects, you may not be able to use the Eclipse
+CVS client to update (nor to commit, if you are a committer).
+Use the external CVS client of your choice, then use the
+Eclipse PackageExplorer or Navigator "Refresh" context menu item
+to tell Eclipse that you've updated the files.
+</p>
+
+</section>
+
+<section name="Building with other IDEs">
+<p>
+The same caveats apply as for Eclipse, above.
+</p>
+
+<p>
+The same general idea should work in most IDEs; it has been reported
+to work in Idea, for example.
+<p>
+
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
