summaryrefslogtreecommitdiffstats
path: root/doc/return.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2010-04-07 09:51:31 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2010-04-07 09:51:31 (GMT)
commit9a41057f12f98c43dddf469be6d0822f1c90384c (patch)
treea286b79d8a43a1990436f8c1eb4db0674fd261b0 /doc/return.n
parentabb21bd3a6f2e9dd7cf5b131519cde734507e075 (diff)
downloadtcl-9a41057f12f98c43dddf469be6d0822f1c90384c.zip
tcl-9a41057f12f98c43dddf469be6d0822f1c90384c.tar.gz
tcl-9a41057f12f98c43dddf469be6d0822f1c90384c.tar.bz2
Formatting improvements for error stack docs
Diffstat (limited to 'doc/return.n')
-rw-r--r--doc/return.n10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/return.n b/doc/return.n
index 8d0d96c..9a44ff6 100644
--- a/doc/return.n
+++ b/doc/return.n
@@ -6,7 +6,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: return.n,v 1.26 2010/04/05 19:44:45 ferrieux Exp $
+'\" RCS: @(#) $Id: return.n,v 1.27 2010/04/07 09:51:31 dkf Exp $
'\"
.so man.macros
.TH return n 8.5 Tcl "Tcl Built-In Commands"
@@ -139,11 +139,11 @@ by the \fBcatch\fR command (or from the copy of that information
stored in the global variable \fBerrorInfo\fR).
.TP
\fB\-errorstack \fIlist\fR
-.
+.VS 8.6
The \fB\-errorstack\fR option receives special treatment only when the value
of the \fB\-code\fR option is \fBTCL_ERROR\fR. Then \fIlist\fR is the initial
error stack, recording actual argument values passed to each proc level. The error stack will
-also be reachable through [info errorstack].
+also be reachable through \fBinfo errorstack\fR.
If no \fB\-errorstack\fR option is provided to \fBreturn\fR when
the \fB\-code error\fR option is provided, Tcl will provide its own
initial error stack in the entry for \fB\-errorstack\fR. Tcl's
@@ -152,7 +152,9 @@ stack unwinding will append information about higher stack levels, but
there will be no information about the context of the error within
the procedure. Typically the \fIlist\fR value is supplied from
the value of \fB\-errorstack\fR in a return options dictionary captured
-by the \fBcatch\fR command (or from the copy of that information from [info errorstack]).
+by the \fBcatch\fR command (or from the copy of that information from
+\fBinfo errorstack\fR).
+.VE 8.6
.TP
\fB\-level \fIlevel\fR
.