[m-dev.] for review: document exception events

[Mark Anthony BROWN]

Hi,

This is for review by Fergus.  In particular, is "forward" the
best word to use here?

Cheers,
Mark.


Estimated hours taken: 0.5

doc/user_guide.texi:
	Document exception events, including what they are and where
	they can occur in a trace.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.201
diff -u -r1.201 user_guide.texi
--- doc/user_guide.texi	2000/03/16 05:40:10	1.201
+++ doc/user_guide.texi	2000/03/21 11:47:13
@@ -1186,7 +1186,17 @@
 a call event
 @end table
 
-Besides the event types call, exit, redo and fail,
+In addition to these four event types,
+Mercury supports @emph{exception} events.
+An exception event occurs
+when an exception has been thrown inside a procedure,
+and control is about to forward this exception to the caller.
+An exception event can replace the final exit or fail event
+in the event sequences above
+or, in the case of erroneous procedures,
+can come after the call event.
+
+Besides the event types call, exit, redo, fail and exception,
 which describe the @emph{interface} of a call,
 Mercury also supports several types of events
 that report on what is happening @emph{internal} to a call.
-- 
Mark Brown, PhD student            )O+  |  "Another of Fortran's breakthroughs
(m.brown at cs.mu.oz.au)                   |  was the GOTO statement, which was...
Dept. of Computer Science and Software  |  uniquely simple and understandable"
Engineering, University of Melbourne    |              -- IEEE, 1994
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------