Extend documentation of e2lib.callcmd_capture()

Signed-off-by: Tobias Ulmer <tu@emlix.com>

diff --git a/generic/e2lib.lua b/generic/e2lib.lua
index bda09e70a4d76304ae6e49d117c7b0374d0ca00c..ae42358721c90ff59839b3ad4d52158d7e00a651 100644 (file)
--- 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)