You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by fu...@apache.org on 2005/06/10 02:07:04 UTC

svn commit: r189863 - in /incubator/derby/code/trunk: BUILDING.txt plugins/eclipse/Readme.txt

Author: fuzzylogic
Date: Thu Jun  9 17:07:04 2005
New Revision: 189863

URL: http://svn.apache.org/viewcvs?rev=189863&view=rev
Log:
1) Add a section about how to build the core plugin in BUILDING.TXT
2) Put the Readme.txt file for building the UI plugin into the source tree
    under trunk/plugins/eclipse

Committed for Susan Cline <ho...@pacbell.net>

Also added a note about path to runtime libraries when using IBM JVMs to
BUILDING.txt.

Added:
    incubator/derby/code/trunk/plugins/eclipse/Readme.txt   (with props)
Modified:
    incubator/derby/code/trunk/BUILDING.txt

Modified: incubator/derby/code/trunk/BUILDING.txt
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/BUILDING.txt?rev=189863&r1=189862&r2=189863&view=diff
==============================================================================
--- incubator/derby/code/trunk/BUILDING.txt (original)
+++ incubator/derby/code/trunk/BUILDING.txt Thu Jun  9 17:07:04 2005
@@ -255,7 +255,7 @@
 IBM's WCTME 5.7
 
 Once you have obtained these jars and set the jsr169compile.classpath
-(see section 3.2) the regulat Derby builds will include the JSR169 code
+(see section 3.2) the regular Derby builds will include the JSR169 code
 for the embedded engine. The resulting jar file (derby.jar) can be used
 on J2ME, or J2SE, write once run anywhere.
 
@@ -329,7 +329,7 @@
     - j14lib
 
       This is a required variable which defines the location of
-      JDK 1.4.x. Define the variable as following:
+      JDK 1.4.x. Define the variable as follows:
 
           j14lib=${jdk14.dir}/jre/lib
       
@@ -339,12 +339,24 @@
     - j13lib
 
       This is a required variable which defines the location of
-      JDK 1.3.x. Define the variable as following:
+      JDK 1.3.x. Define the variable as follows:
 
           j13lib=${jdk13.dir}/jre/lib
 
       where ${jdk13.dir} is the directory name where you have 
       installed JDK 1.3.x. Check out section 2.2.3 of this document.
+
+    - java14compile.classpath - IBM JVMs only
+
+      IBM Java SDKs may be used in place of Sun's, but IBM packages
+      its Java runtime libraries in multiple jar files instead of
+      a single jar file, rt.jar. This means that if you are using
+      IBM SDKs to provide your Java runtime environment, you need to
+      also override the property java14compile.classpath in your 
+      ant.properties file to account for the difference in
+      packaging. Define the variable as follows:
+
+      java14compile.classpath=${j14lib}/core.jar;${j14lib}/server.jar;${j14lib}/xml.jar
       
     - build.compiler
 
@@ -389,7 +401,7 @@
       for the top-level default, engine or all targets.
       The compile classpath needs to include the Foundation 1.0
       and JSR169 environments, see any documentation for your
-      source of J2ME libraries. Here is an example foe IBM's WCTME 5.7
+      source of J2ME libraries. Here is an example for IBM's WCTME 5.7
  
       jsr169compile.classpath=C:/wctme5.7/ive/lib/jclFoundation10/classes.zip;C:/wctme5.7/ive/lib/jdbc.jar
 
@@ -554,6 +566,9 @@
 
   cleandocs: remove javadoc directory (${derby.source}/javadoc)
 
+  plugin:  creates a zip file, derby_eclipse_plug-in.zip, in the 
+           jars/insane directory.  The plugin target depends on the 
+           default ant target.  This creates the Core plug-in only.
 
 
 4.2   Derby source code upgrade

