Skip to content

Commit 0371a76

Browse files
phil-blaingitster
authored andcommitted
help: drop usage of 'common' and 'useful' for guides
Since 1b81d8c (help: use command-list.txt for the source of guides, 2018-05-20), all man5/man7 guides listed in command-list.txt appear in the output of 'git help -g'. However, 'git help -g' still prefixes this list with "The common Git guides are:", which makes one wonder if there are others! In the same spirit, the man page for 'git help' describes the '--guides' option as listing 'useful' guides, which is not false per se but can also be taken to mean that there are other guides that exist but are not useful. Instead of 'common' and 'useful', use 'Git concept guides' in both places. To keep the code in line with this change, rename help.c::list_common_guides_help to list_guides_help. Signed-off-by: Philippe Blain <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 2135e1a commit 0371a76

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

Documentation/git-help.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ on the standard output.
2121
If the option `--all` or `-a` is given, all available commands are
2222
printed on the standard output.
2323

24-
If the option `--guides` or `-g` is given, a list of the useful
25-
Git guides is also printed on the standard output.
24+
If the option `--guides` or `-g` is given, a list of the
25+
Git concept guides is also printed on the standard output.
2626

2727
If a command, or a guide, is given, a manual page for that command or
2828
guide is brought up. The 'man' program is used by default for this
@@ -58,7 +58,7 @@ OPTIONS
5858

5959
-g::
6060
--guides::
61-
Prints a list of useful guides on the standard output. This
61+
Prints a list of the Git concept guides on the standard output. This
6262
option overrides any given command or guide name.
6363

6464
-i::

builtin/help.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ int cmd_help(int argc, const char **argv, const char *prefix)
579579
}
580580

581581
if (show_guides)
582-
list_common_guides_help();
582+
list_guides_help();
583583

584584
if (show_all || show_guides) {
585585
printf("%s\n", _(git_more_info_string));

help.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -397,10 +397,10 @@ void list_cmds_by_config(struct string_list *list)
397397
}
398398
}
399399

400-
void list_common_guides_help(void)
400+
void list_guides_help(void)
401401
{
402402
struct category_description catdesc[] = {
403-
{ CAT_guide, N_("The common Git guides are:") },
403+
{ CAT_guide, N_("The Git concept guides are:") },
404404
{ 0, NULL }
405405
};
406406
print_cmd_by_category(catdesc, NULL);

help.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ static inline void mput_char(char c, unsigned int num)
2121

2222
void list_common_cmds_help(void);
2323
void list_all_cmds_help(void);
24-
void list_common_guides_help(void);
24+
void list_guides_help(void);
2525

2626
void list_all_main_cmds(struct string_list *list);
2727
void list_all_other_cmds(struct string_list *list);

0 commit comments

Comments
 (0)