summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2017-11-16 08:42:32 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2017-11-16 08:42:32 (GMT)
commit24d7fa64015b310278717d5f2462d84b7f7cd124 (patch)
tree6c29cb5b3337af14416e2a2a22fe083ea3d840f9
parent59ebc49f0f9163be7bcbd33b23e6eae865540ab4 (diff)
parent65007a4d02a35e26d92288bc5a20aa1bfde3696e (diff)
downloadtcl-24d7fa64015b310278717d5f2462d84b7f7cd124.zip
tcl-24d7fa64015b310278717d5f2462d84b7f7cd124.tar.gz
tcl-24d7fa64015b310278717d5f2462d84b7f7cd124.tar.bz2
No longer document (even though it's only in an example) that Tcl_SavedResult is a struct, and that the internal representation of an int is stored in the object's internalRep.longValue member. That might no longer be true in the future.
-rw-r--r--doc/Object.32
-rw-r--r--doc/SaveResult.34
2 files changed, 3 insertions, 3 deletions
diff --git a/doc/Object.3 b/doc/Object.3
index bf80fe2..eadd041 100644
--- a/doc/Object.3
+++ b/doc/Object.3
@@ -257,7 +257,7 @@ The \fBincr\fR command first gets an integer from \fIx\fR's value
by calling \fBTcl_GetIntFromObj\fR.
This procedure checks whether the value is already an integer value.
Since it is not, it converts the value
-by setting the value's \fIinternalRep.longValue\fR member
+by setting the value's internal representation
to the integer \fB123\fR
and setting the value's \fItypePtr\fR
to point to the integer Tcl_ObjType structure.
diff --git a/doc/SaveResult.3 b/doc/SaveResult.3
index b2270a2..6dd6cb6 100644
--- a/doc/SaveResult.3
+++ b/doc/SaveResult.3
@@ -54,9 +54,9 @@ is called, Tcl will take care of memory management.
.PP
The second triplet stores the snapshot of only the interpreter
result (not its complete state) in memory allocated by the caller.
-These routines are passed a pointer to a \fBTcl_SavedResult\fR structure
+These routines are passed a pointer to \fBTcl_SavedResult\fR
that is used to store enough information to restore the interpreter result.
-This structure can be allocated on the stack of the calling
+\fBTcl_SavedResult\fR can be allocated on the stack of the calling
procedure. These routines do not save the state of any error
information in the interpreter (e.g. the \fB\-errorcode\fR or
\fB\-errorinfo\fR return options, when an error is in progress).