# HG changeset patch # User jbe # Date 1452902753 -3600 # Node ID c7a27cfd07d08f4836eb2dd661fc29e24926d478 # Parent 0bbf7717ebfd3f8f203ecba1f89484b4eab74840 Fixed autodoc documentation of extos.pfilter(...) diff -r 0bbf7717ebfd -r c7a27cfd07d0 libraries/extos/extos.autodoc.lua --- a/libraries/extos/extos.autodoc.lua Fri Jan 15 23:27:18 2016 +0100 +++ b/libraries/extos/extos.autodoc.lua Sat Jan 16 01:05:53 2016 +0100 @@ -3,13 +3,13 @@ data_out, -- string containing stdout data, or nil in case of error data_err, -- string containing error or stderr data status = -- exit code, or negative code in case of abnormal termination -extos.pfilter{ - data_in = data_in, -- string containing stdin data - filename = filename, -- executable - arg1 = arg1, -- first (non-zero) argument to executable - arg2 = arg2, -- second argument to executable +extos.pfilter( + data_in, -- string containing stdin data + filename, -- executable + arg1, -- first (non-zero) argument to executable + arg2, -- second argument to executable ... -} +) Executes the executable given by "filename", passing optional arguments. A given string may be fed into the program as stdin. On success 3 values are returned: A string containing all stdout data of the sub-process, a string containing all stderr data of the sub-process, and a status code. The status code is negative, if the program didn't terminate normally. By convention a status code of zero indicates success, while positive status codes indicate error conditions. If program execution was not possible at all, then nil is returned as first value and an error string as second value.