From: Tobias Ulmer <tu@emlix.com>
Date: Tue, 29 Oct 2013 15:02:28 +0000 (+0100)
Subject: Extend documentation of e2lib.callcmd_capture()
X-Git-Tag: e2factory-2.3.15rc1~433
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=f4883d118c9d0b7908063e9fe108e63540938bef;p=e2factory.git

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 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)