[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Libguestfs] [PATCH v3 2/4] mltools: Document that run_command closes stdout_chan/stderr_chan.



This behaviour is documented for run_commands, but not documented for
run_command, so document it.
---
 common/mltools/tools_utils.mli | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/common/mltools/tools_utils.mli b/common/mltools/tools_utils.mli
index dac6b4120..c9350d0f9 100644
--- a/common/mltools/tools_utils.mli
+++ b/common/mltools/tools_utils.mli
@@ -101,6 +101,9 @@ val run_commands : ?echo_cmd:bool -> (string list * Unix.file_descr option * Uni
 val run_command : ?echo_cmd:bool -> ?stdout_chan:Unix.file_descr -> ?stderr_chan:Unix.file_descr -> string list -> int
 (** Run an external command without using a shell, and return its exit code.
 
+    If [stdout_chan] or [stderr_chan] is specified, the file descriptor
+    is automatically closed after executing the command.
+
     [echo_cmd] specifies whether output the full command on verbose
     mode, and it's on by default. *)
 
-- 
2.18.0


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]