summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavier Clerc <xavier.clerc@inria.fr>2014-01-23 09:16:24 +0000
committerXavier Clerc <xavier.clerc@inria.fr>2014-01-23 09:16:24 +0000
commitabcaa8586b7b7f05d2478079297290a69d79c069 (patch)
tree0b4846186cc8cb22c2de2087948fab6d9db053e5
parentf40ab04d266e1ed9874e8215323a34ae3e8d4bc3 (diff)
downloadocaml-abcaa8586b7b7f05d2478079297290a69d79c069.tar.gz
PR#6183: enhanced documentation for 'Unix.shutdown_connection'
git-svn-id: http://caml.inria.fr/svn/ocaml/version/4.01@14418 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
-rw-r--r--Changes1
-rw-r--r--otherlibs/unix/unix.mli4
2 files changed, 4 insertions, 1 deletions
diff --git a/Changes b/Changes
index 157d193038..8c6e31c2d6 100644
--- a/Changes
+++ b/Changes
@@ -6,6 +6,7 @@ Bug fixes:
- PR#6173: Typing error message is worse that before
- PR#6174: OCaml compiler loops on an example using GADTs (non -rectypes)
- PR#6175: Fix open!
+- PR#6183: enhanced documentation for 'Unix.shutdown_connection'
- PR#6194: Incorrect unused warning with first-class modules in patterns
- PR#6216: inlining of GADT matches generates invalid assembly
- PR#6233: out-of-bounds exceptions lose their locations on ARM, PowerPC
diff --git a/otherlibs/unix/unix.mli b/otherlibs/unix/unix.mli
index a483e42520..976fffc218 100644
--- a/otherlibs/unix/unix.mli
+++ b/otherlibs/unix/unix.mli
@@ -1101,7 +1101,9 @@ val open_connection : sockaddr -> in_channel * out_channel
val shutdown_connection : in_channel -> unit
(** ``Shut down'' a connection established with {!Unix.open_connection};
that is, transmit an end-of-file condition to the server reading
- on the other side of the connection. *)
+ on the other side of the connection. This does not fully close the
+ file descriptor associated with the channel, which you must remember
+ to free via {!Pervasives.close_in}. *)
val establish_server : (in_channel -> out_channel -> unit) -> sockaddr -> unit
(** Establish a server on the given address.