[m-rev.] for review: readme updates

Peter Wang novalazy at gmail.com
Wed Jan 22 11:55:16 AEDT 2020


Feel free to shoot down any of these changes you disagree with.

Peter


diff --git a/.README.in b/.README.in
index 254714699..464c4e6ce 100644
--- a/.README.in
+++ b/.README.in
@@ -1,5 +1,5 @@
-This directory contains the source distribution for the University of Melbourne
-Mercury compiler, version @VERSION at .
+This directory contains the source distribution for the
+Melbourne Mercury compiler, version @VERSION at .

 See the file LICENSE for copyright and licensing information.

@@ -8,7 +8,7 @@ In some cases, additional steps may be needed for particular operating systems
 or particular architectures, so first read the README file for your particular
 platform, if there is one:

-	README.AIX		RS/6000 systems running AIX
+	README.AIX		AIX on POWER
 	README.FreeBSD		FreeBSD on Intel x86 and x86_64
 	README.HPUX		HPPA systems running HPUX
 	README.Linux		Linux on Intel x86 and x86_64
@@ -20,14 +20,11 @@ platform, if there is one:
 	README.OpenBSD		OpenBSD on x86_64
 	README.Solaris		Solaris (SunOS) on SPARC or Intel x86.

-The documentation sources are in the `doc' subdirectory.  The installation
-process will install INFO, HTML, and DVI versions in the locations specified
-in the file Mmake.common - by default these locations are
-/usr/local/mercury- at VERSION@/info,
-/usr/local/mercury- at VERSION@/lib/mercury/html,
-and /usr/local/mercury- at VERSION@/lib/mercury/doc respectively.
-The installation process will also install Unix-style man pages -
-by default they will be installed in /usr/local/mercury- at VERSION@/man/man1.
+The documentation sources are in the `doc' subdirectory.
+The installation process will install INFO, HTML, and DVI versions under the
+nominated installation prefix, by default /usr/local/mercury- at VERSION@.
+It will also install Unix-style man pages under the same prefix.
+
 The files RELEASE_NOTES, NEWS, HISTORY, LIMITATIONS, and BUGS
 also contain useful information.  If you're interested in looking
 at the source code, the file compiler/notes/compiler_design.html is
@@ -37,19 +34,6 @@ The `samples' directory contains some example Mercury programs.
 There are also some additional Mercury programs and libraries
 in the `extras' directory.

-For more information about Mercury, see the Mercury WWW home page at
-<http://www.mercurylang.org>, or send mail to mercury at mercurylang.org.
-
-If you would like to join the Mercury mailing lists (there are two,
-mercury-users for general discussion, and mercury-announce for
-announcements), see the instructions at <http://lists.mercurylang.org>.
-
-Please send bug reports, enhancement requests, suggestions for improvements,
-and any other feedback to bugs at mercurylang.org or mercury at mercurylang.org.
-If you find something you don't like, please tell us.
-If you find something you do like, please tell the world!
-
-The Mercury distribution is available via HTTP from the following location:
-
-	http://dl.mercurylang.org/index.html
-
+The Mercury home page is located at <https://www.mercurylang.org>.
+There you can also find information about joining the mailing lists
+for announcements and general discussion.
diff --git a/BUGS b/BUGS
index ef1bc42d7..cb377f05c 100644
--- a/BUGS
+++ b/BUGS
@@ -1,14 +1,11 @@
-Bugs can be reported via the Mercury bug tracking system at
-<https://bugs.mercurylang.org>.  We use the Mantis bug tracking software.
-You will need to login in order to access the bug tracking system.
-If you do not have an account, you can create one by clicking on the
-``Signup for a new account'' link at the bottom of the login page and
-following the instructions.
+The Mercury bug tracking system is located at <https://bugs.mercurylang.org>.
+To report a bug, first create an account by clicking on the
+``Signup for a new account'' link at the top of each page.
+You do not need to create an account to view existing bug reports.

-Alternatively, you may email bug reports to bugs at mercurylang.org.
-If you are reporting more than one bug, please use separate emails for each
-bug.  (If it's something that only shows up in multi-module programs, send
-a shar archive or uuencoded tar archive including your source files.)
+You may also email bug reports to bugs at mercurylang.org.
+Please use separate emails for each bug, and attach a source file,
+tar/zip file containing the source files demonstrating the bug.

 Please include the following information in your bug report:

@@ -25,8 +22,5 @@ Please try to ensure that bug report contains all the information that we need t
 be able to reproduce the problem.  Make sure that all bug reports are fully
 self-contained.

-The bug tracking system contains a current list of known outstanding bugs.
-Some other problems related to using Mercury on specific operating systems are
-described in the README.* files.
-
-See also the LIMITATIONS file.
+Some known problems related to using Mercury on specific operating systems are
+described in the README.* files. See also the LIMITATIONS file.
diff --git a/README.Erlang b/README.Erlang
index 591f17d00..afc8a65f4 100644
--- a/README.Erlang
+++ b/README.Erlang
@@ -10,7 +10,7 @@ system.
 WARNING

 The Erlang backend is incomplete, and will not see any more work in
-the future.
+the future. It has not been tested for version 20.01 of the Mercury system.

 Large parts of the Mercury standard library are not yet implemented.
 Some RTTI related features are incompletely or incorrectly implemented.
diff --git a/README.HPUX b/README.HPUX
index 77fec9f14..77caf1251 100644
--- a/README.HPUX
+++ b/README.HPUX
@@ -2,6 +2,3 @@
 Mercury has not been tested on HP-UX since 1998.  We are unaware if it works.
 If you have experience with recent versions of Mercury on HP-UX please let us
 know.
-
-Contact information:
-http://www.mercurylang.org/contact.html
diff --git a/README.Linux b/README.Linux
index 84e03235a..8ceefad6f 100644
--- a/README.Linux
+++ b/README.Linux
@@ -4,9 +4,6 @@ For the Linux/Alpha port, see README.Linux-Alpha.
 (Ports to Linux on other architectures have not yet
 been attempted, but should not be difficult.)

-Linux systems that produce executables in a.out format are not supported by
-the Mercury compiler.
-

 BUILDING A 32-BIT MERCURY COMPILER ON 64-BIT LINUX
 ==================================================
diff --git a/README.Linux-PPC b/README.Linux-PPC
index 6288dec15..4e2628e18 100644
--- a/README.Linux-PPC
+++ b/README.Linux-PPC
@@ -1,3 +1,8 @@
+
+NOTE: we do not know if the Linux/PPC port has been tested since 1998.
+
+----------------------------------------------------------------------
+
 Mercury should build "out-of-the-box" on Linux for PPC.
 Thanks to Robert A. Abernathy for his help with this port.

diff --git a/README.Solaris b/README.Solaris
index 1c3e409d9..6cc4a2e33 100644
--- a/README.Solaris
+++ b/README.Solaris
@@ -1,7 +1,6 @@
-Mercury 0.13 may not work on Solaris 10 (SunOS 5.10) due to incompatibilities
-with the version of Boehm GC shipped with that version of Mercury.

-(The above problem has been fixed in post-0.13 versions of Mercury.)
+An older version of the Mercury system was previously tested on
+Solaris 10 (SunOS 5.10); we do not know if it still works.

-Also, note that `--linkage static' is not supported on Solaris.  Executables
+Note that `--linkage static' is not supported on Solaris.  Executables
 produced using this option will cause a segmentation fault.



More information about the reviews mailing list