[m-rev.] For review: README files for Java/DotNet

[Fergus Henderson]

Hi James,

I noticed that you didn't post the final relative diff for the README.Java
file.  Please do post diffs for all your changes, including those in response
to earlier review comments.

In particular I notice that you added a new FAQ question:

 | Q. So how do I enable Java-level debugging?
 | 
 | A. By default, javac already generates line number and source file debugging
 |    information.  You can include local variable debugging information by
 |    specifying "-g" as part of the "--java-flags" flag when invoking the
 |    mercury compiler.  eg:
 | 
 |    mmc --make --grade java --java-flags "-g" <progname>
 | 
 |    You can then use Sun's "jdb" debugging tool, which comes
 |    as part of the Java SDK distribution, to debug your program.  For more
 |    information, refer to the documentation for javac and jdb.

Rather than using "--java-flags -g", the documentation should
suggest using "--target-debug".

Also s/mercury compiler/Mercury compiler/

I have applied these suggestions, as well as a few other minor wording
changes.  See below.

--

Estimated hours taken: 0.5
Branches: main

README.Java:
	A few minor wording changes.  Suggest using `--target-debug'
	rather than `--java-flags "-g"' to enable Java-level debugging.

Workspace: /home/jupiter/fjh/ws-jupiter/mercury
Index: README.Java
===================================================================
RCS file: /home/mercury1/repository/mercury/README.Java,v
retrieving revision 1.1
diff -u -d -r1.1 README.Java
--- README.Java	2 Feb 2004 03:16:35 -0000	1.1
+++ README.Java	7 Feb 2004 06:15:16 -0000
@@ -2,8 +2,8 @@
 
 INTRODUCTION
 
-This release of Mercury contains a port to Sun Microsystems' Java 2 Platform,
-Standard Edition (J2SE).
+This release of Mercury contains a port to Java,
+in particular to Sun Microsystems' Java 2 Platform, Standard Edition (J2SE).
 The Mercury compiler will generate Java source code that can be compiled into
 Java bytecode suitable for running in the J2SE runtime system.
 
@@ -37,17 +37,17 @@
 bytecode.  Support for building and installation of this grade
 is still somewhat rudimentary.
 
-To run a Mercury program using the java grade, you need to build the
+To run a Mercury program using the java grade, you need to build the Mercury
 library and runtime in the java grade, using the Mercury source distribution.
 
 You will also need to set the environment variable CLASSPATH to include the
 mercury standard and runtime libraries for java, as well as the current
 directory.  You should use a command of the form:
 
-	CLASSPATH=<prefix>/mer_std.jar:<prefix>/mer_std.runtime.jar:. ; \
+	CLASSPATH=<prefix>/mer_std.jar:<prefix>/mer_std.runtime.jar:.
 	export CLASSPATH
 
-Where <prefix> is the location of the installed jar files, which will probably
+where <prefix> is the location of the installed jar files, which will probably
 be /usr/local/mercury/lib/mercury/lib/java or something similar.
 
 You can now build programs such as hello.m or calculator.m in the samples
@@ -84,7 +84,7 @@
 you can then call the predicate to_string exactly the same as if it were
 implemented using pure mercury code.
 
-For more information about the foreign language interface, refer to the Mercury
+For more information about the foreign language interface, see the Mercury
 Language Reference Manual, which you can find at:
 	<http://www.cs.mu.oz.au/mercury/information/documentation.html>
 
@@ -141,13 +141,18 @@
 
 A. By default, javac already generates line number and source file debugging
    information.  You can include local variable debugging information by
-   specifying "-g" as part of the "--java-flags" flag when invoking the
-   mercury compiler.  eg:
+   specifying "--target-debug" when invoking the Mercury compiler, or by
+   setting the JAVACFLAGS variable to include "-g" when invoking mmake,
+   e.g.
 
-   mmc --make --grade java --java-flags "-g" <progname>
+        mmc --make --grade java --target-debug <progname>
+
+   or
+   	
+	mmake GRADE=java JAVACFLAGS=-g <progname>
 
    You can then use Sun's "jdb" debugging tool, which comes
-   as part of the Java SDK distribution, to debug your program.  For more
-   information, refer to the documentation for javac and jdb.
+   as part of the Java SDK distribution, to debug your program.
+   For more information, see the documentation for javac and jdb.
 
 -----------------------------------------------------------------------------

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
The University of Melbourne         |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------