[m-dev.] for review: new debugger command set (part 2 of 4)

[Tyson Dowd]

Please ignore the log message I accidently left in my previous mail.


> Index: doc/mdbrc.in
> ===================================================================
> RCS file: mdbrc.in
> diff -N mdbrc.in
> --- /dev/null	Wed May 28 10:49:58 1997
> +++ mdbrc.in	Wed Sep 16 15:43:29 1998
> @@ -0,0 +1,12 @@
> +source @DEFAULT_MERCURY_DEBUGGER_INIT_DIR@/mdb_doc
> +alias	s	step
> +alias	g	goto
> +alias	f	finish
> +alias	r	retry
> +alias	v	vars
> +alias	p	print *
> +alias	d	stack
> +alias	c	continue
> +alias	b	break
> +alias	h	help
> +alias	?	help

I agree with Fergus that doc is not the right place for this file.

I guess scripts is a reasonable place for it, since it is really an
initialization script for the debugger.

> Index: user_guide.texi
> ===================================================================
> RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
> retrieving revision 1.137
> diff -u -u -r1.137 user_guide.texi
> --- user_guide.texi	1998/10/01 09:12:22	1.137
> +++ user_guide.texi	1998/10/01 09:13:33
> DOCUMENT NEW DEBUG COMMAND SET

> @@ -2760,6 +2769,794 @@
>  @item --link-object @var{object}
>  Link with the specified object file.
>  
> + at end table
> +
> + at node Debugging
> + at chapter Debugging
> +
> + at menu
> +* Tracing of Mercury programs::
> +* Preparing a program for debugging::
> +* Mercury debugger invocation::
> +* Mercury debugger concepts::
> +* Debugger commands::
> + at end menu
> +
> + at node Tracing of Mercury programs
> + at section Tracing of Mercury programs
> +
> +The Mercury debugger is based on a modified version of the box model
> +on which the four-port debuggers of most Prolog systems are based.
> +Such debuggers abstract the execution of a program
> +into a sequence or @emph{trace} of execution events of various kinds.

s/or/of
s/of/or

(you'll know what I mean when you read it).

> + at node Mercury debugger invocation
> + at section Mercury debugger invocation
> +
> +The executables of Mercury programs
> +by default do not invoke the Mercury debugger
> +even if some or all of their modules were compiled with some form of tracing,
> +and even if the grade of the executable includes @code{debug}.
> +This is similar to the behavior of executables
> +created by the implementations of other languages;
> +for example the executable of a C program compiled with -g
> +does not autonomously invoke gdb or dbx etc when it is executed.
> +
> + at example
> +mdb @var{prog} @var{arg1} ...
> + at end example
> +

You need an XXX here -- this isn't quite finished (no explaination of
how mdb is used like gdb, dbx, etc).

Apart from that, it looks fine.

-- 
Those who would give up essential liberty to purchase a little temporary
safety deserve neither liberty nor safety.     - Benjamin Franklin

Tyson Dowd   <tyson at tyse.net>   http://tyse.net