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.

2 files changed, 8 insertions, 9 deletions

diff --git a/doc/Object.3 b/doc/Object.3
index 4df6c1a..a7e06c8 100644
--- a/doc/Object.3
+++ b/doc/Object.3
@@ -3,7 +3,7 @@
 '\"
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\" 
+'\"
 .TH Tcl_Obj 3 8.5 Tcl "Tcl Library Procedures"
 .so man.macros
 .BS
@@ -94,7 +94,7 @@ Also, most Tcl values are only read and never modified.
 This is especially true for procedure arguments,
 which can be shared between the caller and the called procedure.
 Assignment and argument binding is done by
-simply assigning a pointer to the value. 
+simply assigning a pointer to the value.
 Reference counting is used to determine when it is safe to
 reclaim an object's storage.
 .PP
@@ -249,7 +249,7 @@ The \fBincr\fR command first gets an integer from \fIx\fR's object
 by calling \fBTcl_GetIntFromObj\fR.
 This procedure checks whether the object is already an integer object.
 Since it is not, it converts the object
-by setting the object's \fIinternalRep.longValue\fR member
+by setting the object's internal representation
 to the integer \fB123\fR
 and setting the object's \fItypePtr\fR
 to point to the integer Tcl_ObjType structure.
diff --git a/doc/SaveResult.3 b/doc/SaveResult.3
index 74da9f4..0a2ee51 100644
--- a/doc/SaveResult.3
+++ b/doc/SaveResult.3
@@ -4,7 +4,7 @@
 '\"
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\" 
+'\"
 .TH Tcl_SaveResult 3 8.1 Tcl "Tcl Library Procedures"
 .so man.macros
 .BS
@@ -56,9 +56,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).
@@ -69,7 +69,7 @@ a superset of the functions provided by the other routines,
 any new code should only make use of the more powerful routines.
 The older, weaker routines \fBTcl_SaveResult\fR, \fBTcl_RestoreResult\fR,
 and \fBTcl_DiscardResult\fR continue to exist only for the sake
-of existing programs that may already be using them.  
+of existing programs that may already be using them.
 .PP
 \fBTcl_SaveInterpState\fR takes a snapshot of those portions of
 interpreter state that make up the full result of script evaluation.
@@ -118,7 +118,6 @@ uninitialized state and cannot be used until another call to
 Once \fBTcl_SaveResult\fR is called to save the interpreter
 result, either \fBTcl_RestoreResult\fR or
 \fBTcl_DiscardResult\fR must be called to properly clean up the
-memory associated with the saved state.  
-
+memory associated with the saved state.
 .SH KEYWORDS
 result, state, interp