summaryrefslogtreecommitdiffstats
path: root/doc
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)
commit6e025db296ef1588e5c8a768f62f79fc34824267 (patch)
treea8d39837c37680755aef3abe138795f9528c00f4 /doc
parentca0d9ffa36c4a9e0d8e1e5c4c5cd396cd7de56fd (diff)
downloadtcl-6e025db296ef1588e5c8a768f62f79fc34824267.zip
tcl-6e025db296ef1588e5c8a768f62f79fc34824267.tar.gz
tcl-6e025db296ef1588e5c8a768f62f79fc34824267.tar.bz2
[Bug 3472316] Document the destructive semantics of [fconfigure -error] on sockets.
Diffstat (limited to 'doc')
-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
.