[m-rev.] for review: add index to user guide

[Fergus Henderson]

I've fixed all of the things raised in Simon's comments.
I'll go ahead and commit this now.

On 05-Jun-2001, Simon Taylor <stayl at cs.mu.OZ.AU> wrote:
> 
> s/CFLAGS/MCFLAGS/

Done.

> > + at findex intermodule-optimization
> 
> --intermodule-optimization

Done.

> > @@ -1049,6 +1199,8 @@
> > + at cindex call
> 
> This should be `call (trace event)'.

Done (and likewise for the other trace events).

> > + at cindex strict commands
> 
> `strict debugger commands'

Done.

> > @@ -1626,6 +1803,7 @@
> >  changes the environment yet again or execution continues to another event.
> >  @sp 1
> >  @item procedure specification
> > + at cindex procedure specification
> 
> `debugger procedure specification' or `procedure specification (mdb)'.

Done (both ways).

> > + at findex -C
> 
> This should be `-C (runtime option)'.

Done (and likewise for the other MERCURY_OPTIONS settings).


Here's a relative diff.

--- user_guide.texi.old	Tue Jun  5 21:14:44 2001
+++ user_guide.texi	Tue Jun  5 22:01:48 2001
@@ -601,7 +601,7 @@
 (in particular @code{mmc}, @code{mgnuc}, @code{ml}, and @code{c2init}).
 
 @item MCFLAGS and EXTRA_MCFLAGS
- at vindex CFLAGS
+ at vindex MCFLAGS
 @vindex EXTRA_CFLAGS
 Options to pass to the Mercury compiler.
 (Note that compilation model options should be
@@ -937,7 +937,7 @@
 @vindex MLLIBS
 @vindex C2INITARGS
 @vindex MGNUCFLAGS
- at findex intermodule-optimization
+ at findex --intermodule-optimization
 To use a library, you need to set the Mmake variables @samp{VPATH},
 @samp{MCFLAGS}, @samp{MLFLAGS}, @samp{MLLIBS}, and @samp{C2INITARGS}
 to specify the name and location of the library or libraries that you
@@ -1330,10 +1330,12 @@
 The four kinds of events supported by most Prolog systems (their @emph{ports})
 are
 
- at cindex call
- at cindex exit
- at cindex redo
- at cindex fail
+ at cindex debugger trace events
+ at cindex trace events
+ at cindex call (trace event)
+ at cindex exit (trace event)
+ at cindex redo (trace event)
+ at cindex fail (trace event)
 @table @emph
 @item call
 A call event occurs just after a procedure has been called,
@@ -1391,10 +1393,10 @@
 Each of these internal event types has an associated parameter called a path.
 The internal event types are:
 
- at cindex then
- at cindex else
- at cindex disj
- at cindex switch
+ at cindex then (trace event)
+ at cindex else (trace event)
+ at cindex disj (trace event)
+ at cindex switch (trace event)
 @table @emph
 @item then
 A then event occurs when execution reaches
@@ -1528,6 +1530,7 @@
 which of three trace levels, @samp{none}, @samp{shallow} and @samp{deep},
 you want to compile them with:
 
+ at cindex debugger trace level
 @cindex trace level
 @cindex shallow tracing
 @cindex deep tracing
@@ -1707,6 +1710,7 @@
 
 @table @emph
 @item break points
+ at cindex debugger break points
 @cindex break points
 @cindex spy points
 The user may associate a break point
@@ -1746,7 +1750,7 @@
 Neither of these will happen if the break point is disabled.
 @sp 1
 @item strict commands
- at cindex strict commands
+ at cindex strict debugger commands
 When a debugger command steps over some events
 without user interaction at those events,
 the @emph{strictness} of the command controls whether
@@ -1803,7 +1807,8 @@
 changes the environment yet again or execution continues to another event.
 @sp 1
 @item procedure specification
- at cindex procedure specification
+ at cindex procedure specification (in mdb)
+ at cindex debugger procedure specification
 Some debugger commands, e.g. @samp{break},
 require a parameter that specifies a procedure.
 Such a procedure specification has
@@ -5441,7 +5446,7 @@
 @c by mercury_engine.c was actually used.
 
 @item -C @var{size}
- at findex -C
+ at findex -C (runtime option)
 Tells the runtime system
 to optimize the locations of the starts of the various data areas
 for a primary data cache of @var{size} kilobytes.
@@ -5449,7 +5454,7 @@
 to differ as much as possible modulo this size.
 
 @c @item -d @var{debugflag}
- at c @findex -d
+ at c @findex -d (runtime option)
 @c Sets a low-level debugging flag.
 @c These flags are consulted only if
 @c the runtime was compiled with the appropriate definitions;
@@ -5460,7 +5465,7 @@
 
 @sp 1
 @item -D @var{debugger}
- at findex -D
+ at findex -D (runtime option)
 Enables execution tracing of the program,
 via the internal debugger if @var{debugger} is @samp{i}
 and via the external debugger if @var{debugger} is @samp{e}.
@@ -5469,30 +5474,30 @@
 
 @sp 1
 @item -p
- at findex -p
+ at findex -p (runtime option)
 Disables profiling.
 This only has an effect if the executable was built in a profiling grade.
 
 @sp 1
 @item -P @var{num}
- at findex -P
+ at findex -P (runtime option)
 Tells the runtime system to use @var{num} threads
 if the program was built in a parallel grade.
 
 @c @item -r @var{num}
- at c @findex -r
+ at c @findex -r (runtime option)
 @c Repeats execution of the entry point procedure @var{num} times,
 @c to enable accurate timing.
 
 @c @item -t
- at c @findex -t
+ at c @findex -t (runtime option)
 @c Tells the runtime system to measure the time taken by
 @c the (required number of repetitions of) the program,
 @c and to print the result of this time measurement.
 
 @sp 1
 @item -T @var{time-method}
- at findex -T
+ at findex -T (runtime option)
 If the executable was compiled in a grade that includes time profiling,
 this option specifies what time is counted in the profile.
 @var{time-method} must have one of the following values:
@@ -5514,22 +5519,22 @@
 @c the above sentence is duplicated above
 
 @c @item -x
- at c @findex -x
+ at c @findex -x (runtime option)
 @c Tells the Boehm collector not to perform any garbage collection.
 
 @sp 1
 @item --heap-size @var{size}
- at findex --heap-size
+ at findex --heap-size (runtime option)
 Sets the size of the heap to @var{size} kilobytes.
 
 @sp 1
 @item --detstack-size @var{size}
- at findex --detstack-size
+ at findex --detstack-size (runtime option)
 Sets the size of the det stack to @var{size} kilobytes.
 
 @sp 1
 @item --nondetstack-size @var{size}
- at findex --nondetstack-size
+ at findex --nondetstack-size (runtime option)
 Sets the size of the nondet stack to @var{size} kilobytes.
 
 @sp 1
@@ -5540,29 +5545,29 @@
 
 @c @sp 1
 @c @item --heap-redzone-size @var{size}
- at c @findex --heap-redzone-size
+ at c @findex --heap-redzone-size (runtime option)
 @c Sets the size of the redzone on the heap to @var{size} kilobytes.
 
 @c @sp 1
 @c @item --detstack-redzone-size @var{size}
- at c @findex --detstack-redzone-size
+ at c @findex --detstack-redzone-size (runtime option)
 @c Sets the size of the redzone on the det stack to @var{size} kilobytes.
 
 @c @sp 1
 @c @item --nondetstack-redzone-size @var{size}
- at c @findex --nondetstack-redzone-size
+ at c @findex --nondetstack-redzone-size (runtime option)
 @c Sets the size of the redzone on the nondet stack to @var{size} kilobytes.
 
 @c @sp 1
 @c @item --trail-redzone-size @var{size}
- at c @findex --trail-redzone-size
+ at c @findex --trail-redzone-size (runtime option)
 @c Sets the size of the redzone on the trail to @var{size} kilobytes.
 
 @sp 1
 @item -i @var{filename}
 @itemx --mdb-in @var{filename}
- at findex -i
- at findex --mdb-in
+ at findex -i (runtime option)
+ at findex --mdb-in (runtime option)
 Read debugger input from the file or device specified by @var{filename},
 rather than from standard input.
 
@@ -5570,23 +5575,23 @@
 @item -o @var{filename}
 @itemx --mdb-out @var{filename}
 Print debugger output to the file or device specified by @var{filename},
- at findex -o
- at findex --mdb-out
+ at findex -o (runtime option)
+ at findex --mdb-out (runtime option)
 rather than to standard output.
 
 @sp 1
 @item -e @var{filename}
 @itemx --mdb-err @var{filename}
- at findex -e
- at findex --mdb-err
+ at findex -e (runtime option)
+ at findex --mdb-err (runtime option)
 Print debugger error messages to the file or device specified by @var{filename},
 rather than to standard error.
 
 @sp 1
 @item -m @var{filename}
 @itemx --mdb-tty @var{filename}
- at findex -m
- at findex --mdb-tty
+ at findex -m (runtime option)
+ at findex --mdb-tty (runtime option)
 Redirect all three debugger I/O streams -- input, output, and error messages --
 to the file or device specified by @var{filename}.
 

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
                                    |  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
--------------------------------------------------------------------------