summaryrefslogtreecommitdiffhomepage
path: root/modules/luci-base/luasrc/model/uci.luadoc
diff options
context:
space:
mode:
authorJo-Philipp Wich <jow@openwrt.org>2015-12-17 02:39:23 +0100
committerJo-Philipp Wich <jow@openwrt.org>2015-12-17 02:39:23 +0100
commit967bb1f36f9f30d19e13aecf3a550eea5fd73c6b (patch)
tree253ae8cee5f3e8aa8dc2a40efdc677f25188bf41 /modules/luci-base/luasrc/model/uci.luadoc
parent0dcb549841edc951646e90eda6956399aea7c209 (diff)
parent03786ed853fb2d538bd3448f778e9d0cfe50691e (diff)
Merge pull request #464 from remakeelectric/pulls/list-operations
get/set list operations and documentation
Diffstat (limited to 'modules/luci-base/luasrc/model/uci.luadoc')
-rw-r--r--modules/luci-base/luasrc/model/uci.luadoc8
1 files changed, 5 insertions, 3 deletions
diff --git a/modules/luci-base/luasrc/model/uci.luadoc b/modules/luci-base/luasrc/model/uci.luadoc
index 7591b68b02..49093c7930 100644
--- a/modules/luci-base/luasrc/model/uci.luadoc
+++ b/modules/luci-base/luasrc/model/uci.luadoc
@@ -88,7 +88,8 @@ Get an option or list and return values as table.
@param config UCI config
@param section UCI section name
@param option UCI option
-@return UCI value
+@return table. If the option was not found, you will simply get
+-- an empty table.
]]
---[[
@@ -104,14 +105,15 @@ Get the given option from the first section with the given type.
]]
---[[
-Set given values as list.
+Set given values as list. Setting a list option to an empty list
+has the same effect as deleting the option.
@class function
@name Cursor.set_list
@param config UCI config
@param section UCI section name
@param option UCI option
-@param value UCI value
+@param value value or table. Raw values will become a single item table.
@return Boolean whether operation succeeded
]]