[m-dev.] for review: improve debugger documentation

[Fergus Henderson]

Estimated hours taken: 0.5

doc/user_guide.texi:
	Address zs's review comments on my previous change.

Workspace: /d-drive/home/hg/fjh/mercury
Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.196
diff -u -d -r1.196 user_guide.texi
--- doc/user_guide.texi	1999/12/10 08:33:05	1.196
+++ doc/user_guide.texi	1999/12/10 15:57:20
@@ -928,7 +928,7 @@
 
 To use the debugger, you must
 first compile your program with debugging enabled.
-You can do this by using the @samp{--debug} option to @samp{mdb},
+You can do this by using the @samp{--debug} option to @samp{mmc},
 or by including @samp{GRADEFLAGS = --debug} in your @file{Mmakefile}.
 
 @example
@@ -972,12 +972,13 @@
 
 For each trace event, the debugger prints out several pieces of
 information.  The three numbers at the start of the display are the
-event number, the sequence number, and the call depth. 
+event number, the call sequence number, and the call depth. 
 (You don't really need to pay too much attention to those.)
 They are followed by the event type (e.g. @samp{CALL} or @samp{EXIT}).
-After that comes the module name (@samp{io}),
-procedure name (@samp{write_string}), arity (@samp{3}),
-mode number (@samp{0}), and determinism (@samp{det}).
+After that comes the identification of the procedure
+in which the event occurred, consisting of the module-qualified name
+of the predicate or function to which the procedure belongs,
+followed by its arity, mode number and determinism.
 This may sometimes be followed by a "path"
 (@pxref{Tracing of Mercury programs}).
 At the end is the file name and line number of the
@@ -1067,8 +1068,8 @@
 @end example
 
 Emacs will then create several "buffers": one for the debugger prompt,
-one for the output of the program being executed, and one or more for
-the source files.  By default, Emacs will split the display into two
+one for the input and output of the program being executed, and one or more
+for the source files.  By default, Emacs will split the display into two
 parts, called "windows", so that two of these buffers will be visible.
 You can use the command @kbd{C-x o} to switch between windows,
 and you can use the command @kbd{C-x 2} to split a window into two
@@ -1133,6 +1134,12 @@
 "Data browsing" sub-menu of the "MDB" menu.
 Most of the menu commands also have keyboard short-cuts,
 which are displayed on the menu.
+
+Note that mdb's @samp{context} command should not be used if
+you are using the Emacs interface, otherwise the Emacs
+interface won't be able to parse the file names and
+line numbers that mdb outputs, and so it won't be able to
+highlight the correct location in the source code.
 
 @node Tracing of Mercury programs
 @section Tracing of Mercury programs
-- 
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
--------------------------------------------------------------------------