aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHisham Muhammad <hisham@gobolinux.org>2014-08-11 11:33:50 -0300
committerHisham Muhammad <hisham@gobolinux.org>2014-08-11 11:33:50 -0300
commit107fe26c73e4cf83c585e1072f74268bc88401b1 (patch)
tree5b3f3ed775770c64cc2c260102b79625386b62a0
parent23739a7fbedcadd3ba38af11d0f3146a8ef37061 (diff)
downloadluarocks-107fe26c73e4cf83c585e1072f74268bc88401b1.tar.gz
luarocks-107fe26c73e4cf83c585e1072f74268bc88401b1.tar.bz2
luarocks-107fe26c73e4cf83c585e1072f74268bc88401b1.zip
Correct inaccuracy in documentation.
The logic for determining the default local repository can get complicated (see luarocks/command_line.lua and luarocks/path.lua), so saying cfg.root_dir wouldn't be quite precise either. So let's avoid the issue. Closes #278.
-rw-r--r--src/luarocks/manif.lua2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/luarocks/manif.lua b/src/luarocks/manif.lua
index f1d1629c..f53f8dca 100644
--- a/src/luarocks/manif.lua
+++ b/src/luarocks/manif.lua
@@ -414,7 +414,7 @@ end
414-- @param name string: Name of a package from the repository. 414-- @param name string: Name of a package from the repository.
415-- @param version string: Version of a package from the repository. 415-- @param version string: Version of a package from the repository.
416-- @param repo string or nil: Pathname of a local repository. If not given, 416-- @param repo string or nil: Pathname of a local repository. If not given,
417-- the default local repository configured as cfg.rocks_dir is used. 417-- the default local repository is used.
418-- @param deps_mode string: Dependency mode: "one" for the current default tree, 418-- @param deps_mode string: Dependency mode: "one" for the current default tree,
419-- "all" for all trees, "order" for all trees with priority >= the current default, 419-- "all" for all trees, "order" for all trees with priority >= the current default,
420-- "none" for using the default dependency mode from the configuration. 420-- "none" for using the default dependency mode from the configuration.