From c6a7d4c4656fbf0d9026741e4749d44a9446040c Mon Sep 17 00:00:00 2001
From: Paul Ouellette <oue.paul18@gmail.com>
Date: Wed, 19 Jun 2019 18:38:09 -0400
Subject: Add help option to subcommands

---
 src/luarocks/admin/cmd/add.lua           | 2 +-
 src/luarocks/admin/cmd/make_manifest.lua | 2 +-
 src/luarocks/admin/cmd/refresh_cache.lua | 2 +-
 src/luarocks/admin/cmd/remove.lua        | 2 +-
 src/luarocks/cmd.lua                     | 2 +-
 src/luarocks/cmd/build.lua               | 2 +-
 src/luarocks/cmd/config.lua              | 2 +-
 src/luarocks/cmd/doc.lua                 | 2 +-
 src/luarocks/cmd/download.lua            | 2 +-
 src/luarocks/cmd/init.lua                | 2 +-
 src/luarocks/cmd/install.lua             | 2 +-
 src/luarocks/cmd/lint.lua                | 2 +-
 src/luarocks/cmd/list.lua                | 2 +-
 src/luarocks/cmd/make.lua                | 2 +-
 src/luarocks/cmd/new_version.lua         | 2 +-
 src/luarocks/cmd/pack.lua                | 2 +-
 src/luarocks/cmd/path.lua                | 2 +-
 src/luarocks/cmd/purge.lua               | 2 +-
 src/luarocks/cmd/remove.lua              | 2 +-
 src/luarocks/cmd/search.lua              | 2 +-
 src/luarocks/cmd/show.lua                | 2 +-
 src/luarocks/cmd/test.lua                | 2 +-
 src/luarocks/cmd/unpack.lua              | 2 +-
 src/luarocks/cmd/upload.lua              | 2 +-
 src/luarocks/cmd/which.lua               | 2 +-
 src/luarocks/cmd/write_rockspec.lua      | 2 +-
 26 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/src/luarocks/admin/cmd/add.lua b/src/luarocks/admin/cmd/add.lua
index fa198baf..0682d89b 100644
--- a/src/luarocks/admin/cmd/add.lua
+++ b/src/luarocks/admin/cmd/add.lua
@@ -14,7 +14,7 @@ local index = require("luarocks.admin.index")
 function add.add_to_parser(parser)
    local cmd = parser:command("add", "Add a rock or rockspec to a rocks server.",
       util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "A local rockspec or rock file.")
       :args("+")
