From af8561de2bdefd5a1cf6f32be08323d5f271fe9b Mon Sep 17 00:00:00 2001 From: Hisham Muhammad Date: Fri, 29 Sep 2017 19:02:00 -0300 Subject: Document cache option. --- src/luarocks/fetch.lua | 2 ++ src/luarocks/fs/tools.lua | 2 ++ 2 files changed, 4 insertions(+) (limited to 'src') diff --git a/src/luarocks/fetch.lua b/src/luarocks/fetch.lua index 6f8dfc0b..dc467d19 100644 --- a/src/luarocks/fetch.lua +++ b/src/luarocks/fetch.lua @@ -24,6 +24,8 @@ end -- resulting local filename of the remote file as the basename of the URL; -- if that is not correct (due to a redirection, for example), the local -- filename can be given explicitly as this second argument. +-- @param cache boolean: compare remote timestamps via HTTP HEAD prior to +-- re-downloading the file. -- @return string or (nil, string, [string]): the absolute local pathname for the -- fetched file, or nil and a message in case of errors, followed by -- an optional error code. diff --git a/src/luarocks/fs/tools.lua b/src/luarocks/fs/tools.lua index 991c25cb..de216353 100644 --- a/src/luarocks/fs/tools.lua +++ b/src/luarocks/fs/tools.lua @@ -92,6 +92,8 @@ end -- resulting local filename of the remote file as the basename of the URL; -- if that is not correct (due to a redirection, for example), the local -- filename can be given explicitly as this second argument. +-- @param cache boolean: compare remote timestamps via HTTP HEAD prior to +-- re-downloading the file. -- @return (boolean, string): true and the filename on success, -- false and the error message on failure. function tools.use_downloader(url, filename, cache) -- cgit v1.2.3-55-g6feb