Formatting improvements for error stack docs

4 files changed, 85 insertions, 61 deletions

diff --git a/ChangeLog b/ChangeLog
index c38f615..2df8edc 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2010-04-07  Donal K. Fellows  <dkf@users.sf.net>
+
+	* doc/catch.n, doc/info.n, doc/return.n: Formatting.
+
 2010-04-06  Donal K. Fellows  <dkf@users.sf.net>
 
 	* doc/Load.3: Minor corrections of formatting and cross links.
@@ -12,22 +16,22 @@
 
 2010-04-05  Alexandre Ferrieux  <ferrieux@users.sourceforge.net>
 
-	TIP #348 IMPLEMENTATION  -  Substituted error stack
+	TIP #348 IMPLEMENTATION
 
-	* generic/tclBasic.c
-	* generic/tclCmdIL.c
-	* generic/tclInt.h
-	* generic/tclNamesp.c
-	* generic/tclResult.c
-	* doc/catch.n
-	* doc/info.n
-	* doc/return.n
-	* tests/cmdMZ.test
-	* tests/error.test
-	* tests/execute.test
-	* tests/info.test
-	* tests/init.test
-	* tests/result.test
+	* generic/tclBasic.c: [Patch 2868499]: Substituted error stack
+	* generic/tclCmdIL.c:
+	* generic/tclInt.h:
+	* generic/tclNamesp.c:
+	* generic/tclResult.c:
+	* doc/catch.n:
+	* doc/info.n:
+	* doc/return.n:
+	* tests/cmdMZ.test:
+	* tests/error.test:
+	* tests/execute.test:
+	* tests/info.test:
+	* tests/init.test:
+	* tests/result.test:
 
 2010-04-05  Donal K. Fellows  <dkf@users.sf.net>
 
