diff: changes to README files

Fergus Henderson fjh at cs.mu.OZ.AU
Thu Sep 3 23:36:52 AEST 1998


Various changes to the README files, in preparation for the next release.

.README.in:
	Update version numbers and copyright dates.
	Update the list of README.* files.

README.HPUX:
	New file.

README.AIX:
	Update to reflect recent bug fix.

README.Linux:
	Delete an obsolete patch at the end of this file;
	the text describing this patch had been removed already.

README.MS-Windows:
	Mention that we haven't tested it on Windows 98.

NEWS:
	We've updated to Boehm GC version 4.13alpha2.

extras/README:
	Add descriptions of each subdirectory.

Index: .README.in
===================================================================
RCS file: /home/mercury1/repository/mercury/.README.in,v
retrieving revision 1.6
diff -u -r1.6 .README.in
--- .README.in	1997/11/23 08:20:45	1.6
+++ .README.in	1998/09/03 12:32:56
@@ -2,7 +2,7 @@
 Mercury compiler, version @VERSION at .
 
 	The Mercury implementation is free software, but it is Copyright
-	(C) 1993-1997 The University of Melbourne.  It is distributed
+	(C) 1993-1998 The University of Melbourne.  It is distributed
 	under the terms of the GNU General Public License.  See the file
 	COPYING for copying permission.
 
@@ -15,11 +15,13 @@
 	contact us!  We are willing to offer alternative arrangements,
 	if the need should arise.
 	
-The subdirectory `boehm_gc' contains a slightly modified version 4.12 of
-the conservative garbage collector distributed by Hans Boehm:
+The subdirectory `boehm_gc' contains a slightly modified copy of
+version 4.13alpha2 of the conservative garbage collector distributed
+by Hans Boehm:
 
 	Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
 	Copyright (c) 1991-1995 by Xerox Corporation.  All rights reserved.
+	Copyright (c) 1996-1998 by Silicon Graphics.  All rights reserved.
 
 	THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY
 	EXPRESSED OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
@@ -48,7 +50,8 @@
 The files in the `samples' directory are either public domain, or
 distributed under the GNU General Public License.
 
-Some of the files in the `extras' subdirectory have fairly restrictive
+Some of the files in the `extras' subdirectory (which is now distributed
+seperately in the `mercury-extras' package) have fairly restrictive
 copyright licences:  
 
 	The `Togl' library in extras/graphics/Togl-1.2 is copyright by
@@ -63,9 +66,18 @@
 EXPRESSED OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.  See the file COPYING.
 
 See the file INSTALL for installation instructions.
-But first read README.AIX, README.BSDI, README.IRIX-5, README.Linux,
-or README.MS-Windows if you are installing on a machine running
-AIX, BSD Unix, IRIX 5, Linux, or Microsoft Windows respectively.
+But in some cases, additional steps may be needed for particular
+operating systems or particular achitectures, so first read the
+README file for your particular platform, if there is one:
+
+	README.AIX		RS/6000 systems running AIX
+	README.BSDI		The BSDI version of BSD Unix on Intel x86
+	README.IRIX-5		SGI IRIX version 5.x
+	README.Linux		Linux on Intel x86
+	README.Linux-Alpha	Linux on DEC Alpha
+	README.Linux-PPC	Linux on PowerPC
+	README.MS-Windows	Microsoft Windows
+	README.HPUX		HPPA systems running HPUX
 
 The documentation sources are in the `doc' subdirectory.  The installation
 process will install INFO, HTML, and DVI versions in the locations specified
Index: NEWS
===================================================================
RCS file: /home/mercury1/repository/mercury/NEWS,v
retrieving revision 1.115
diff -u -r1.115 NEWS
--- NEWS	1998/09/02 05:23:57	1.115
+++ NEWS	1998/09/03 11:54:30
@@ -460,7 +460,7 @@
   (this port has not been tested well, though). 
   See README.MS-Windows for details.
 
-* We've updated to version 4.12 of the Boehm garbage collector.
+* We've updated to version 4.13alpha2 of the Boehm garbage collector.
 
 * Numerous bug fixes.
 
Index: README.AIX
===================================================================
RCS file: /home/mercury1/repository/mercury/README.AIX,v
retrieving revision 1.4
diff -u -r1.4 README.AIX
--- README.AIX	1998/09/03 06:18:15	1.4
+++ README.AIX	1998/09/03 12:22:54
@@ -1,19 +1,20 @@
 -----------------------------------------------------------------------------
 
-This file lists what you need to do to get Mercury to work on an
+This file documents what you need to do to get Mercury to work on an
 RS/6000 running AIX using GNU C.
 
 Previous versions of Mercury have worked successfully on AIX,
-but Rodney Brown <rodneybrown at pmsc.com> reports that the current
-version does not build correctly out-of-the-box.
-Some additional work will be needed to port the latest version.
-We'd be happy to assist anyone with this, but we can't do it
-ourselves, since we don't have an machine running AIX.
-Donations happily accepted ;-)
+but Rodney Brown <rodneybrown at pmsc.com> reported some problems
+with a recent version.  We believe that we have fixed these problems,
+but we do not have a machine running AIX to test it on, so we do 
+not know if the current version will build correctly out-of-the-box.
+
+If there are any problems remaining, we would be happy to assist
+in resolving them.
 
 -----------------------------------------------------------------------------
 
-1.  Put the following line in the file Mmake.params
+1.  Put the following line in the file Mmake.params:
 
 	EXTRA_CFLAGS=-mminimal-toc
 
@@ -29,31 +30,29 @@
 
 3.  Follow the instructions in the INSTALL file.
 
