Improved documentation to fix bug #119387 (info locals seems not to

work properly) since the behaviour reported as buggy was actually
correct.


FossilOrigin-Name: 2d230fc9b11962821a79e15cb15060c942e7dddf

3 files changed, 12 insertions, 7 deletions

diff --git a/doc/global.n b/doc/global.n
index 252cbfb..2b8787a 100644
--- a/doc/global.n
+++ b/doc/global.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: global.n,v 1.2 1998/09/14 18:39:53 stanton Exp $
+'\" RCS: @(#) $Id: global.n,v 1.3 2000/11/21 15:56:21 dkf Exp $
 '\" 
 .so man.macros
 .TH global n "" Tcl "Tcl Built-In Commands"
@@ -27,9 +27,13 @@ For the duration of the current procedure
 (and only while executing in the current procedure),
 any reference to any of the \fIvarname\fRs
 will refer to the global variable by the same name.
+.PP
+Please note that this is done by creating local variables that are
+linked to the global variables, and therefore that these variables
+will be listed by \fBinfo locals\fR like all other local variables.
 
 .SH "SEE ALSO"
-namespace(n), variable(n)
+namespace(n), upvar(n), variable(n)
 
 .SH KEYWORDS
 global, namespace, procedure, variable
diff --git a/doc/upvar.n b/doc/upvar.n
index 83f4fa9..2b2175e 100644
--- a/doc/upvar.n
+++ b/doc/upvar.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: upvar.n,v 1.4 2000/09/07 14:27:52 poenitz Exp $
+'\" RCS: @(#) $Id: upvar.n,v 1.5 2000/11/21 15:56:21 dkf Exp $
 '\" 
 .so man.macros
 .TH upvar n "" Tcl "Tcl Built-In Commands"
@@ -106,7 +106,7 @@ made to \fImyVar\fR will not be passed to subprocesses correctly.
 .VE
 
 .SH "SEE ALSO"
-namespace(n), uplevel(n)
+global(n), namespace(n), uplevel(n), variable(n)
 
 .SH KEYWORDS
 context, frame, global, level, namespace, procedure, variable
diff --git a/doc/variable.n b/doc/variable.n
index 417cd24..9ef4738 100644
--- a/doc/variable.n
+++ b/doc/variable.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: variable.n,v 1.3 2000/01/26 21:36:35 ericm Exp $
+'\" RCS: @(#) $Id: variable.n,v 1.4 2000/11/21 15:56:21 dkf Exp $
 '\" 
 .so man.macros
 .TH variable n 8.0 Tcl "Tcl Built-In Commands"
@@ -42,7 +42,8 @@ command, but not to the \fBinfo exists\fR command.
 .PP
 If the \fBvariable\fR command is executed inside a Tcl procedure,
 it creates local variables
-linked to the corresponding namespace variables.
+linked to the corresponding namespace variables (and therefore these
+variables are listed by \fBinfo locals\fR.)
 In this way the \fBvariable\fR command resembles the \fBglobal\fR command,
 although the \fBglobal\fR command
 only links to variables in the global namespace.
@@ -59,7 +60,7 @@ elements within the array can be set using ordinary
 \fBset\fR or \fBarray\fR commands.
 
 .SH "SEE ALSO"
-global(n), namespace(n)
+global(n), namespace(n), upvar(n)
 
 .SH KEYWORDS
 global, namespace, procedure, variable