From d7c9f4b6d6d44d3b6b668fa2e3084a01a09fd80a Mon Sep 17 00:00:00 2001 From: Hisham Muhammad Date: Mon, 16 Apr 2018 14:43:08 -0300 Subject: Add config file format link in `luarocks help config` Closes #280. --- src/luarocks/cmd/config.lua | 4 ++++ src/luarocks/cmd/help.lua | 3 +++ 2 files changed, 7 insertions(+) (limited to 'src') diff --git a/src/luarocks/cmd/config.lua b/src/luarocks/cmd/config.lua index b68f7898..e18ab0b8 100644 --- a/src/luarocks/cmd/config.lua +++ b/src/luarocks/cmd/config.lua @@ -21,6 +21,10 @@ config_cmd.help = [[ --rock-trees Rocks trees in use. First the user tree, then the system tree. ]] +config_cmd.help_see_also = [[ + https://github.com/luarocks/luarocks/wiki/Config-file-format + for detailed information on the LuaRocks config file format. +]] local function config_file(conf) print(dir.normalize(conf.file)) diff --git a/src/luarocks/cmd/help.lua b/src/luarocks/cmd/help.lua index d58fdcc0..18620b9e 100644 --- a/src/luarocks/cmd/help.lua +++ b/src/luarocks/cmd/help.lua @@ -108,6 +108,9 @@ function help.command(flags, command) print_section("DESCRIPTION") util.printout("",(cmd.help:gsub("\n","\n\t"):gsub("\n\t$",""))) print_section("SEE ALSO") + if cmd.help_see_also then + util.printout(cmd.help_see_also) + end util.printout("","'"..program.." help' for general options and configuration.\n") else return nil, "Unknown command: "..command -- cgit v1.2.3-55-g6feb