Author: jgbutler
Date: Mon Jul 17 14:05:10 2006
New Revision: 422870
URL: http://svn.apache.org/viewvc?rev=422870&view=rev
Log:
More Abator 0.7.0 Updates
Removed:
ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/ant.bat
ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/build.bat
ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/clean.bat
ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/setenv.bat
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/build.xml
ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/version.properties
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/buildDoc.xml
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
Modified: ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/build.xml
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/build.xml?rev=422870&r1=422869&r2=422870&view=diff
==============================================================================
--- ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/build.xml
(original)
+++ ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/build.xml Mon Jul
17 14:05:10 2006
@@ -41,7 +41,11 @@
</target>
<target name="buildAbatorJar" depends="prepare">
- <javac srcdir="${src.dir}" destdir="${work.classes}" deprecation="true"
debug="true" />
+ <javac srcdir="${src.dir}"
+ destdir="${work.classes}"
+ deprecation="true"
+ debug="true"
+ classpath="../devlib/ant.jar"/>
<!-- copy non-compilable resources -->
<copy todir="${work.classes}">
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/version.properties
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/version.properties?rev=422870&r1=422869&r2=422870&view=diff
==============================================================================
--- ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/version.properties
(original)
+++ ibatis/trunk/java/mapper/mapper2/tools/abator/core/build/version.properties
Mon Jul 17 14:05:10 2006
@@ -1,4 +1,4 @@
#Abator build version info
-#Mon Jul 17 13:25:31 CDT 2006
+#Mon Jul 17 16:03:38 CDT 2006
version=0.7.0
-buildNum=135
+buildNum=139
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/buildDoc.xml
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/buildDoc.xml?rev=422870&r1=422869&r2=422870&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/buildDoc.xml
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/buildDoc.xml
Mon Jul 17 14:05:10 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<project default="javadoc">
+<project default="refresh">
<path id="org.abache.ibatis.abator.doc.javadocclasspath">
<pathelement location="../org.apache.ibatis.abator.ui/bin"/>
<pathelement location="../org.apache.ibatis.abator.core/abator.jar"/>
@@ -35,7 +35,10 @@
<delete dir="html/javadoc"/>
+ </target>
+
+ <target name="refresh" depends="javadoc" if="eclipse.running">
<eclipse.refreshLocal resource="org.apache.ibatis.abator.doc"/>
-
</target>
+
</project>
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html?rev=422870&r1=422869&r2=422870&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
Mon Jul 17 14:05:10 2006
@@ -1,11 +1,51 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
<html>
<head>
- <title>Building and Debugging the Plugins from Source</title>
+ <title>Abator Feature Debug Reference</title>
</head>
<body>
-<h1>Building and Debugging the Plugins from Source</h1>
-<p>The following instructions show how to build the Abator plugins from the
latest source
+<h1>Abator Feature Debug Reference</h1>
+<p>This page contains reference information about how to build and debug Abator
+from source.</p>
+
+<h2>Feature Structure</h2>
+<p>The Abator feature is structured as four different Eclipse projects - a
feature project and
+three plug-in projects. The feature project groups the three plug-ins
together for easy
+installation. The Abator feature project is
<code>org.apache.ibatis.abator</code>.
+This project references the three plug-in projects. The plug-in projects are
structured as
+follows:</p>
+<table cellspacing="0" cellpadding="5" border="1">
+ <tr>
+ <th>Plug-in Project</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>org.apache.ibatis.abator.core</code></td>
+ <td>This plug-in is an Eclipse library plug-in for the standard Abator JAR
file.
+ The purpose of this plug-in is to package the standard JAR and make it
available to the
+ other plug-ins. There is a build filed in this plug-in
(buildAbator.xml) that
+ will compile the core Abator JAR file and update the wrapped JAR files.
This makes
+ it easy to keep the plug-in up to date as the core functionality is
developed.</td>
+ </tr>
+ <tr>
+ <td><code>org.apache.ibatis.abator.doc</code></td>
+ <td>This plug-in holds the documentation for Abator. There is a build
file in this
+ plug-in (buildDoc.xml) that will build the documentation and package it
for inclusion
+ into the Eclipse help system.</td>
+ </tr>
+ <tr>
+ <td><code>org.apache.ibatis.abator.ui</code></td>
+ <td>This plug-in holds the Java code for the Eclipse user interface for
Abator. If you
+ are experiencing trouble with the plug-in specific features (like Java
file merging), then
+ the code for those features will be found in this plug-in.
+ </td>
+ </tr>
+</table>
+
+
+<h2>Building the Feature and Plug-ins from Source</h2>
+<p>The following instructions show how to build the Abator feature and
plug-ins from the
+latest source
in the Subversion repository. We assume that you are somewhat familiar with
Subversion
and the Eclipse plug-in development environment (PDE). These instructions
also assume
you are using Eclipse version 3.2. Things are similar in Eclipse 3.1. The
plug-in
@@ -36,6 +76,7 @@
<li>Press "Finish", wait for the workspace to build.</li>
</ol>
</li>
+ <p />
<li>Note that there may be errors in the build depending on which JDK you
have installed
(for the official release, Abator is compiled with JDK 1.4.2).
If you see an error stating that <code>java.lang.Object</code> cannot be
resolved,
@@ -55,5 +96,57 @@
can ignore them</li>
</ol>
</ol>
+
+<h2>Debugging</h2>
+<p>At this point the projects should be successfully compiled in Eclipse. If
you want to
+ debug something in the plug-in, you will need to start another instance of
Eclipse
+ in debug mode. The following instructions explain how to do this.</p>
+
+<ol>
+ <li>Set a breakpoint in the code you would like to debug.</li>
+ <li>Double click on the "plugin.xml" file in the
"org.apache.ibatis.abator.ui"
+ project. This should open the plug-in manifest editor. If some other
editor
+ opens, then close the editor, right click on "plugin.xml" and select the
+ "Open With>Plug-in Manifest Editor" option.</li>
+ <li>Select the "Overview" editor tab</li>
+ <li>Take the option to "Launch an Eclipse Application in Debug mode".
This will
+ start a new instance of Eclipse in debug mode with the Abator plug-ins
installed.</li>
+</ol>
+
+<p>Once you have the other instance of Eclipse started you should create a new
Java project
+ in the new workspace, create and fill out an Abator configuration file, and
then run Abator.
+ Abator should eventually hit your breakpoint, and then you step through the
code.</p>
+<p>The following classes will likely be of the most interest in debugging:</p>
+<table cellspacing="0" cellpadding="5" border="1">
+ <tr>
+ <th>Class</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>org.apache.ibatis.abator.ui.actions.RunAbatorThread</code></td>
+ <td>This class is a thread that runs Abator on the selected configuration
file.
+ You can set a breakpoint in the <code>run</code> method of this class to
follow
+ the Abator code generation process from the beginning.
+ </td>
+ </tr>
+ <tr>
+ <td><code>org.apache.ibatis.abator.ui.plugin.JavaFileMerger</code></td>
+ <td>This class implements the Java file merge function. You can set a
breakpoint
+ in the <code>getMergedSource</code> method to follow the merging process.
+ </td>
+ </tr>
+</table>
+
+<h2>Building the Documentation</h2>
+<p>The documentation for Abator is integrated into the Eclipse help system.
+This is accomplished by building an archive file called "doc.zip" that contains
+the documentation for the plug-ins, as well as core Abator documentation and
Javadoc.
+This archive file is not in Subversion because it is a generated file. If you
would
+like to rebuild the archive, simply execute the <code>buildDoc.xml</code> file
+in the <code>org.apache.ibatis.abator.doc</code> project (an Ant build
file).</p>
+
+<h2>Building the Abator Core JAR in Eclipse</h2>
+
+
</body>
</html>
