]> git.e2factory.org Git - e2factory.git/commitdiff
Improve callcmd()/fdct documentation
authorTobias Ulmer <tu@emlix.com>
Wed, 20 Nov 2013 16:06:05 +0000 (17:06 +0100)
committerTobias Ulmer <tu@emlix.com>
Wed, 16 Nov 2016 14:41:17 +0000 (15:41 +0100)
Signed-off-by: Tobias Ulmer <tu@emlix.com>
generic/e2lib.lua

index ca6d16550fb6fef09a07bf91734c33c96d79e3a9..20507f2e3bca8204c375b74197a18be3c29bbf79 100644 (file)
@@ -1192,12 +1192,14 @@ end
 -- @table fdct
 -- @field dup File descriptor in the child process that should be replaced by
 --            this configuration.
--- @field istype "readfo" denotes
+-- @field istype Describes the type of fdct. Can be either "readfo" or
+--               "writefunc". For details, check their respective pseudo-tables.
 -- @see fdct_readfo
+-- @see fdct_writefunc
 
 --- File descriptor configuration table - readfo. This is an extension to
 -- fdct for documentation purposes. It's not a separate table. When istype is
---"readfo", the following field are expected in addition to ones in fdct.
+-- "readfo", the following field are expected in addition to ones in fdct.
 -- The file object is used as an input to the child.
 -- @table fdct_readfo
 -- @field file Readable file object.