FYI: Small documentation update/cleanup

[Mark Wielaard]

Hi,

A small documentation update that mentions texinfo and updates version
numbers.

2004-04-30  Mark Wielaard  <address@hidden>

       * README: Update end user dev environments and hackers runtime lists.
       * INSTALL: Update needed library versions, add texinfo version
       requirement, mention website/hacker guide.
       * doc/hacking.texinfo: Include item on texinfo.

Committed.

Cheers,

Mark

Index: doc/hacking.texinfo
===================================================================
RCS file: /cvsroot/classpath/classpath/doc/hacking.texinfo,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -u -r1.25 -r1.26
--- doc/hacking.texinfo 2 Apr 2004 21:34:43 -0000       1.25
+++ doc/hacking.texinfo 30 Apr 2004 12:32:16 -0000      1.26
@@ -343,6 +343,8 @@
 libtool 1.4.2+
 @item
 GNU m4 1.4
address@hidden
+texinfo 4.2+
 @end itemize
 
 All of these tools are available from
@@ -394,6 +396,16 @@
 
 @item perl
 Larry Wall's scripting language.  It is used internally by automake.
+
address@hidden texinfo
+Manuals and documentation (like this guide) are written in texinfo.
+Texinfo is the official documentation format of the GNU project.
+Texinfo uses a single source file to produce output in a number of formats,
+both online and printed (dvi, info, html, xml, etc.). This means that
+instead of writing different documents for online information and another
+for a printed manual, you need write only one document. And when the work
+is revised, you need revise only that one document.
+
 @end table
 
 
Index: README
===================================================================
RCS file: /cvsroot/classpath/classpath/README,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -u -r1.12 -r1.13
--- README      24 Dec 2002 05:35:22 -0000      1.12
+++ README      30 Apr 2004 12:32:15 -0000      1.13
@@ -1,4 +1,4 @@
-GNU Classpath README - Last updated: December 23, 2002
+GNU Classpath README - Last updated: Arpil 30, 2004
 
 GNU Classpath, Essential Libraries for Java is a project to create
 a complete "clean room" implementation of the Java class libraries 
@@ -8,18 +8,29 @@
 javadoc, javap, javah, and others.
 
 Eventually, these essential libraries for Java will work with as many 
