aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorHisham Muhammad <hisham@gobolinux.org>2015-04-13 21:29:38 -0300
committerHisham Muhammad <hisham@gobolinux.org>2015-04-13 21:29:38 -0300
commit0fe8556ced63d714e0cd371a8511c8dadce7874e (patch)
treeb4b842105b2379d684cf0ea10834f9347acc188c /src
parent0679559812674fdd9b0a9c17852ebd03f7ff2fc4 (diff)
downloadluarocks-0fe8556ced63d714e0cd371a8511c8dadce7874e.tar.gz
luarocks-0fe8556ced63d714e0cd371a8511c8dadce7874e.tar.bz2
luarocks-0fe8556ced63d714e0cd371a8511c8dadce7874e.zip
Update function documentation,
as suggested by @ignacio in #347.
Diffstat (limited to 'src')
-rw-r--r--src/luarocks/search.lua5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/luarocks/search.lua b/src/luarocks/search.lua
index 53439386..f1a82d5b 100644
--- a/src/luarocks/search.lua
+++ b/src/luarocks/search.lua
@@ -155,10 +155,11 @@ function search.disk_search(repo, query, results)
155 return results 155 return results
156end 156end
157 157
158--- Perform search on a rocks server. 158--- Perform search on a rocks server or tree.
159-- @param results table: The results table, where keys are package names and 159-- @param results table: The results table, where keys are package names and
160-- versions are tables matching version strings to an array of servers. 160-- versions are tables matching version strings to an array of servers.
161-- @param repo string: The URL of the rocks server. 161-- @param repo string: The URL of a rocks server or
162-- the pathname of a rocks tree (as returned by path.rocks_dir()).
162-- @param query table: A table describing the query in dependency 163-- @param query table: A table describing the query in dependency
163-- format (for example, {name = "filesystem", exact_name = false, 164-- format (for example, {name = "filesystem", exact_name = false,
164-- constraints = {op = "~>", version = {1,0}}}, arch = "rockspec"). 165-- constraints = {op = "~>", version = {1,0}}}, arch = "rockspec").