-4.  From a previous report, this will result in a link error about
-    some undefined symbols when linking the compiler.  Debug the cause
-    of this link error, fix it, and send us the patch.  (As noted
-    previously, we'd be happy to offer assistance with this task. 
-    In fact we'd do it ourselves, but we don't have an AIX machine.
-    Donations happily accepted.)
-
 The last version of Mercury which was known to work on AIX was
 Mercury 0.6 -- actually a version just prior to 0.6, namely
 the 30Apr1996 development snapshot (the source for this version
 and a binary distribution of this version for AIX are still
 available from <ftp://turiel.cs.mu.oz.au/pub/mercury/old-releases>).
 That version was verified to work on AIX 4.1.3 using GNU C 2.7.2.
-For that version, the following additional step was needed.
+For that version, following the steps above would result in
+an error message from the assembler, so the following additional
+step was needed.
 
-1b. Change directory to the `compiler' directory, and run the command
+4. Change directory to the `compiler' directory, and run the command
 
 	sh ../scripts/rs6000_hack
 
-    This works around a fixed limit of 32k on the size of relative jumps
-    in the RS/6000 object file format.
+   Then continue following the instructions in the INSTALL file.
+
+   This works around a fixed limit of 32k on the size of relative jumps
+   in the RS/6000 object file format.
 
-It is possible that something similar to step 1b will still be needed,
+It is possible that something similar to this will still be needed,
 but the rs6000_hack script no longer works as is, so a little more
-hacking will be needed if that is the case.  (Again, we'd be happy
-to offer our assistance.)
+hacking will be needed if that is the case. 
+(We'd be happy to offer assistance with this task.  Indeed, we'd do it
+ourselves, but we don't have an AIX machine -- donations happily accepted ;-)
 
 -----------------------------------------------------------------------------
Index: README.HPUX
===================================================================
RCS file: README.HPUX
diff -N README.HPUX
--- /dev/null	Thu Sep  3 23:05:00 1998
+++ README.HPUX	Thu Sep  3 23:21:05 1998
@@ -0,0 +1,6 @@
+Mercury installs fine out-of-the-box on HPUX 10.20, according to
+Rodney Brown <rodneybrown at pmsc.com>.  However, you may need to
+use an egcs release (see <http://egcs.cygnus.com>) instead of
+standard gcc.  I belive Rodney Brown used an egcs snapshot
+slightly prior to egcs version 1.1, so it should probably work
+fine with egcs version 1.1.
Index: README.Linux
===================================================================
RCS file: /home/mercury1/repository/mercury/README.Linux,v
retrieving revision 1.10
diff -u -r1.10 README.Linux
--- README.Linux	1998/05/31 03:58:53	1.10
+++ README.Linux	1998/09/03 11:59:19
@@ -42,16 +42,3 @@
 offset table pointer register in PIC code.  If only the Intel
 architecture wasn't so register-starved, we wouldn't need to use `ebx',
 and then PIC and non-PIC code could be mixed without any problems.)
-
---------------------
-
---- os_dep.c	Tue Feb 10 15:37:42 1998
-+++ new/os_dep.c	Tue Feb 10 16:04:24 1998
-@@ -38,6 +38,7 @@
-       /* 10-Feb-1998 Modified to use autoconf to handle this for      */
-       /*             Mercury -- Tyson Dowd <trd at cs.mu.oz.au>          */
- #     ifdef MERCURY_LINUX_NEED_ASM_SIGCONTEXT
-+/*** #     include <asm/sigcontext.h> ***/
- #        include <asm/sigcontext.h>
- #     endif
- #   endif
Index: README.MS-Windows
===================================================================
RCS file: /home/mercury1/repository/mercury/README.MS-Windows,v
retrieving revision 1.10
diff -u -r1.10 README.MS-Windows
--- README.MS-Windows	1998/07/30 15:03:18	1.10
+++ README.MS-Windows	1998/09/03 12:27:50
@@ -4,6 +4,7 @@
 
 Mecury has been ported to Windows 95 and Windows NT
 using the gnu-win32 Unix emulation package from Cygnus.
+It may well work on Windows 98 too, but we haven't tested that.
 
 This file documents how to build the source distribution
 of Mercury on Windows 95 or Windows NT using gnu-win32.
Index: extras/README
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/README,v
retrieving revision 1.1
diff -u -r1.1 README
--- README	1997/07/04 12:21:36	1.1
+++ README	1998/09/03 13:09:41
@@ -1,3 +1,28 @@
 This directory contains various additional libraries, tools,
 and so forth that are not part of the Mercury standard library.
 
+cgi		A couple of Mercury library modules for doing HTML forms
+		programming using CGI (Common Gateway Interface).
+
+clpr		A Mercury interface to the CLP(R) constraint solver,
+		for solving arithmetic constraints on (floating point)
+		real numbers.
+
+complex_numbers
+		A Mercury library package containing support for
+		complex and imaginary numbers.
+
+exceptions	A library module containing a (tentative)
+		exception handling interface for Mercury.
+
+graphics	A couple of packages for doing graphics programming
+		and GUIs in Mercury: a Mercury interface to tcl/tk
+		and a Mercury binding to OpenGL.
+
+odbc		A Mercury interface to ODBC (Open DataBase Connectivity,
+		I think), for interfacing to standard relational
+		database packages.
+
+references	A library package containing modules for manipulating
+		ML-style references (mutable state).
+

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
WWW: <http://www.cs.mu.oz.au/~fjh>  |  of excellence is a lethal habit"
PGP: finger fjh at 128.250.37.3        |     -- the last words of T. S. Garp.



More information about the developers mailing list