anil.recoil.org
The unpac monorepo manager self-hosting as a monorepo using unpac
Merge pull request #813 from jonludlam/doc-fixes
Documentation fixes
authored by
Thomas Leonard
and committed by
GitHub
d39da113
d38a31ca
+26
doc/dune
+26
doc/dune
···
3
(deps (package eio_main) (env_var "EIO_BACKEND"))
4
(enabled_if (<> %{os_type} "Win32"))
5
(files multicore.md))
6
+
7
+
(install
8
+
(section doc)
9
+
(files
10
+
(odoc-config-eio.sexp as odoc-config.sexp))
11
+
(package eio))
12
+
13
+
(install
14
+
(section doc)
15
+
(files
16
+
odoc-config.sexp)
17
+
(package eio_linux))
18
+
19
+
(install
20
+
(section doc)
21
+
(files
22
+
odoc-config.sexp)
23
+
(package eio_posix))
24
+
25
+
(install
26
+
(section doc)
27
+
(files
28
+
odoc-config.sexp)
29
+
(package eio_windows))
30
+
31
+
+4
eio.opam
+4
eio.opam
+4
eio.opam.template
+4
eio.opam.template
+3
eio_linux.opam
+3
eio_linux.opam
+3
eio_linux.opam.template
+3
eio_linux.opam.template
+3
eio_main.opam
+3
eio_main.opam
+3
eio_main.opam.template
+3
eio_main.opam.template
+3
eio_posix.opam
+3
eio_posix.opam
+3
eio_windows.opam
+3
eio_windows.opam
+3
eio_windows.opam.template
+3
eio_windows.opam.template
+1
-1
lib_eio/condition.mli
+1
-1
lib_eio/condition.mli
···
97
Therefore, care is needed here. This is typically used to send a wake-up event to some non-Eio library. *)
98
99
val cancel : request -> bool
100
-
(** [cancel request] tries to cancel a request created with {!register_unsafe}.
101
102
It returns [true] if the request was cancelled (the callback will never be called),
103
or [false] if the request was already complete (the callback has already been called). *)
···
97
Therefore, care is needed here. This is typically used to send a wake-up event to some non-Eio library. *)
98
99
val cancel : request -> bool
100
+
(** [cancel request] tries to cancel a request created with {!register_immediate}.
101
102
It returns [true] if the request was cancelled (the callback will never be called),
103
or [false] if the request was already complete (the callback has already been called). *)
+1
-1
lib_eio/core/eio__core.mli
+1
-1
lib_eio/core/eio__core.mli
···
382
383
val get : 'a key -> 'a option
384
(** [get key] reads [key] from the map of fiber local variables, returning its
385
-
value or {!None} if it has not been bound. *)
386
387
val with_binding : 'a key -> 'a -> (unit -> 'b) -> 'b
388
(** [with_binding key value fn] runs [fn] with [key] bound to the provided
···
382
383
val get : 'a key -> 'a option
384
(** [get key] reads [key] from the map of fiber local variables, returning its
385
+
value or [None] if it has not been bound. *)
386
387
val with_binding : 'a key -> 'a -> (unit -> 'b) -> 'b
388
(** [with_binding key value fn] runs [fn] with [key] bound to the provided
+1
-1
lib_eio/file.mli
+1
-1
lib_eio/file.mli
+1
-1
lib_eio/flow.mli
+1
-1
lib_eio/flow.mli
+1
-1
lib_eio/net.mli
+1
-1
lib_eio/net.mli
+1
lib_eio/unix/eio_unix.mli
+1
lib_eio/unix/eio_unix.mli
+1
-1
lib_eio/unix/process.mli
+1
-1
lib_eio/unix/process.mli
···
61
(** [spawn_unix ~sw mgr ~fds args] spawns a child process running the command [args].
62
63
The arguments are as for {!Eio.Process.spawn},
64
-
except that it takes a list of FD mappings for {!Fork_action.inherit_fds}
65
directly, rather than just flows for the standard streams. *)
66
67
val sigchld : Eio.Condition.t
···
61
(** [spawn_unix ~sw mgr ~fds args] spawns a child process running the command [args].
62
63
The arguments are as for {!Eio.Process.spawn},
64
+
except that it takes a list of FD mappings for {!Private.Fork_action.inherit_fds}
65
directly, rather than just flows for the standard streams. *)
66
67
val sigchld : Eio.Condition.t
+1
-1
lib_eio_linux/low_level.mli
+1
-1
lib_eio_linux/low_level.mli
···
109
110
@return The number of bytes copied.
111
@raise End_of_file [src] is at the end of the file.
112
-
@raise Unix.Unix_error(EINVAL, "splice", _) if splice is not supported for these FDs. *)
113
114
val connect : fd -> Unix.sockaddr -> unit
115
(** [connect fd addr] attempts to connect socket [fd] to [addr]. *)
···
109
110
@return The number of bytes copied.
111
@raise End_of_file [src] is at the end of the file.
112
+
@raise Unix.Unix_error with args [(EINVAL, "splice", _)] if splice is not supported for these FDs. *)
113
114
val connect : fd -> Unix.sockaddr -> unit
115
(** [connect fd addr] attempts to connect socket [fd] to [addr]. *)