aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/pipe.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/src/pipe.rst b/docs/src/pipe.rst
index 5eac1b6d..6437a9d9 100644
--- a/docs/src/pipe.rst
+++ b/docs/src/pipe.rst
@@ -24,6 +24,8 @@ Public members
.. c:member:: int uv_pipe_t.ipc
Whether this pipe is suitable for handle passing between processes.
+ Only a connected pipe that will be passing the handles should have this flag
+ set, not the listening pipe that uv_accept is called on.
.. seealso:: The :c:type:`uv_stream_t` members also apply.
@@ -35,7 +37,9 @@ API
Initialize a pipe handle. The `ipc` argument is a boolean to indicate if
this pipe will be used for handle passing between processes (which may
- change the bytes on the wire).
+ change the bytes on the wire). Only a connected pipe that will be
+ passing the handles should have this flag set, not the listening pipe
+ that uv_accept is called on.
.. c:function:: int uv_pipe_open(uv_pipe_t* handle, uv_file file)