Added: incubator/derby/code/trunk/plugins/eclipse/Readme.txt
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/plugins/eclipse/Readme.txt?rev=189863&view=auto
==============================================================================
--- incubator/derby/code/trunk/plugins/eclipse/Readme.txt (added)
+++ incubator/derby/code/trunk/plugins/eclipse/Readme.txt Thu Jun  9 17:07:04 2005
@@ -0,0 +1,120 @@
+Obtaining the Source and Building the Derby 1.0 UI and Help Plug-ins
+
+This document describes how to obtain the source for the
+Apache Derby 1.0 UI and Help plug-ins for Eclipse.  Instructions
+for importing the source as an Eclipse project and packaging the
+plug-ins as a zip file are also included.
+
+Contents:
+
+I. Creating the Apache Derby UI and Help Plug-in Projects
+II. Creating zip files for the Derby UI and Help Plug-ins via the Project
+
+=========================================================================
+
+I. Creating the Apache Derby UI and Help Plug-in projects:
+
+1) Check out the source for the UI and Help plug-ins via SVN (Subversion).
+
+   Refer to the detailed instructions on readying your environment
+   to check out any Derby source here: 
+
+   http://incubator.apache.org/derby/derby_downloads.html
+
+   To check out the entire development trunk use this command:
+
+   svn checkout https://svn.apache.org/repos/asf/incubator/derby/code/trunk/
+
+   This includes the source for both the UI and Help plugins.  If you want to
+   check out only the UI and Help plugins, and not the entire Derby source code 
+   issue this command instead:
+
+   svn checkout https://svn.apache.org/repos/asf/incubator/derby/code/trunk/plugins
+
+  
+2) Install Eclipse 3.x and the JDK needed
+
+3) Install the Apache Derby 10.1.0 Eclipse Core plug-in from:
+   http://incubator.apache.org/derby/derby_downloads.html
+
+   It is available as a zip file:
+
+   for example; derby_core_plugin_10.1.0.178324.zip
+
+   Unzip this file into the directory where the eclipse executable is located.
+   For instance, if Eclipse is installed in C:\eclipse, unzip the Derby
+   Core plug-in zip file to C:\eclipse.
+
+4) Invoke the Eclipse IDE, provide an appropriate location as the workspace
+
+   for example: c:\derby\plugin
+
+5) Import the Apache Derby UI project:
+   File -> Import -> Existing Project into Workspace
+   - Click Next
+   - Click Browse and point to the "org.apache.derby.ui" directory (created in 
+     Step 1, which is under the plugins/eclipse directory where you checked 
+     out the source)
+   - Click Finish
+
+6) Switch to the Plug-in perspective
+   Window -> Open Perspective -> Other -> Select Plug-in Development
+
+7) To invoke and test the Apache Derby UI Plug-in in this development environment
+   
+   Run ->Run As -> Eclipse Application (Eclipse 3.1)
+   OR
+   Run --> Run As --> Run-time Workbench (Eclipse 3.0)
+   
+   An alternate way would be to open the plugin.xml and select the 
+   'Launch a runtime workbench' link.
+
+   This will open a new Eclipse window with all the current plug-ins under 
+   development in its environment.
+
+Follow steps 4 - 7 as above for creating the Help plug-in project, substituting
+org.apache.derby.plugin.doc for org.apache.derby.ui.
+================================================================================
+
+II. Creating zip files for the Derby UI and Help Plug-ins via the Project
+
+In order to install the plug-ins easily in another Eclipse environment creating
+a zip file is useful.
+
+To create a zip file for the UI plug-in:
+
+1) From within the Plug-in Development perspective, right-click the org.apache.derby.ui
+   project.  Select Export --> Deployable plug-ins and fragments, then the Next button.
+
+2) In the Export Plug-ins and Fragments window select the org.apache.derby.ui project
+   listed in the Available Plug-ins and Fragments text area.  For the Export Options
+   section select Deploy as: a single ZIP file.  Click the Build Options button.
+   Check any options desired from the Build Options Preferences window and then
+   click OK.
+
+3) Browse to a Destination where you would like to put the zip file and name it
+   org.apache.derby.ui_1.0.0.zip to represent the name and version of the plug-in.
+
+4) Finally, click Finish.
+
+5) To install in another Eclipse installation unzip this file in the base
+   directory of the Eclipse installation.
+
+To create a zip file for the Doc plug-in:
+
+1) From within the Plug-in Development perspective, right-click the
+   org.apache.derby.plugin.doc project.  Select Export --> Zip file.
+
+2) In the Export Zip file window select the org.apache.derby.plugin.doc project
+   listed in the left frame.  In the right frame uncheck the .project and
+   build.properties files.
+
+3) Browse to a Destination where you would like to put the zip file and name it
+   org.apache.derby.plugin.doc_1.0.0.zip to represent the name and version of 
+   the plug-in.
+
+4) Finally, click Finish.
+
+5) Note that the documentation zip files' base directory is
+   org.apache.derby.plugin.doc and therefore must be unzipped in the plug-ins
+   directory.

Propchange: incubator/derby/code/trunk/plugins/eclipse/Readme.txt
------------------------------------------------------------------------------
    svn:eol-style = native