* unix/mkLinks: Regenerated.

	* doc/CrtChannel.3:
	* doc/ChnlStack.3: Moved documentation for 'Tcl_GetTopChannel'
	  from 'CrtChannel' to 'ChnlStack'. Added documentation of
	  'Tcl_GetStackedChannel'. Bug #506147 reported by Mark Patton
	  <msp@users.sourceforge.net>.

4 files changed, 29 insertions, 17 deletions

diff --git a/ChangeLog b/ChangeLog
index 3c9862e..4205d45 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2002-01-23  Andreas Kupries  <andreas_kupries@users.sourceforge.net>
+
+	* unix/mkLinks: Regenerated.
+	* doc/CrtChannel.3:
+	* doc/ChnlStack.3: Moved documentation for 'Tcl_GetTopChannel'
+	  from 'CrtChannel' to 'ChnlStack'. Added documentation of
+	  'Tcl_GetStackedChannel'. Bug #506147 reported by Mark Patton
+	  <msp@users.sourceforge.net>.
+
 2002-01-23  Don Porter <dgp@users.sourceforge.net>
 
 	* doc/GetHostName.3:
@@ -19,8 +28,8 @@
 2002-01-21  David Gravereaux <davygrvy@pobox.com>
 
 	* generic/tclLoadNone.c: TclpLoadFile() didn't match proto of
