From f4883d118c9d0b7908063e9fe108e63540938bef Mon Sep 17 00:00:00 2001 From: Tobias Ulmer Date: Tue, 29 Oct 2013 16:02:28 +0100 Subject: [PATCH] Extend documentation of e2lib.callcmd_capture() Signed-off-by: Tobias Ulmer --- generic/e2lib.lua | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/generic/e2lib.lua b/generic/e2lib.lua index bda09e7..ae42358 100644 --- a/generic/e2lib.lua +++ b/generic/e2lib.lua @@ -1204,10 +1204,12 @@ function e2lib.callcmd_pipe(cmds, infile, outfile) return true end ---- call a command with stdin redirected from /dev/null, stdout/stderr --- captured via a pipe --- the capture function is called for every chunk of output that --- is captured from the pipe. +--- Call a command with stdin redirected to /dev/null, stdout and stderr +-- are captured via a pipe. +-- @param cmd Command string passed to a shell for execution. +-- Escape appropriately. +-- @param capture Function taking a string argument. Called on every chunk of +-- stdout and stderr output captured from the program. -- @return Return status code of the command (number) or false on error. -- @return Error object on failure. function e2lib.callcmd_capture(cmd, capture) -- 2.39.5