summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorferrieux <ferrieux@users.sourceforge.net>2012-01-12 20:40:11 (GMT)
committerferrieux <ferrieux@users.sourceforge.net>2012-01-12 20:40:11 (GMT)
commit15b74ef01faf9ca538aa987d8e8f6d64952e5b02 (patch)
treea8d39837c37680755aef3abe138795f9528c00f4
parent85acf7c41149e429f88a98ea21fbba362def0c72 (diff)
downloadtcl-15b74ef01faf9ca538aa987d8e8f6d64952e5b02.zip
tcl-15b74ef01faf9ca538aa987d8e8f6d64952e5b02.tar.gz
tcl-15b74ef01faf9ca538aa987d8e8f6d64952e5b02.tar.bz2
[Bug 3472316] Document the destructive semantics of [fconfigure -error] on sockets.
-rw-r--r--doc/socket.n3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/socket.n b/doc/socket.n
index e2c4759..e3087c9 100644
--- a/doc/socket.n
+++ b/doc/socket.n
@@ -157,6 +157,9 @@ This option gets the current error status of the given socket. This
is useful when you need to determine if an asynchronous connect
operation succeeded. If there was an error, the error message is
returned. If there was no error, an empty string is returned.
+
+Note that the error status is reset by the read operation; this mimics
+the underlying getsockopt(SO_ERROR) call.
.TP
\fB\-sockname\fR
.