summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorferrieux <ferrieux@noemail.net>2012-01-12 20:40:11 (GMT)
committerferrieux <ferrieux@noemail.net>2012-01-12 20:40:11 (GMT)
commit57f89e51a1082d6f568c9092dae7c10d2feec4cd (patch)
treea8d39837c37680755aef3abe138795f9528c00f4 /doc
parent1eabdcb3745b00b52aaef9860ea73995d6c913be (diff)
downloadtcl-57f89e51a1082d6f568c9092dae7c10d2feec4cd.zip
tcl-57f89e51a1082d6f568c9092dae7c10d2feec4cd.tar.gz
tcl-57f89e51a1082d6f568c9092dae7c10d2feec4cd.tar.bz2
[Bug 3472316] Document the destructive semantics of [fconfigure -error] on sockets.
FossilOrigin-Name: daf88a2bd0ef4455a67086d6eb2b298d8b60c71e
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
.