Skip to content

Commit 19a4fb3

Browse files
MisterDAraphael-proust
authored andcommitted
Move Lwt_process.redirection doc into the type
1 parent de2e44d commit 19a4fb3

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

src/unix/lwt_process.mli

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,22 +53,17 @@ val shell : string -> command
5353
(** {3 Redirections} *)
5454

5555
type redirection =
56-
[ `Keep
57-
| `Dev_null
58-
| `Close
59-
| `FD_copy of Unix.file_descr
60-
| `FD_move of Unix.file_descr]
56+
[ `Keep (** Point to the same file as in the parent. *)
57+
| `Dev_null (** Redirect to [/dev/null] (POSIX) or [nul] (Win32). *)
58+
| `Close (** Close the file descriptor. *)
59+
| `FD_copy of Unix.file_descr (** Redirect to the file pointed to by [fd].
60+
[fd] remains open in the parent. *)
61+
| `FD_move of Unix.file_descr (** Redirect to the file pointed to by [fd].
62+
[fd] is then closed in the parent. *)
63+
]
6164
(** File descriptor redirections. These are used with the [~stdin], [~stdout],
6265
and [~stderr] arguments below to specify how the standard file descriptors
6366
should be redirected in the child process.
64-
65-
- [`Keep]: point to the same file as in the parent.
66-
- [`Dev_null]: redirect to [/dev/null] (POSIX) or [nul] (Win32).
67-
- [`Close]: close the file descriptor.
68-
- [`FD_copy fd] redirect to the file pointed to by [fd]. [fd] remains open.
69-
- [`FD_move fd] redirect to the file pointed to by [fd]. [fd] is then
70-
closed.
71-
7267
All optional redirection arguments default to [`Keep]. *)
7368

7469
(** {3 Executing} *)

0 commit comments

Comments
 (0)