Skip to content

Commit

Permalink
Docs: link to man pages for pipe and socketpair
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
aantron committed Feb 15, 2021
1 parent 9a9c106 commit 5138b38
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 3 additions & 1 deletion src/TCP.mli
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ val socketpair :
(** Creates a pair of connected sockets.
Binds {{:http://docs.libuv.org/en/v1.x/tcp.html#c.uv_socketpair}
[uv_socketpair]}.
[uv_socketpair]}. See
{{:https://www.man7.org/linux/man-pages/man3/socketpair.3p.html}
[socketpair(3p)]}.
See {!Luv.Pipe.pipe} for an explanation of the optional arguments.
Expand Down
3 changes: 2 additions & 1 deletion src/pipe.mli
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ val pipe :
(File.t * File.t, Error.t) result
(** Creates a pair of connected pipes.
Binds {{:http://docs.libuv.org/en/v1.x/pipe.html#c.uv_pipe} [uv_pipe]}.
Binds {{:http://docs.libuv.org/en/v1.x/pipe.html#c.uv_pipe} [uv_pipe]}. See
{{:https://www.man7.org/linux/man-pages/man3/pipe.3p.html} [pipe(3p)]}.
In case of success, in the value [(read_pipe, write_pipe)], data written
to [write_pipe] can be read from [read_pipe].
Expand Down

0 comments on commit 5138b38

Please sign in to comment.