[Cp-tools-commit] FYI: Documentation update

[cp-tools-commit]

This patch updates the INSTALL and README files, explaining how to solve 
my previous problems. It is now explained

1. That exactly ASM 1.5.3 and no more recent version is required.
2  How to compose bytecode.jar from the recent kawa distribution.

2006-02-06  Audrius Meskauskas  <address@hidden>

   * INSTALL, README: Documentation update.

Index: INSTALL
===================================================================
RCS file: /sources/classpath/cp-tools/INSTALL,v
retrieving revision 1.1
diff -u -r1.1 INSTALL
--- INSTALL     17 Jan 2005 05:39:55 -0000      1.1
+++ INSTALL     6 Feb 2006 12:31:00 -0000
@@ -1,13 +1,68 @@
-Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
+Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2006 Free Software
 Foundation, Inc.
 
    This file is free documentation; the Free Software Foundation gives
 unlimited permission to copy, distribute and modify it.
 
+Required libraries
+==================
+In order to build this project, you need to download and install the following
+additional libraries:
+
+  1. ASM 1.5.3. The build will fail with ASM 2.0 or newer versions, because
+     they have many public classes rewritten. 
+     
+     The ASM can be downloaded from http://forge.objectweb.org/projects/asm/.
+     You must rename the downloaded jar into asm.jar and place into
+     /usr/local/share/java/ or /usr/share/java/ . Alternatively (if you
+     already have the newer version installed), you may not rename the file,
+     place into arbitrary location and use ./configure --with-asm, for 
instance:
+     
+     sh configure --with-asm=/usr/local/share/java/asm-1.5.3.jar
+  
+  2. bytecode.jar. This archive contains the compiled code fragment from the
+     KAWA projec and must be composed manually. The simplies way to do this is
+     to download the kawa-1.8.jar from 
+     http://www.gnu.org/software/kawa/Getting-Kawa.html and, using some
+     archiving tool like File Roller 2.10.0 REMOVE all contents EXCEPT the 
+     folder gnu/bytecode/ . This is the workaround against the 
+     gcj (version 4.0.2)  bug: it crashes compiling the "full" file version.
+     After you do this, rename the file into bytecode.jar and copy to
+     /usr/share/java/ or /usr/local/share/java/.
+
 Basic Installation
 ==================
+The simplest way to compile this package is:
+
+  1. `cd' to the directory containing the package's source code and type
+     `./configure' to configure the package for your system.  If you're
+     using `csh' on an old version of System V, you might need to type
+     `sh ./configure' instead to prevent `csh' from trying to execute
+     `configure' itself.
+
+     Running `configure' takes awhile.  While running, it prints some
+     messages telling which features it is checking for.
+     
+     P.S. If you have checked the tools package from CVS, there will be no
+     "configure" file in the project folder. To generate it, run autogen.sh
+     (GNU build system must be installed).
+
+  2. Type `make' to compile the package.
+
+  3. Optionally, type `make check' to run any self-tests that come with
+     the package.
+
+  4. Type `make install' to install the programs and any data files and
+     documentation.
 
-   These are generic installation instructions.
+  5. You can remove the program binaries and object files from the
+     source code directory by typing `make clean'.  To also remove the
+     files that `configure' created (so you can compile the package for
+     a different kind of computer), type `make distclean'.  There is
+     also a `make maintainer-clean' target, but that is intended mainly
+     for the package's developers.  If you use it, you may have to get
+     all sorts of other programs in order to regenerate files that came
+     with the distribution.   These are generic installation instructions.
 
    The `configure' shell script attempts to guess correct values for
 various system-dependent variables used during compilation.  It uses
@@ -36,34 +91,6 @@
 `configure.ac' if you want to change it or regenerate `configure' using
 a newer version of `autoconf'.
 
-The simplest way to compile this package is:
-
-  1. `cd' to the directory containing the package's source code and type
-     `./configure' to configure the package for your system.  If you're
-     using `csh' on an old version of System V, you might need to type
-     `sh ./configure' instead to prevent `csh' from trying to execute
-     `configure' itself.
-
-     Running `configure' takes awhile.  While running, it prints some
-     messages telling which features it is checking for.
-
-  2. Type `make' to compile the package.
-
-  3. Optionally, type `make check' to run any self-tests that come with
-     the package.
-
-  4. Type `make install' to install the programs and any data files and
-     documentation.
-
-  5. You can remove the program binaries and object files from the
-     source code directory by typing `make clean'.  To also remove the
-     files that `configure' created (so you can compile the package for
-     a different kind of computer), type `make distclean'.  There is
-     also a `make maintainer-clean' target, but that is intended mainly
-     for the package's developers.  If you use it, you may have to get
-     all sorts of other programs in order to regenerate files that came
-     with the distribution.
-
 Compilers and Options
 =====================
 
Index: README
===================================================================
RCS file: /sources/classpath/cp-tools/README,v
retrieving revision 1.1
diff -u -r1.1 README
--- README      17 Jan 2005 05:39:55 -0000      1.1
+++ README      6 Feb 2006 12:31:00 -0000
@@ -0,0 +1,2 @@
+The recent version depends on the two external libraries that must be
+obtained separatedly. Please read INSTALL for details.