-	typedef Tcl_FSLoadFileProc.  OK'd by vincentdarley.
-	[Patch #502488]
+	  typedef Tcl_FSLoadFileProc.  OK'd by vincentdarley.
+	  [Patch #502488]
 
 2002-01-21  Andreas Kupries  <andreas_kupries@users.sourceforge.net>
 
@@ -40,13 +49,13 @@
 2002-01-21  Don Porter <dgp@users.sourceforge.net>
 
 	* generic/tclTest.c: Converted declarations of TestReport file system
-	to more portable form.  [Bug 501417].
+	  to more portable form.  [Bug 501417].
 
 	* generic/tcl.decls (Tcl_TraceCommand,Tcl_UntraceCommand,
 	  Tcl_CommandTraceInfo):
 	* generic/tclCmdMZ.c (Tcl_TraceCommand,Tcl_UntraceCommand,
 	  Tcl_CommandTraceInfo): Updated APIs in generic/tclCmdMZ.c 
-	according to the guidelines of TIP 27.
+	  according to the guidelines of TIP 27.
 	* generic/tclDecls.h: make genstubs
 
 2002-01-18  Don Porter <dgp@users.sourceforge.net>
@@ -66,7 +75,7 @@
 	* mac/tclMacFile.c:
 	* mac/tclMacLoad.c:
 	* mac/tclMacResource.c: TIP 27 CONSTification broke the mac
-	build in a number of places.
+	  build in a number of places.
 
 2002-01-17  Andreas Kupries  <andreas_kupries@users.sourceforge.net>
 
diff --git a/doc/ChnlStack.3 b/doc/ChnlStack.3
index e806510..0e8f9cd 100644
--- a/doc/ChnlStack.3
+++ b/doc/ChnlStack.3
@@ -4,13 +4,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\"
-'\" RCS: @(#) $Id: ChnlStack.3,v 1.3 2000/09/28 06:34:56 hobbs Exp $
+'\" RCS: @(#) $Id: ChnlStack.3,v 1.4 2002/01/23 21:22:06 andreas_kupries Exp $
 .so man.macros
 .TH Tcl_StackChannel 3 8.3 Tcl "Tcl Library Procedures"
 .BS
 '\" Note:  do not modify the .SH NAME line immediately below!
 .SH NAME
-Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel \- stack an I/O channel on top of another, and undo it
+Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel, Tcl_GetTopChannel \- stack an I/O channel on top of another, and undo it
 .SH SYNOPSIS
 .nf
 .nf
@@ -25,6 +25,9 @@ int
 Tcl_Channel
 \fBTcl_GetStackedChannel\fR(\fIchannel\fR)
 .sp
+Tcl_Channel
+\fBTcl_GetTopChannel\fR(\fIchannel\fR)
+.sp
 .SH ARGUMENTS
 .AS Tcl_ChannelType
 .AP Tcl_Interp *interp in
@@ -82,6 +85,12 @@ associated with the channel name, and the processing module added by
 \fBTcl_UnstackChannel\fP is equivalent to \fBTcl_Close\fP.  If an error
 occurs unstacking the channel, \fBTCL_ERROR\fR is returned, otherwise
 \fBTCL_OK\fR is returned.
+.PP
+\fBTcl_GetTopChannel\fR returns the top channel in the stack of
+channels the supplied channel is part of.
+.PP
+\fBTcl_GetStackedChannel\fR returns the channel in the stack of
+channels which is just below the supplied channel.
 
 .SH "SEE ALSO"
 Notifier(3), Tcl_CreateChannel(3), Tcl_OpenFileChannel(3), vwait(n).
diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3
index 1f809bc..3273c6c 100644
--- a/doc/CrtChannel.3
+++ b/doc/CrtChannel.3
@@ -5,13 +5,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\"
-'\" RCS: @(#) $Id: CrtChannel.3,v 1.13 2002/01/15 17:55:29 dgp Exp $
+'\" RCS: @(#) $Id: CrtChannel.3,v 1.14 2002/01/23 21:22:06 andreas_kupries Exp $
 .so man.macros
 .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures"
 .BS
 '\" Note:  do not modify the .SH NAME line immediately below!
 .SH NAME
-Tcl_CreateChannel, Tcl_GetChannelInstanceData, Tcl_GetChannelType, Tcl_GetChannelName, Tcl_GetChannelHandle, Tcl_GetChannelMode, Tcl_GetChannelBufferSize, Tcl_SetChannelBufferSize, Tcl_NotifyChannel, Tcl_BadChannelOption, Tcl_ChannelName, Tcl_ChannelVersion, Tcl_ChannelBlockModeProc, Tcl_ChannelCloseProc, Tcl_ChannelClose2Proc, Tcl_ChannelInputProc, Tcl_ChannelOutputProc, Tcl_ChannelSeekProc, Tcl_ChannelSetOptionProc, Tcl_ChannelGetOptionProc, Tcl_ChannelWatchProc, Tcl_ChannelGetHandleProc, Tcl_ChannelFlushProc, Tcl_ChannelHandlerProc, Tcl_IsChannelShared, Tcl_IsChannelRegistered, Tcl_CutChannel, Tcl_SpliceChannel, Tcl_IsChannelExisting, Tcl_ClearChannelHandlers, Tcl_GetChannelThread, Tcl_ChannelBuffered, Tcl_GetTopChannel \- procedures for creating and manipulating channels
+Tcl_CreateChannel, Tcl_GetChannelInstanceData, Tcl_GetChannelType, Tcl_GetChannelName, Tcl_GetChannelHandle, Tcl_GetChannelMode, Tcl_GetChannelBufferSize, Tcl_SetChannelBufferSize, Tcl_NotifyChannel, Tcl_BadChannelOption, Tcl_ChannelName, Tcl_ChannelVersion, Tcl_ChannelBlockModeProc, Tcl_ChannelCloseProc, Tcl_ChannelClose2Proc, Tcl_ChannelInputProc, Tcl_ChannelOutputProc, Tcl_ChannelSeekProc, Tcl_ChannelSetOptionProc, Tcl_ChannelGetOptionProc, Tcl_ChannelWatchProc, Tcl_ChannelGetHandleProc, Tcl_ChannelFlushProc, Tcl_ChannelHandlerProc, Tcl_IsChannelShared, Tcl_IsChannelRegistered, Tcl_CutChannel, Tcl_SpliceChannel, Tcl_IsChannelExisting, Tcl_ClearChannelHandlers, Tcl_GetChannelThread, Tcl_ChannelBuffered \- procedures for creating and manipulating channels
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
@@ -70,9 +70,6 @@ void
 int
 \fBTcl_ChannelBuffered\fR(\fIchannel\fR)
 .sp
-Tcl_Channel
-\fBTcl_GetTopChannel\fR(\fIchannel\fR)
-.sp
 CONST char *
 \fBTcl_ChannelName\fR(\fItypePtr\fR)
 .sp
@@ -266,9 +263,6 @@ procs to generate a complete error message.
 .VE
 .PP
 .VS 8.3.2
-\fBTcl_GetTopChannel\fR returns the top channel in the stack of
-channels the supplied channel is part of.
-.PP
 \fBTcl_ChannelBuffered\fR returns the number of bytes of input
 currently buffered in the internal buffer (push back area) of the
 channel itself. It does not report about the data in the overall
diff --git a/unix/mkLinks b/unix/mkLinks
index f51bb14..6ac5d77 100644
--- a/unix/mkLinks
+++ b/unix/mkLinks
@@ -131,9 +131,11 @@ if test -r ChnlStack.3; then
     rm -f Tcl_StackChannel.3
     rm -f Tcl_UnstackChannel.3
     rm -f Tcl_GetStackedChannel.3
+    rm -f Tcl_GetTopChannel.3
     ln ChnlStack.3 Tcl_StackChannel.3
     ln ChnlStack.3 Tcl_UnstackChannel.3
     ln ChnlStack.3 Tcl_GetStackedChannel.3
+    ln ChnlStack.3 Tcl_GetTopChannel.3
 fi
 if test -r CmdCmplt.3; then
     rm -f Tcl_CommandComplete.3
@@ -176,7 +178,6 @@ if test -r CrtChannel.3; then
     rm -f Tcl_ClearChannelHandlers.3
     rm -f Tcl_GetChannelThread.3
     rm -f Tcl_ChannelBuffered.3
-    rm -f Tcl_GetTopChannel.3
     ln CrtChannel.3 Tcl_CreateChannel.3
     ln CrtChannel.3 Tcl_GetChannelInstanceData.3
     ln CrtChannel.3 Tcl_GetChannelType.3
@@ -209,7 +210,6 @@ if test -r CrtChannel.3; then
     ln CrtChannel.3 Tcl_ClearChannelHandlers.3
     ln CrtChannel.3 Tcl_GetChannelThread.3
     ln CrtChannel.3 Tcl_ChannelBuffered.3
-    ln CrtChannel.3 Tcl_GetTopChannel.3
 fi
 if test -r CrtChnlHdlr.3; then
     rm -f Tcl_CreateChannelHandler.3