Document cache option.

2 files changed, 4 insertions, 0 deletions

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)