[m-rev.] diff: update developer documentation

[Fergus Henderson]

Estimated hours taken: 0.5
Branches: main

Updates to the developer documentation.

w3/information/developers/developer_intro.html:
	- mention the `lml' script
	- mention the `submit_patch' script

w3/information/developers/remote_cvs.html:
	- update the name of the repository directory for the mercury-gcc
	  distribution
	- mention the `mercury-reviews' mailing list

Workspace: /home/ceres/fjh/mercury
Index: w3/information/developers/developer_intro.html
===================================================================
RCS file: /home/mercury1/repository/w3/information/developers/developer_intro.html,v
retrieving revision 1.1
diff -u -d -p -r1.1 developer_intro.html
--- w3/information/developers/developer_intro.html	17 Jan 2001 00:49:47 -0000	1.1
+++ w3/information/developers/developer_intro.html	22 Sep 2002 22:02:00 -0000
@@ -7,7 +7,6 @@
 
 <h2>An introduction to the Mercury source code and tools</h2>
 
-Author: Tyson Dowd -- trd at cs.mu.oz.au 
 <p>
 
 The source code to Mercury is freely available and may be modified by
@@ -26,8 +25,8 @@ Other useful documents are in the 
 of the web site.  In particular you may wish to see how to access the
 Mercury CVS repository and read about the design of the Mercury compiler. 
 <p>
-This document is a work-in-progress, if there is particular information
-you feels is useful, please let me know and I will write something about
+This document is a work-in-progress; if there is particular information
+you feel is useful, please let us know and we will write something about
 it.
 
 <h2>About grades</h2>
@@ -121,6 +120,18 @@ See the tools/lmc file for further docum
 also run the compiler under gdb or compile programs suitable for C level
 debugging.
 
+<p>
+There is also a script in the tools directory called `lml',
+which is similar to `lmc' except that it runs `ml' rather than `mmc'.
+You can use these with mmake:
+<pre>
+mmake MC=lmc ML=lml ...
+</pre>
+However, this will still use the installed version of `mmake',
+`c2init'/`mkinit', `mgnuc', etc.  So it isn't entirely foolproof.
+If you've made changes to the scripts, it may be best to install
+rather than trying to use the local build directory.
+
 <h2>Bootchecking</h2>
 
 If you've made changes to the compiler or library that you think are
@@ -167,6 +178,13 @@ to a file.  For example:
 ./tools/bootcheck > bootchecklog.Jan21 2>&1 &
 tail -f bootchecklog.Jan21
 </pre>
+
+There is also a script tools/submit_patch, which can be used for
+testing and/or committing patches.  It takes as input a file containing
+a CVS log message and a patch file.  It checks out the Mercury sources,
+applies the patch file, and then tests the patch by running a couple of
+bootchecks in different grades.  If you specified the `--commit' option,
+and the tests pass, it then goes ahead and commits the patch.
 
 <p>
 <hr>
Index: w3/information/developers/remote_cvs.html
===================================================================
RCS file: /home/mercury1/repository/w3/information/developers/remote_cvs.html,v
retrieving revision 1.6
diff -u -d -p -r1.6 remote_cvs.html
--- w3/information/developers/remote_cvs.html	4 Mar 2002 06:04:25 -0000	1.6
+++ w3/information/developers/remote_cvs.html	22 Sep 2002 22:10:44 -0000
@@ -165,7 +165,7 @@ Then (once your account is set up):
 		<dl>
 	  	<dt>mercury	<dd> the mercury compiler, runtime, library,
 				  extras and documentation. (8.9Mb)
-	  	<dt>gcc/mercury	<dd> the mercury-gcc distribution;
+	  	<dt>mercury-gcc	<dd> the mercury-gcc distribution;
 				  this contains part of the source for the
 				  <a href="http://www.mercury.cs.mu.oz.au/download/gcc-backend.html">native code
 				  back-end</a>
@@ -179,13 +179,18 @@ Then (once your account is set up):
 
 NOTE:
 <ul>
-	<li> Developers should subscribe to the mercury-developers mailing
-	  list, to keep up-to-date on development discussion, and 
+	<li> All developers should subscribe to the mercury-developers
+	  mailing list.  Serious developers should also subscribe to the
+	  mercury-reviews mailing list,
+	  to keep up-to-date on development discussion, and 
 	  to be able to participate in discussions about code they
-	  want to change. This is a forum to ask questions about how
-	  to change something, discuss design trade-offs, and report
-	  on any development that you suspect will influence others.
-	  (Traffic is moderately high in this mailing list - between
+	  want to change.  The mercury-developers list is a forum to ask
+	  questions about how to change something, discuss design trade-offs,
+	  and report on any development that you suspect will influence others.
+	  The mercury-reviews list is used for posting and reviewing diffs,
+	  although it often also contains design discussions about issues
+	  that have arisen during code review.
+	  (Traffic on mercury-reviews is moderately high - between
 	  100 and 300 messages per month, so you should filter into
 	  a separate folder if possible).
 

-- 
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
--------------------------------------------------------------------------