Skip to content

Commit

Permalink
Print info about "git help COMMAND" on git's main usage pages
Browse files Browse the repository at this point in the history
Git's main usage pages did not show "git help" as a way to get more
information on a specific subcommand. This patch adds an info line after
the list of git commands currently printed by "git", "git help", "git
--help" and "git help --all".

Signed-off-by: Teemu Likonen <tlikonen@iki.fi>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Teemu Likonen authored and Junio C Hamano committed Jun 6, 2008
1 parent e919cb3 commit b7d9681
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions builtin.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

extern const char git_version_string[];
extern const char git_usage_string[];
extern const char git_more_info_string[];

extern void list_common_cmds_help(void);
extern void help_unknown_cmd(const char *cmd);
Expand Down
4 changes: 4 additions & 0 deletions git.c
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
const char git_usage_string[] =
"git [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate|--no-pager] [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] [--help] COMMAND [ARGS]";

const char git_more_info_string[] =
"See 'git help COMMAND' for more information on a specific command.";

static int handle_options(const char*** argv, int* argc, int* envchanged)
{
int handled = 0;
Expand Down Expand Up @@ -427,6 +430,7 @@ int main(int argc, const char **argv)
/* The user didn't specify a command; give them help */
printf("usage: %s\n\n", git_usage_string);
list_common_cmds_help();
printf("\n%s\n", git_more_info_string);
exit(1);
}
cmd = argv[0];
Expand Down
2 changes: 2 additions & 0 deletions help.c
Original file line number Diff line number Diff line change
Expand Up @@ -649,12 +649,14 @@ int cmd_help(int argc, const char **argv, const char *prefix)
if (show_all) {
printf("usage: %s\n\n", git_usage_string);
list_commands();
printf("%s\n", git_more_info_string);
return 0;
}

if (!argv[0]) {
printf("usage: %s\n\n", git_usage_string);
list_common_cmds_help();
printf("\n%s\n", git_more_info_string);
return 0;
}

Expand Down

0 comments on commit b7d9681

Please sign in to comment.