summaryrefslogtreecommitdiffhomepage
path: root/libs/core
diff options
context:
space:
mode:
authorSteven Barth <steven@midlink.org>2008-07-23 14:17:37 +0000
committerSteven Barth <steven@midlink.org>2008-07-23 14:17:37 +0000
commitc5a68895cff827abcc641ea0619a703413d5abe6 (patch)
treeb2066d4e9b535b9e4ef84f7bd5bb17620137ea3b /libs/core
parentdba6854d65a9ff859e1a7782f048cecfdd2513ca (diff)
libs/core: Update luci.sys inline documentation
Diffstat (limited to 'libs/core')
-rw-r--r--libs/core/luasrc/sys.lua11
1 files changed, 8 insertions, 3 deletions
diff --git a/libs/core/luasrc/sys.lua b/libs/core/luasrc/sys.lua
index 45e44b80d..217a36b0f 100644
--- a/libs/core/luasrc/sys.lua
+++ b/libs/core/luasrc/sys.lua
@@ -71,7 +71,7 @@ function execl(command)
end
--- Invoke the luci-flash executable to write an image to the flash memory.
--- @param kpattern kpattern (ToDo: clearify this)
+-- @param kpattern Pattern of files to keep over flash process
-- @return Return value of os.execute()
function flash(image, kpattern)
local cmd = "luci-flash "
@@ -202,9 +202,14 @@ function uptime()
return loadavg:match("^(.-) (.-)$")
end
---- Get group information
--- @return Group (ToDo: clearify)
+--- LuCI system utilities / POSIX user group related functions.
+-- @class module
+-- @name luci.sys.group
group = {}
+
+--- Returns information about a POSIX user group.
+-- @param group Group ID or name of a system user group
+-- @return Table with information about the requested group
group.getgroup = posix.getgroup