@@ -75,9 +79,9 @@
 					TIP.
 
 	* generic/tcl.decls:		[TIP #357]: First round of changes
-	* generic/tclDecls.h:		to export Tcl_LoadFile, Tcl_FindSymbol,
-	* generic/tclIOUtil.c:		and Tcl_FSUnloadFile to the public API.
-	* generic/tclInt.h:
+	* generic/tclDecls.h:		to export Tcl_LoadFile,
+	* generic/tclIOUtil.c:		Tcl_FindSymbol, and Tcl_FSUnloadFile
+	* generic/tclInt.h:		to the public API.
 	* generic/tclLoad.c:
 	* generic/tclLoadNone.c:
 	* generic/tclStubInit.c:
diff --git a/doc/catch.n b/doc/catch.n
index 1efb082..691b0c7 100644
--- a/doc/catch.n
+++ b/doc/catch.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: catch.n,v 1.24 2010/04/05 19:44:45 ferrieux Exp $
+'\" RCS: @(#) $Id: catch.n,v 1.25 2010/04/07 09:51:31 dkf Exp $
 '\" 
 .so man.macros
 .TH catch n "8.5" Tcl "Tcl Built-In Commands"
@@ -34,7 +34,7 @@ by a return code of \fBTCL_ERROR\fR.  The other exceptional return codes are
 returned by the \fBreturn\fR, \fBbreak\fR, and \fBcontinue\fR commands
 and in other special situations as documented.  Tcl packages can define
 new commands that return other integer values as return codes as well,
-and scripts that make use of the \fBreturn -code\fR command can also
+and scripts that make use of the \fBreturn \-code\fR command can also
 have return codes other than the five defined by Tcl.
 .PP
 If the \fIresultVarName\fR argument is given, then the variable it names is
@@ -57,33 +57,46 @@ further described in the documentation for the \fBreturn\fR command.
 When the return code from evaluation of \fIscript\fR is
 \fBTCL_ERROR\fR, four additional entries are defined in the dictionary
 of return options stored in \fIoptionsVarName\fR: \fB\-errorinfo\fR,
-\fB\-errorcode\fR, \fB\-errorline\fR, and \fB\-errorstack\fR.  The
-value of the \fB\-errorinfo\fR entry is a formatted stack trace
-containing more information about the context in which the error
-happened.  The formatted stack trace is meant to be read by a person.
-The value of the \fB\-errorcode\fR entry is additional information
-about the error stored as a list.  The \fB\-errorcode\fR value is
-meant to be further processed by programs, and may not be particularly
-readable by people.  The value of the \fB\-errorline\fR entry is an
-integer indicating which line of \fIscript\fR was being evaluated when
-the error occurred.  The value of the \fB\-errorstack\fR entry is an
+\fB\-errorcode\fR, \fB\-errorline\fR, and
+.VS 8.6
+\fB\-errorstack\fR.
+.VE 8.6
+The value of the \fB\-errorinfo\fR entry is a formatted stack trace containing
+more information about the context in which the error happened.  The formatted
+stack trace is meant to be read by a person.  The value of the
+\fB\-errorcode\fR entry is additional information about the error stored as a
+list.  The \fB\-errorcode\fR value is meant to be further processed by
+programs, and may not be particularly readable by people.  The value of the
+\fB\-errorline\fR entry is an integer indicating which line of \fIscript\fR
+was being evaluated when the error occurred.
+.VS 8.6
+The value of the \fB\-errorstack\fR entry is an
 even-sized list made of token-parameter pairs accumulated while
-unwinding the stack. The token may be "CALL", in which case the
-parameter is a list made of the proc name and arguments at the
-corresponding level; or it may be "UP", in which case the parameter is
-the relative [uplevel] of the previous CALL. The salient differences
-wrt -errorinfo are that (1) it is a machine-readable form amenable to
-[foreach {tok prm} ...], (2) it contains the true (substituted) values
-passed to the functions, instead of the static text of the calling
-sites, and (3) it is coarser-grained, with only one element per stack
-frame (like procs; no separate elements for [foreach] constructs for
-example).
-
+unwinding the stack. The token may be
+.QW \fBCALL\fR ,
+in which case the parameter is a list made of the proc name and arguments at
+the corresponding level; or it may be
+.QW \fBUP\fR ,
+in which case the parameter is
+the relative level (as in \fBuplevel\fR) of the previous \fBCALL\fR. The
+salient differences wrt \fB\-errorinfo\fR are that:
+.IP (1)
+it is a machine-readable form that is amenable to processing with
+[\fBforeach\fR {tok prm} ...],
+.IP (2)
+it contains the true (substituted) values passed to the functions, instead of
+the static text of the calling sites, and
+.IP (3)
+it is coarser-grained, with only one element per stack frame (like procs; no
+separate elements for \fBforeach\fR constructs for example).
+.VE 8.6
+.PP
 The values of the \fB\-errorinfo\fR and \fB\-errorcode\fR entries of
 the most recent error are also available as values of the global
-variables \fB::errorInfo\fR and \fB::errorCode\fR respectively. The
-value of the \fB\-errorstack\fR entry surfaces as \fBinfo
-errorstack\fR.
+variables \fB::errorInfo\fR and \fB::errorCode\fR respectively.
+.VS 8.6
+The value of the \fB\-errorstack\fR entry surfaces as \fBinfo errorstack\fR.
+.VE 8.6
 .PP
 Tcl packages may provide commands that set other entries in the
 dictionary of return options, and the \fBreturn\fR command may be
@@ -104,6 +117,10 @@ if { [\fBcatch\fR {open $someFile w} fid] } {
 There are more complex examples of \fBcatch\fR usage in the
 documentation for the \fBreturn\fR command.
 .SH "SEE ALSO" 
-break(n), continue(n), dict(n), error(n), return(n), tclvars(n)
+break(n), continue(n), dict(n), error(n), info(n), return(n), tclvars(n)
 .SH KEYWORDS
 catch, error, exception
+'\" Local Variables:
+'\" mode: nroff
+'\" fill-column: 78
+'\" End:
diff --git a/doc/info.n b/doc/info.n
index 3076274..63ce180 100644
--- a/doc/info.n
+++ b/doc/info.n
@@ -8,7 +8,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: info.n,v 1.37 2010/04/05 19:44:45 ferrieux Exp $
+'\" RCS: @(#) $Id: info.n,v 1.38 2010/04/07 09:51:31 dkf Exp $
 '\" 
 .so man.macros
 .TH info n 8.4 Tcl "Tcl Built-In Commands"
@@ -95,14 +95,14 @@ Otherwise it returns \fB1\fR and places the default value of \fIarg\fR
 into variable \fIvarname\fR.
 .TP
 \fBinfo errorstack \fR?\fIinterp\fR?
-.
-Returns a list of lists made of the function names and arguments at
-each level from the call stack of the last error in the given
-\fIinterp\fR, or in the current one if not specified.  This
-information is also present in the -errorstack entry of the options
-dictionary returned by 3-arg \fBcatch\fR; \fBinfo errorstack\fR is a
-convenient way of retrieving it for uncaught errors at toplevel in an
-interactive tclsh.
+.VS 8.6
+Returns a list of lists made of the function names and arguments at each level
+from the call stack of the last error in the given \fIinterp\fR, or in the
+current one if not specified.  This information is also present in the
+\fB\-errorstack\fR entry of the options dictionary returned by 3-argument
+\fBcatch\fR; \fBinfo errorstack\fR is a convenient way of retrieving it for
+uncaught errors at toplevel in an interactive tclsh.
+.VE 8.6
 .TP
 \fBinfo exists \fIvarName\fR
 .
@@ -687,6 +687,7 @@ command, information, interpreter, introspection, level, namespace,
 object,
 .VE 8.6
 procedure, variable
-.\" Local Variables:
-.\" mode: nroff
-.\" End:
+'\" Local Variables:
+'\" mode: nroff
+'\" fill-column: 78
+'\" End:
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
 .