2003/03/20 03:11:11
[org.ibex.core.git] / README
diff --git a/README b/README
index 08be636..e7c63c1 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,7 @@
 ==============================================================================
 XWT README
+
+             
 ______________________________________________________________________________
 Documentation
 
@@ -8,100 +9,72 @@ If you're new to XWT, you should read the documentation in the order
 presented below:
 
 - README [this file]
-
+        
       Start here. Includes a map of all other documentation and a
       description of the directory strucure
 
-- The XWT home page [http://www.xwt.org/]
-
+- The XWT home page [http://www.xwt.org/]      
+          
 - The XWT tutorial [http://www.xwt.org/tutorial.html]
 
       Gentle introduction to what XWT is, and how to write
       .xwt's. Good for anybody who wants to write XWT applications.
 
 - The XWT reference [http://www.xwt.org/reference.html]
-
+        
       Precise, technical spec of exactly how XWT works. Assumes
       familiarity with XWT (ie, you've read the tutorial). This is the
       authoritative source for how an XWT engine should
       behave.
 
-
 ______________________________________________________________________________
 Directory Structure
 
-/
-   AUTHORS               - people involved in developing XWT
-   README                - this file
-   COPYING               - copyright information for all files in this distro
-   TM                    - trademark information for XWT
-   ant                   - a unix shell script to launch ant
-   bin/                  - all binary stuff generated by ant builds
-
-   build.xml             - ANT build file
-   Makefile              - build file for gcc 3.3
-
-   lib/                  - any third-party binary stuff needed during the build process
-       javago            - a copy of the javago post-compilation bytecode inliner
-       ant.jar           - the Jakarta project's ANT build tool, including Sun's XML parser
-       netscape.jar      - minimal set of classes required for compiling against Netcape's Applet interfaces
-       msjvm.jar         - minimal set of classes required for compiling against Microsoft's Applet interfaces
-       javasrc.jar       - javasrc, a tool for generating hyperlinked, syntax-colored html from java code
-
-   src/                  - all java source files and xwt sources go here
+/      
+   AUTHORS                - people involved in developing XWT  
+   README                 - this file
+   COPYING                - copyright information for all files in this distro
+   TM                     - trademark information for XWT      
+   Makefile               - build file for gcc 3.3
+   next.build             - the build id of the next build to be generated
+   bin/                   - all binary stuff generated by xwt builds
+   gcc/                   - build area for a custom copy of gcc3.3 and binutils2.13
+       Makefile           - will download, configure, compile, and private-install gcc3.3/binutils2.13
+   lib/                   - any third-party binary stuff needed during the build process
+       javago             - a copy of the javago post-compilation bytecode inliner
+       netscape.jar       - minimal set of classes required for compiling against Netcape's Applet interfaces
+       msjvm.jar          - minimal set of classes required for compiling against Microsoft's Applet interfaces
+       jump.jar           - the jump2 bytecode-to-palmos translator
+       libgcj-minimal.jar - a tiny portion of libgcj.jar; allows java->bytecode compilation without gcj
+   src/                   - all java source files and xwt sources go here
        org/
-           bouncycastle/ - the BouncyCastle Crypto Library
-           mozilla/      - a copy of Rhino, the Mozilla JavaScript interpreter
-           xwt/builtin/  - .xwt's and .png's that are essential to bootstrapping the engine
-           xwt/plat/     - platform-specific code
+           bouncycastle/  - the BouncyCastle Crypto Library
+           mozilla/       - a copy of Rhino, the Mozilla JavaScript interpreter
+           xwt/builtin/   - .xwt's and .png's that are essential to bootstrapping the engine
+           xwt/plat/      - platform-specific code
 
 ______________________________________________________________________________
-Build Targets
-
-        *** XWT now requires JDK 1.4 or later to build ***
-
-To build, make sure your $JAVA_HOME points to jdk1.4 or later, and type
-
-    ./ant -Dplat=<platform> <targetname>
-
-The name of any class in org.xwt.plat is a valid <platform>; here is a
-list as of 20-Mar-2002:
-
-    Win32         - Windows 95 / NT4 or later
-    Java12        - Any Java 1.2+ compliant JVM
-
-Valid <target>s are:
-
-    build         - builds a binary for the selected platform
-
-The following targets do not require that you specify a platform:
-
-    compile       - compiles all .java's to .class'es
-    clean         - empties bin/ and compiled binaries in dist/
-
-
-______________________________________________________________________________
-Building
-
-- WARNING: Jikes 1.16 has a bug which will cause it to generate
-  corrupt .class files; you must downgrade to 1.15 in order to compile
-  XWT.
-
-- If you only want to build the JVM version of XWT, delete these three
-  files:
+Build Targets and Requirements
 
-    xwt/src/org/xwt/plat/Win32.java
-    xwt/src/org/xwt/plat/POSIX.java
-    xwt/src/org/xwt/plat/GCJ.java
+Build requirements:
+- jdk 1.4+
+- jikes (warning: Jikes 1.16 has a fatal bug; use 1.15)
+- gcj 3.3+
+- binutils 2.13+
+- fastjar
 
-  This will allow XWT to build correctly *without* gcc 3.1. Otherwise,
-  you must compile and install gcc 3.1.
+If you already have a suitably configured gcj 3.3 and binutils 2.13+
+you can set "gcc_path" to point at its installation location;
+otherwise the Makefile will download, configure, compile, and install
+gcc and binutils.
 
-- The Win32 native version of XWT can ONLY be built with the very
-  latest pre-release of GCC 3.3.  Run "make gcc-lin" to build a gcc
-  3.3 that targets Linux; run "make gcc-win" to build a gcc 3.3 that
-  targets Win32.
+Public build targets:
 
+    compile       - compiles all .java files into bin/*.class
+    Win32         - Win95 or later (bin-Win32/xwt.exe)
+    Linux         - Linux 2.2 or later (bin-Linux/xwt.linux)
+    Java2         - Any Java 1.2+ compliant JVM
+    clean         - cleanup
 
 
 ______________________________________________________________________________
@@ -149,8 +122,8 @@ Index: Class.h
 RCS file: /cvs/gcc/gcc/libjava/java/lang/Class.h,v
 retrieving revision 1.43
 diff -u -r1.43 Class.h
---- Class.h    21 Dec 2001 19:47:50 -0000      1.43
-+++ Class.h    24 Apr 2002 03:06:14 -0000
+--- Class.h     21 Dec 2001 19:47:50 -0000      1.43
++++ Class.h     24 Apr 2002 03:06:14 -0000
 @@ -308,6 +308,7 @@
    friend void _Jv_LayoutVTableMethods (jclass klass);
    friend void _Jv_SetVTableEntries (jclass, _Jv_VTable *);
@@ -164,8 +137,8 @@ Index: ClassLoader.java
 RCS file: /cvs/gcc/gcc/libjava/java/lang/ClassLoader.java,v
 retrieving revision 1.16
 diff -u -r1.16 ClassLoader.java
---- ClassLoader.java   7 Dec 2001 23:34:12 -0000       1.16
-+++ ClassLoader.java   24 Apr 2002 03:06:14 -0000
+--- ClassLoader.java    7 Dec 2001 23:34:12 -0000       1.16
++++ ClassLoader.java    24 Apr 2002 03:06:14 -0000
 @@ -577,4 +577,8 @@
      // Default to returning null.  Derived classes implement this.
      return null;
@@ -180,8 +153,8 @@ Index: Throwable.java
 RCS file: /cvs/gcc/gcc/libjava/java/lang/Throwable.java,v
 retrieving revision 1.10
 diff -u -r1.10 Throwable.java
---- Throwable.java     24 Feb 2001 03:52:49 -0000      1.10
-+++ Throwable.java     24 Apr 2002 03:06:14 -0000
+--- Throwable.java      24 Feb 2001 03:52:49 -0000      1.10
++++ Throwable.java      24 Apr 2002 03:06:14 -0000
 @@ -123,21 +123,64 @@
      printStackTrace (writer);
    }
@@ -192,17 +165,17 @@ diff -u -r1.10 Throwable.java
    {
 -    try
 -      {
--      CPlusPlusDemangler cPlusPlusFilter = new CPlusPlusDemangler (wr);
--      PrintWriter writer = new PrintWriter (cPlusPlusFilter);
--      printRawStackTrace (writer);    
--      writer.close ();
--      if (cPlusPlusFilter.written == 0) // The demangler has failed...
--        printRawStackTrace (wr);
+-       CPlusPlusDemangler cPlusPlusFilter = new CPlusPlusDemangler (wr);
+-       PrintWriter writer = new PrintWriter (cPlusPlusFilter);
+-       printRawStackTrace (writer);    
+-       writer.close ();
+-       if (cPlusPlusFilter.written == 0) // The demangler has failed...
+-         printRawStackTrace (wr);
 +      try
 +          {
 +              CPlusPlusDemangler cPlusPlusFilter = new CPlusPlusDemangler (wr);
 +              PrintWriter writer = new PrintWriter (cPlusPlusFilter);
-+              printRawStackTrace (writer);    
++              printRawStackTrace (writer);     
 +              writer.close ();
 +              if (cPlusPlusFilter.written > 0) return;
 +          }
@@ -217,7 +190,7 @@ diff -u -r1.10 Throwable.java
        }
 -    catch (Exception e1)
 -      {
--      printRawStackTrace (wr);
+-       printRawStackTrace (wr);
 +      
 +      long[] allAddrs = ClassLoader.getAllMethodAddrs();
 +      java.lang.reflect.Method[] meths = ClassLoader.getAllMethods();
@@ -263,8 +236,8 @@ Index: natClassLoader.cc
 RCS file: /cvs/gcc/gcc/libjava/java/lang/natClassLoader.cc,v
 retrieving revision 1.47.8.1
 diff -u -r1.47.8.1 natClassLoader.cc
---- natClassLoader.cc  2 Apr 2002 22:19:55 -0000       1.47.8.1
-+++ natClassLoader.cc  24 Apr 2002 03:06:14 -0000
+--- natClassLoader.cc   2 Apr 2002 22:19:55 -0000       1.47.8.1
++++ natClassLoader.cc   24 Apr 2002 03:06:14 -0000
 @@ -40,6 +40,10 @@
  #include <java/lang/StringBuffer.h>
  #include <java/io/Serializable.h>
@@ -332,8 +305,8 @@ Index: natThrowable.cc
 RCS file: /cvs/gcc/gcc/libjava/java/lang/natThrowable.cc,v
 retrieving revision 1.11
 diff -u -r1.11 natThrowable.cc
---- natThrowable.cc    7 Feb 2002 19:26:06 -0000       1.11
-+++ natThrowable.cc    24 Apr 2002 03:06:14 -0000
+--- natThrowable.cc     7 Feb 2002 19:26:06 -0000       1.11
++++ natThrowable.cc     24 Apr 2002 03:06:14 -0000
 @@ -32,6 +32,7 @@
  #include <stdio.h>