[PATCH/RFC 5/5] help: add "-a --verbose" to list all commands with synopsis

[Nguyễn Thái Ngọc Duy]

Signed-off-by: Nguyễn Thái Ngọc Duy <pclo...@gmail.com>
---
 Documentation/git-help.txt |  4 ++-
 builtin/help.c             |  6 ++++
 help.c                     | 61 ++++++++++++++++++++++++++++++++++++++
 help.h                     |  1 +
 4 files changed, 71 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 40d328a4b3..a40fc38d8b 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -8,7 +8,7 @@ git-help - Display help information about Git
 SYNOPSIS
 --------
 [verse]
-'git help' [-a|--all] [-g|--guide]
+'git help' [-a|--all [--verbose]] [-g|--guide]
           [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
 
 DESCRIPTION
@@ -42,6 +42,8 @@ OPTIONS
 --all::
        Prints all the available commands on the standard output. This
        option overrides any given command or guide name.
+       When used with `--verbose` print description for all recognized
+       commands.
 
 -g::
 --guides::
diff --git a/builtin/help.c b/builtin/help.c
index 598867cfea..a371199674 100644
--- a/builtin/help.c
+++ b/builtin/help.c
@@ -36,6 +36,7 @@ static const char *html_path;
 
 static int show_all = 0;
 static int show_guides = 0;
+static int verbose;
 static unsigned int colopts;
 static enum help_format help_format = HELP_FORMAT_NONE;
 static int exclude_guides;
@@ -48,6 +49,7 @@ static struct option builtin_help_options[] = {
                        HELP_FORMAT_WEB),
        OPT_SET_INT('i', "info", &help_format, N_("show info page"),
                        HELP_FORMAT_INFO),
+       OPT__VERBOSE(&verbose, N_("print command description")),
        OPT_END(),
 };
 
@@ -463,6 +465,10 @@ int cmd_help(int argc, const char **argv, const char 
*prefix)
 
        if (show_all) {
                git_config(git_help_config, NULL);
+               if (verbose) {
+                       list_all_cmds_help();
+                       return 0;
+               }
                printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
                load_command_list("git-", &main_cmds, &other_cmds);
                list_commands(colopts, &main_cmds, &other_cmds);
diff --git a/help.c b/help.c
index cacd8249bb..afbf98c241 100644
--- a/help.c
+++ b/help.c
@@ -282,6 +282,67 @@ void list_porcelain_cmds(void)
        }
 }
 
+static int cmd_category_cmp(const void *elem1, const void *elem2)
+{
+       const struct cmdname_help *e1 = elem1;
+       const struct cmdname_help *e2 = elem2;
+
+       if (e1->category < e2->category)
+               return -1;
+       if (e1->category > e2->category)
+               return 1;
+       return strcmp(e1->name, e2->name);
+}
+
+static const char *get_category_name(unsigned int category)
+{
+       switch (category) {
+       case CAT_ancillaryinterrogators: return _("Ancillary interrogators");
+       case CAT_ancillarymanipulators: return _("Ancillary manipulators");
+       case CAT_foreignscminterface: return _("Foreign SCM interface");
+       case CAT_mainporcelain: return _("Main porcelain");
+       case CAT_plumbinginterrogators: return _("Plumbing interrogators");
+       case CAT_plumbingmanipulators: return _("Plumbing interrogators");
+       case CAT_purehelpers: return _("Pure helpers");
+       case CAT_synchelpers: return _("Sync helpers");
+       case CAT_synchingrepositories: return _("Synching repositories");
+       default:
+               die("BUG: unknown command category %u", category);
+       }
+}
+
+void list_all_cmds_help(void)
+{
+       int i, longest = 0;
+       int current_category = -1;
+       int nr = ARRAY_SIZE(command_list);
+       struct cmdname_help *cmds = command_list;
+
+       for (i = 0; i < nr; i++) {
+               struct cmdname_help *cmd = cmds + i;
+
+               if (longest < strlen(cmd->name))
+                       longest = strlen(cmd->name);
+       }
+
+       QSORT(cmds, nr, cmd_category_cmp);
+
+       puts(_("These are all Git commands:"));
+
+       for (i = 0; i < nr; i++) {
+               struct cmdname_help *cmd = cmds + i;
+
+               if (cmd->category != current_category) {
+                       current_category = cmd->category;
+                       printf("\n%s:\n", get_category_name(current_category));
+               }
+
+               printf("   %s   ", cmd->name);
+               mput_char(' ', longest - strlen(cmd->name));
+               puts(_(cmd->help));
+       }
+}
+
 int is_in_cmdlist(struct cmdnames *c, const char *s)
 {
        int i;
diff --git a/help.h b/help.h
index 33e2210ebd..62449f1b7e 100644
--- a/help.h
+++ b/help.h
@@ -17,6 +17,7 @@ static inline void mput_char(char c, unsigned int num)
 }
 
 extern void list_common_cmds_help(void);
+extern void list_all_cmds_help(void);
 extern void list_all_cmds(void);
 extern void list_porcelain_cmds(void);
 extern const char *help_unknown_cmd(const char *cmd);
-- 
2.17.0.rc0.348.gd5a49e0b6f