diff --git a/src/luarocks/admin/cmd/make_manifest.lua b/src/luarocks/admin/cmd/make_manifest.lua
index dba7ccf8..c7614ab5 100644
--- a/src/luarocks/admin/cmd/make_manifest.lua
+++ b/src/luarocks/admin/cmd/make_manifest.lua
@@ -14,7 +14,7 @@ local dir = require("luarocks.dir")
 function make_manifest.add_to_parser(parser)
    local cmd = parser:command("make_manifest", "Compile a manifest file for a repository.", 
       util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("repository", "Local repository pathname.")
       :args("?")
diff --git a/src/luarocks/admin/cmd/refresh_cache.lua b/src/luarocks/admin/cmd/refresh_cache.lua
index 0b2574b8..ab0708ec 100644
--- a/src/luarocks/admin/cmd/refresh_cache.lua
+++ b/src/luarocks/admin/cmd/refresh_cache.lua
@@ -9,7 +9,7 @@ local cache = require("luarocks.admin.cache")
 function refresh_cache.add_to_parser(parser)
    local cmd = parser:command(
       "refresh_cache", "Refresh local cache of a remote rocks server.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:option("--from", "The server to use. If not given, the default server "..
       "set in the upload_server variable from the configuration file is used instead.")
diff --git a/src/luarocks/admin/cmd/remove.lua b/src/luarocks/admin/cmd/remove.lua
index 4c0125a9..3fe70da6 100644
--- a/src/luarocks/admin/cmd/remove.lua
+++ b/src/luarocks/admin/cmd/remove.lua
@@ -14,7 +14,7 @@ local index = require("luarocks.admin.index")
 function admin_remove.add_to_parser(parser)
    local cmd = parser:command(
       "remove", "Remove a rock or rockspec from a rocks server.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "A local rockspec or rock file.")
       :args("+")
diff --git a/src/luarocks/cmd.lua b/src/luarocks/cmd.lua
index 1c8f0946..ab8d22c6 100644
--- a/src/luarocks/cmd.lua
+++ b/src/luarocks/cmd.lua
@@ -350,7 +350,7 @@ Variables:
       program.." - "..description, epilog)
       :help_max_width(80)
       :add_help("--help")
-      :add_help_command({add_help = false})
+      :add_help_command()
       :command_target("command")
       :require_command(false)
 
diff --git a/src/luarocks/cmd/build.lua b/src/luarocks/cmd/build.lua
index 2b9f4dd6..ea75fa3d 100644
--- a/src/luarocks/cmd/build.lua
+++ b/src/luarocks/cmd/build.lua
@@ -22,7 +22,7 @@ function cmd_build.add_to_parser(parser)
    local cmd = parser:command("build", "Build and install a rock, compiling "..
       "its C parts if any.", util.see_also())
       :summary("Build/compile a rock.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "A rockspec file, a source rock file, or the name of "..
       "a rock to be fetched from a repository.")
diff --git a/src/luarocks/cmd/config.lua b/src/luarocks/cmd/config.lua
index 6ec0efdf..fa954b3c 100644
--- a/src/luarocks/cmd/config.lua
+++ b/src/luarocks/cmd/config.lua
@@ -51,7 +51,7 @@ Query information about the LuaRocks configuration.
    for detailed information on the LuaRocks config file format.
 ]]))
       :summary("Query information about the LuaRocks configuration.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("key", "The configuration key.")
       :args("?")
diff --git a/src/luarocks/cmd/doc.lua b/src/luarocks/cmd/doc.lua
index 74508fab..94a1b548 100644
--- a/src/luarocks/cmd/doc.lua
+++ b/src/luarocks/cmd/doc.lua
@@ -19,7 +19,7 @@ function doc.add_to_parser(parser)
    For more information about a rock, see the 'show' command.
 ]]))
       :summary("Show documentation for an installed rock.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "Name of the rock.")
    cmd:argument("version", "Version of the rock.")
diff --git a/src/luarocks/cmd/download.lua b/src/luarocks/cmd/download.lua
index 80897d5a..2b09e764 100644
--- a/src/luarocks/cmd/download.lua
+++ b/src/luarocks/cmd/download.lua
@@ -9,7 +9,7 @@ local download = require("luarocks.download")
 function cmd_download.add_to_parser(parser)
    local cmd = parser:command(
       "download", "Download a specific rock file from a rocks server.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("name", "Name of the rock.")
       :args("?")
diff --git a/src/luarocks/cmd/init.lua b/src/luarocks/cmd/init.lua
index 1053850d..bb10eb79 100644
--- a/src/luarocks/cmd/init.lua
+++ b/src/luarocks/cmd/init.lua
@@ -12,7 +12,7 @@ local write_rockspec = require("luarocks.cmd.write_rockspec")
 
 function init.add_to_parser(parser)
    local cmd = parser:command("init", "Initialize a directory for a Lua project using LuaRocks.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("name", "The project name.")
       :args("?")
diff --git a/src/luarocks/cmd/install.lua b/src/luarocks/cmd/install.lua
index 3d3f0fe2..343bcfbe 100644
--- a/src/luarocks/cmd/install.lua
+++ b/src/luarocks/cmd/install.lua
@@ -18,7 +18,7 @@ local dir = require("luarocks.dir")
 
 function install.add_to_parser(parser)
    local cmd = parser:command("install", "Install a rock.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "The name of a rock to be fetched from a repository "..
       "or a filename of a locally available rock.")
diff --git a/src/luarocks/cmd/lint.lua b/src/luarocks/cmd/lint.lua
index 433eed84..2af19392 100644
--- a/src/luarocks/cmd/lint.lua
+++ b/src/luarocks/cmd/lint.lua
@@ -12,7 +12,7 @@ function lint.add_to_parser(parser)
       "Returns success if the text of the rockspec is syntactically correct, else failure.",
       util.see_also())
       :summary("Check syntax of a rockspec.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rockspec", "The rockspec to check.")
 end
diff --git a/src/luarocks/cmd/list.lua b/src/luarocks/cmd/list.lua
index 2bb7660f..01555e89 100644
--- a/src/luarocks/cmd/list.lua
+++ b/src/luarocks/cmd/list.lua
@@ -12,7 +12,7 @@ local path = require("luarocks.path")
 
 function list.add_to_parser(parser)
    local cmd = parser:command("list", "List currently installed rocks.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("filter", "A substring of a rock name to filter by.")
       :args("?")
diff --git a/src/luarocks/cmd/make.lua b/src/luarocks/cmd/make.lua
index a8084293..7ac9978a 100644
--- a/src/luarocks/cmd/make.lua
+++ b/src/luarocks/cmd/make.lua
@@ -35,7 +35,7 @@ NB: Use `luarocks install` with the `--only-deps` flag if you want to install
 only dependencies of the rockspec (see `luarocks help install`).
 ]], util.see_also())
       :summary("Compile package in current directory using a rockspec.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rockspec", "Rockspec for the rock to build.")
       :args("?")
