Skip to content

Commit 8bb90ad

Browse files
committed
lib/rExec.mli: Break long lines
1 parent c404dec commit 8bb90ad

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

lib/rExec.mli

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,15 @@ module Client_flow : sig
2222
end
2323

2424
type handler = user:string -> string -> Flow.t -> int Lwt.t
25-
(** A handler gets a command-line and a two-way connection to the requesting client each time
26-
the remote client sends a MSG_EXEC_CMDLINE request. The "exit code" from the handler
27-
is returned to the client. *)
25+
(** A handler gets a command-line and a two-way connection to the requesting
26+
client each time the remote client sends a MSG_EXEC_CMDLINE request. The
27+
"exit code" from the handler is returned to the client. *)
2828

2929
type client = [`Ok of Client_flow.t | `Closed | `Permission_denied | `Error of string] -> unit Lwt.t
30-
(** [client] is a callback for unikernel-initiated qrexec calls. The callback is called exactly once, and is given either a flow if successful, [`Closed] if the control channel has been closed, [`Permission_denied] if dom0 says so, or an error. *)
30+
(** [client] is a callback for unikernel-initiated qrexec calls. The callback
31+
is called exactly once, and is given either a flow if successful, [`Closed]
32+
if the control channel has been closed, [`Permission_denied] if dom0 says
33+
so, or an error. *)
3134

3235
val connect : domid:int -> unit -> t Lwt.t
3336
(** [connect ~domid ()] is a qrexec agent to which a client in [domid] has connected.
@@ -40,7 +43,9 @@ val listen : t -> handler -> unit Lwt.t
4043
the client disconnects. *)
4144

4245
val qrexec : t -> vm:string -> service:string -> client -> [`Ok | `Closed] Lwt.t
43-
(** [qrexec t ~vm ~service ~client] initiates a qrexec call to [vm]'s service [service], and calls [client] with the result. If the control channel to dom0 is closed the result is [`Closed]. Otherwise [`Ok] is returned. *)
46+
(** [qrexec t ~vm ~service ~client] initiates a qrexec call to [vm]'s service
47+
[service], and calls [client] with the result. If the control channel to
48+
dom0 is closed the result is [`Closed]. Otherwise [`Ok] is returned. *)
4449

4550
val disconnect : t -> unit Lwt.t
4651
(** Close the underlying vchan. This will cause any listening thread to finish. *)

0 commit comments

Comments
 (0)