-free JVMs as possible.  Virtual machines known to use GNU Classpath
-include:
-       * GCJ           (http://gcc.gnu.org/java/)
-       * ORP           (http://orp.sourceforge.net/)
+free JVMs as possible.  Complete development environments known to be
+based on GNU Classpath include (recommended for end users):
+
+       * GCC with GCJ  (http://gcc.gnu.org/java/)
+       * Kaffe         (http://www.kaffe.org/)
+
+Smaller (runtime only) environments based on GNU Classpath includei
+(recommended for GNU Classpath hackers):
+
+       * JamVM         (http://www.jamvmv.org/)
+       * Jikes RVM     (http://www.ibm.com/developerworks/oss/jikesrvm/)
        * Kissme        (http://kissme.sourceforge.net/)
-       * SableVM       (http://www.sablevm.org/)
-       * Jupiter       (http://www.eecg.toronto.edu/~doylep/jupiter/)
-       * Joas          (http://www.oberon.ethz.ch/jaos/)
-       * AegisVM       (http://aegisvm.sourceforge.net/)
 
-This is a development release only and is not ready for general
-purpose use.
+In general the latest releases of the above VMs will work out of the box
+with the latest GNU Classpath release (and in most cases directly with the
+development sources from CVS).
+
+See for other GNU Classpath based runtimes, compilers and tools the
+GNU Classpath website: http://www.gnu.org/software/classpath/stories.html
+
+This is a development snapshot release only and is not ready for general
+purpose use.  You need to combine it at least with one of the development
+environments mentioned above.
 
 Most JVMs come with their own customized version of GNU Classpath.
 Please check if there is a customised version available for the JVM you
@@ -32,7 +43,7 @@
 See the file TODO for the latest to do list.
 See the file HACKING for working on (non-released) CVS development versions.
 
-Homepage: http://www.classpath.org/ or http://www.gnu.org/software/classpath/
+Homepage: http://www.gnu.org/software/classpath/
 
 General Mailing List: address@hidden
   --> Bugs and patches can be reported via Savannah if you have a browser
@@ -42,19 +53,15 @@
       only with a body and subject of "unsubscribe".  This is a
       smartlist managed mailing list.
 
-CVS Commit List: address@hidden
+CVS Commit, Bugs and Patches List: address@hidden
   --> To subscribe send email to address@hidden with a 
       subject and body of "subscribe".  To unsubscribe do the same,
       only with a body and subject of "unsubscribe".  This is a
       smartlist managed mailing list.
 
-Anonymous CVSROOT: :pserver:address@hidden:/cvsroot/classpath 
+Anonymous CVSROOT: :pserver:address@hidden:/cvsroot/classpath 
   --> First do "cvs login".  Hit <Return> when prompted for a password
   --> More detailed instructions available on the Savannah project website.
-
-Other Java free software projects of note:
-
-Kaffe - http://www.kaffe.org/
+      http://savannah.gnu.org/projects/classpath/
 
 Happy Hacking!
-
Index: INSTALL
===================================================================
RCS file: /cvsroot/classpath/classpath/INSTALL,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -u -r1.18 -r1.19
--- INSTALL     9 Apr 2004 16:04:21 -0000       1.18
+++ INSTALL     30 Apr 2004 12:32:15 -0000      1.19
@@ -1,4 +1,4 @@
-Installing GNU Classpath - Last updated: December 23, 2002
+Installing GNU Classpath - Last updated: April 30, 2004
 
 First, this is a development release only! Unless you are interested in
 active development and debugging, or just like running random alpha code,
@@ -6,7 +6,8 @@
 list of VMs that work with GNU Classpath.
 
 Note that if you are building from a non-released (CVS) version of GNU
-classpath, installation instructions are found in the HACKING file.
+classpath, installation instructions are found in the doc/hacking.texi
+file. Or at http://www.gnu.org/software/classpath/docs/hacking.html
 
 ------------------------------------------------------------------
 Suggested Software
@@ -18,19 +19,19 @@
         if changes are made that require rebuilding configure, Makefile.in,
         aclocal.m4, or config.h.in.
 
-        - GNU autoconf 2.59
-        - GNU automake 1.7
-        - GNU libtool 1.4.2
+        - GNU autoconf 2.59+
+        - GNU automake 1.7+
+        - GNU libtool 1.4.2+
+
+       When working from CVS you can run the above tools by executing
+       ./autogen.sh in the source directory.
 
        For building the Java bytecode (.class files), one of these
        compilers are required.  You can select which compiler using
        --with-jikes, --with-gcj or --with-kjc as argument to
-       configure; the present default is gcj.  The javac compiler
-       included in any of Sun's JDKs will not work, as it will not
-       compile java.lang.Object.
+       configure; the present default is gcj.
 
-        - GCJ 3.3+ (part of the GNU GCC package).  Note that GCC
-         3.4 (from CVS) is currently unreleased.  
+        - GCJ 3.3+ (part of the GNU GCC package).
         - IBM jikes 1.18+.  
         - The kjc compiler is supported with configure but we have
           been unable to successfully compile with it.
@@ -38,9 +39,11 @@
        For building the JNI native libraries, the following are required
         unless --disable-gtk-peer is used as an argument to configure.
 
-        - GTK+ 2.x.x
+        - GTK+ 2.2.x (or higher)
         - libart_lgpl 2.1.0
-        - gdk-pixbuf (Only needed if you want to compile the native library)
+        - gdk-pixbuf
+
+       For building the documentation you will need texinfo 4.2 or higher.
 
 This package was designed to use the GNU standard for configuration
 and makefiles.  To build and install do the following:
@@ -84,8 +87,7 @@
 export LD_LIBRARY_PATH CLASSPATH
 
 More information about the VMs that use GNU Classpath can be found in the
-README file. Information on using the above setup with the ORP VM can be
-found at <http://www.gnu.org/software/classpath/doc/orp.html>.
+README file.
 
 ------------------------------------------------------------------
 Misc. Notes

signature.asc
Description: This is a digitally signed message part