diff --git a/src/luarocks/cmd/new_version.lua b/src/luarocks/cmd/new_version.lua
index 37d4206e..7c3e9329 100644
--- a/src/luarocks/cmd/new_version.lua
+++ b/src/luarocks/cmd/new_version.lua
@@ -39,7 +39,7 @@ If a directory is not given, it defaults to the current directory.
 WARNING: it writes the new rockspec to the given directory,
 overwriting the file if it already exists.]], util.see_also())
       :summary("Auto-write a rockspec for a new version of a rock.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "Package name or rockspec.")
       :args("?")
diff --git a/src/luarocks/cmd/pack.lua b/src/luarocks/cmd/pack.lua
index e5e7f525..28c39687 100644
--- a/src/luarocks/cmd/pack.lua
+++ b/src/luarocks/cmd/pack.lua
@@ -10,7 +10,7 @@ local queries = require("luarocks.queries")
 
 function cmd_pack.add_to_parser(parser)
    local cmd = parser:command("pack", "Create a rock, packing sources or binaries.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "A rockspec file, for creating a source rock, or the "..
       "name of an installed package, for creating a binary rock.")
diff --git a/src/luarocks/cmd/path.lua b/src/luarocks/cmd/path.lua
index 8921d2a5..c65aca01 100644
--- a/src/luarocks/cmd/path.lua
+++ b/src/luarocks/cmd/path.lua
@@ -18,7 +18,7 @@ And on Windows:
   luarocks path > "%temp%\_lrp.bat" && call "%temp%\_lrp.bat" && del "%temp%\_lrp.bat"]],
   util.see_also())
       :summary("Return the currently configured package path.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:flag("--no-bin", "Do not export the PATH variable.")
    cmd:flag("--append", "Appends the paths to the existing paths. Default is "..
diff --git a/src/luarocks/cmd/purge.lua b/src/luarocks/cmd/purge.lua
index 9b1e2ae9..7bb6b4ec 100644
--- a/src/luarocks/cmd/purge.lua
+++ b/src/luarocks/cmd/purge.lua
@@ -23,7 +23,7 @@ By default, it removes all rocks from a tree.
 The --tree option is mandatory: luarocks purge does not assume a default tree.]],
    util.see_also())
       :summary("Remove all installed rocks from a tree.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:flag("--old-versions", "Keep the highest-numbered version of each "..
       "rock and remove the other ones. By default it only removes old "..
diff --git a/src/luarocks/cmd/remove.lua b/src/luarocks/cmd/remove.lua
index e311f399..b78d61bd 100644
--- a/src/luarocks/cmd/remove.lua
+++ b/src/luarocks/cmd/remove.lua
@@ -23,7 +23,7 @@ Will only perform the removal if it does not break dependencies.
 To override this check and force the removal, use --force or --force-fast.]],
    util.see_also())
       :summary("Uninstall a rock.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "Name of the rock to be uninstalled.")
    cmd:argument("version", "Version of the rock to uninstall.")
diff --git a/src/luarocks/cmd/search.lua b/src/luarocks/cmd/search.lua
index d1546e80..8c735b22 100644
--- a/src/luarocks/cmd/search.lua
+++ b/src/luarocks/cmd/search.lua
@@ -11,7 +11,7 @@ local results = require("luarocks.results")
 
 function cmd_search.add_to_parser(parser)
    local cmd = parser:command("search", "Query the LuaRocks servers.", util.see_also())
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("name", "Name of the rock to search for.")
       :args("?")
diff --git a/src/luarocks/cmd/show.lua b/src/luarocks/cmd/show.lua
index 9bfedd20..3a7d86e0 100644
--- a/src/luarocks/cmd/show.lua
+++ b/src/luarocks/cmd/show.lua
@@ -20,7 +20,7 @@ Show information about an installed rock.
 Without any flags, show all module information.
 With flags, return only the desired information.]], util.see_also())
       :summary("Show information about an installed rock.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "Name of an installed rock.")
    cmd:argument("version", "Rock version.")
diff --git a/src/luarocks/cmd/test.lua b/src/luarocks/cmd/test.lua
index baf7515e..cef17f53 100644
--- a/src/luarocks/cmd/test.lua
+++ b/src/luarocks/cmd/test.lua
@@ -18,7 +18,7 @@ To make sure that test suite flags are not interpreted as LuaRocks flags, use --
 to separate LuaRocks arguments from test suite arguments.]],
       util.see_also())
       :summary("Run the test suite in the current directory.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rockspec", "Project rockspec.")
       :args("?")
