[m-dev.] diff: clarify documentation about grade options

[Fergus Henderson]

On 21-Apr-1999, Erwan Jahier <Erwan.Jahier at irisa.fr> wrote:
> >From the "preparing a program for debugging" section:
> 
> 	The simpler way is to compile a program in a debugging grade, which you can do
> 	directly by specifying a grade that includes the word "debug" (e.g.
> 	`asm_fast.gc.debug'), or indirectly by specifying the `--debug' grade option to
> 	the compiler, linker, c2init and other tools.
>             ^^^^^^^^
> So you mean that the "compiler" here refers to the C compiler and not mmc? 

Estimated hours taken: 0.25

doc/user_guide.texi:
	Clarify which scripts need to be passed the grade options.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.166
diff -u -r1.166 user_guide.texi
--- user_guide.texi	1999/04/16 04:34:34	1.166
+++ user_guide.texi	1999/04/21 10:29:31
@@ -485,7 +485,8 @@
 
 @item GRADEFLAGS and EXTRA_GRADEFLAGS
 Compilation model options (@pxref{Compilation model options})
-to pass to the Mercury compiler, linker, and other tools.
+to pass to the Mercury compiler, linker, and other tools
+(in particular @code{mmc}, @code{mgnuc}, @code{ml}, and @code{c2init}).
 
 @item MCFLAGS and EXTRA_MCFLAGS
 Options to pass to the Mercury compiler.
@@ -945,7 +946,8 @@
 which you can do directly by specifying a grade
 that includes the word ``debug'' (e.g. @samp{asm_fast.gc.debug}),
 or indirectly by specifying the @samp{--debug} grade option
-to the compiler, linker, c2init and other tools.
+to the compiler, linker, and other tools
+(in particular @code{mmc}, @code{mgnuc}, @code{ml}, and @code{c2init}).
 If you follow this way,
 and accept the default settings of the various compiler options
 that control the selection of trace events (which are described below),
@@ -2799,10 +2801,12 @@
 link time, typically of the form @samp{undefined symbol MR_grade_ at dots{}}
 or @samp{symbol MR_runtime_grade multiply defined}.)
 
-The options below must be passed to @samp{mgnuc} and @samp{ml} as well
-as to @samp{mmc}.  If you are using Mmake, then you should specify
+The options below must be passed to @samp{mgnuc}, @samp{c2init}
+and @samp{ml} as well as to @samp{mmc}. 
+If you are using Mmake, then you should specify
 these options in the @samp{GRADEFLAGS} variable rather than specifying
-them in @samp{MCFLAGS}, @samp{MGNUCFLAGS}, and @samp{MLFLAGS}.
+them in @samp{MCFLAGS}, @samp{MGNUCFLAGS}, @samp{C2INITFLAGS}
+and @samp{MLFLAGS}.
 
 @table @asis
 @item @code{-s @var{grade}}

-- 
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.
--------------------------------------------------------------------------
mercury-developers mailing list
Post messages to:       mercury-developers at cs.mu.oz.au
Administrative Queries: owner-mercury-developers at cs.mu.oz.au
Subscriptions:          mercury-developers-request at cs.mu.oz.au
--------------------------------------------------------------------------