[m-rev.] diff: document the optional parameter to dd_dd

[Mark Brown]

Estimated hours taken: 0.1
Branches: main

doc/user_guide.texi:
	Document the optional parameter to the dd_dd command in mdb.
	The documentation is commented out, since even developers would
	very rarely need this feature.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.340
diff -u -r1.340 user_guide.texi
--- doc/user_guide.texi	6 Nov 2002 02:02:25 -0000	1.340
+++ doc/user_guide.texi	6 Nov 2002 05:03:10 -0000
@@ -3219,7 +3219,6 @@
 @sp 1
 @item dd_dd
 @c @item dd_dd [filename]
- at c XXX Mark, please document the optional argument of dd_dd
 @c @item dd_dd [--assume-all-io-is-tabled] [filename]
 @c The --assume-all-io-is-tabled option is for developers only. Specifying it
 @c makes an assertion, and if the assertion is incorrect, the resulting
@@ -3230,6 +3229,9 @@
 but unlike the standard @samp{dd} command,
 does not turn off the events generated by the declarative debugger itself.
 This makes it possible to debug the declarative debugger itself.
+ at c If a filename is provided, the front end of the debugger is not called
+ at c at all.  Instead a representation of the debugging tree is dumped to
+ at c the file, which may help diagnose problems in the debugger itself.
 @end table
 
 @node Declarative debugging
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------