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

[Erwan Jahier]

| I've changed that to the following:
| 
|  | Then start up Emacs, e.g. using the command @samp{emacs},
|  | and type @kbd{M-x mdb @key{RET}}. Emacs will prompt you for
|  | the mdb command to invoke
|  | 
|  | @example
|  | Run mdb (like this): mdb
|  | @end example
|  | 
|  | @noindent
|  | and you should type in the name of the program that you want to debug
|  | and any arguments that you want to pass to it:
|  | 
|  | @example
|  | Run mdb (like this): mdb ./hello arg1 arg2 ...
|  | @end example
| 
| Hopefully that is clearer?

Well, I'm not sure: 
* In your first example "Run mdb (like this)" means: type M-x within emacs, mdb and then RET 
  in the emacs buffer, 
* in your second one,   "Run mdb (like this)" means: type "mdb ./hello arg1 arg2 ..." 
  in the emacs buffer.

It is ok if you already know emacs, but it might(?) be disturbing otherwise 
IMHO.

What about:

|  | Then start up Emacs, e.g. using the command @samp{emacs},
|  | and type @kbd{M-x mdb @key{RET}}. Emacs will prompt you for
|  | the mdb command to invoke and you should type in the name of 
|  | the program that you want to debug and any arguments that 
|  | you want to pass to it:
|  | 
|  | @example
|  | Run mdb (like this): [M-x] 
|  |                         mdb [RET]
|  |                         mdb ./hello arg1 arg2 ... [RET]
|  | @end example

?
-- 
R1.


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