diff --git a/src/luarocks/cmd/unpack.lua b/src/luarocks/cmd/unpack.lua
index 65ce5c7c..b84b4166 100644
--- a/src/luarocks/cmd/unpack.lua
+++ b/src/luarocks/cmd/unpack.lua
@@ -17,7 +17,7 @@ Argument may be a rock file, or the name of a rock in a rocks server.
 In the latter case, the rock version may be given as a second argument.]],
       util.see_also())
       :summary("Unpack the contents of a rock.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rock", "A rock file or the name of a rock.")
    cmd:argument("version", "Rock version.")
diff --git a/src/luarocks/cmd/upload.lua b/src/luarocks/cmd/upload.lua
index 64bf18ad..44e2a830 100644
--- a/src/luarocks/cmd/upload.lua
+++ b/src/luarocks/cmd/upload.lua
@@ -12,7 +12,7 @@ function upload.add_to_parser(parser)
    local cmd = parser:command("upload", "Pack a source rock file (.src.rock extension) "..
       "and upload it and the rockspec to the public rocks repository.", util.see_also())
       :summary("Upload a rockspec to the public rocks repository.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("rockspec", "Rockspec for the rock to upload.")
 
diff --git a/src/luarocks/cmd/which.lua b/src/luarocks/cmd/which.lua
index 571d2638..7fdc5228 100644
--- a/src/luarocks/cmd/which.lua
+++ b/src/luarocks/cmd/which.lua
@@ -14,7 +14,7 @@ function which_cmd.add_to_parser(parser)
       'luarocks.loader, like "/usr/local/lua/'..cfg.lua_version..'/foo/bar.lua".',
       util.see_also())
       :summary("Tell which file corresponds to a given module name.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("modname", "Module name.")
 end
diff --git a/src/luarocks/cmd/write_rockspec.lua b/src/luarocks/cmd/write_rockspec.lua
index 4b16c0b7..846aebd4 100644
--- a/src/luarocks/cmd/write_rockspec.lua
+++ b/src/luarocks/cmd/write_rockspec.lua
@@ -39,7 +39,7 @@ using 'dev' as a fallback default version.
 Note that the generated file is a _starting point_ for writing a
 rockspec, and is not guaranteed to be complete or correct. ]], util.see_also())
       :summary("Write a template for a rockspec file.")
-      :add_help(false)
+      :add_help("--help")
 
    cmd:argument("name", "Name of the rock.")
       :args("?")
-- 
cgit v1.2.3-55-g6feb