From ca60d34cf161e778bd4df7d79cda6df479df20ca Mon Sep 17 00:00:00 2001 From: mpeterv Date: Sat, 19 Mar 2016 13:34:23 +0300 Subject: Doc fixes for luarocks.search --- src/luarocks/search.lua | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/src/luarocks/search.lua b/src/luarocks/search.lua index f1a82d5b..32af1f9e 100644 --- a/src/luarocks/search.lua +++ b/src/luarocks/search.lua @@ -48,7 +48,8 @@ end --- Store a search result (a rock or rockspec) in the results table. -- @param results table: The results table, where keys are package names and --- versions are tables matching version strings to an array of servers. +-- values are tables matching version strings to arrays of +-- tables with fields "arch" and "repo". -- @param name string: Package name. -- @param version string: Package version. -- @param arch string: Architecture of rock ("all", "src" or platform @@ -92,7 +93,8 @@ end -- table, optionally checking if version and arch (if given) match -- a query. -- @param results table: The results table, where keys are package names and --- versions are tables matching version strings to an array of servers. +-- values are tables matching version strings to arrays of +-- tables with fields "arch" and "repo". -- @param repo string: URL or pathname of the repository. -- @param name string: The name of the package being tested. -- @param version string: The version of the package being tested. @@ -123,8 +125,9 @@ end -- matches regardless of architecture. -- @param results table or nil: If given, this table will store the -- results; if not given, a new table will be created. --- @param table: The results table, where keys are package names and --- versions are tables matching version strings to an array of servers. +-- @return table: The results table, where keys are package names and +-- values are tables matching version strings to arrays of +-- tables with fields "arch" and "repo". -- If a table was given in the "results" parameter, that is the result value. function search.disk_search(repo, query, results) assert(type(repo) == "string") @@ -157,7 +160,8 @@ end --- Perform search on a rocks server or tree. -- @param results table: The results table, where keys are package names and --- versions are tables matching version strings to an array of servers. +-- values are tables matching version strings to arrays of +-- tables with fields "arch" and "repo". -- @param repo string: The URL of a rocks server or -- the pathname of a rocks tree (as returned by path.rocks_dir()). -- @param query table: A table describing the query in dependency @@ -190,8 +194,8 @@ end --- Search on all configured rocks servers. -- @param query table: A dependency query. -- @return table: A table where keys are package names --- and values are tables matching version strings to an array of --- rocks servers; if no results are found, an empty table is returned. +-- and values are tables matching version strings to arrays of +-- tables with fields "arch" and "repo". function search.search_repos(query) assert(type(query) == "table") -- cgit v1.2.3-55-g6feb