Subject: Re: [PATCH v2 8/9] help: add --no-[external-commands|aliases] for use with --all

From: Junio C Hamano <[email-masked]>
Date: Wed, 23 Feb 2022 14:19:22 -0800

Ævar Arnfjörð Bjarmason  <[email-masked]> writes:

> Add the ability to only emit git's own usage information under
> --all. This also allows us to extend the "test_section_spacing" tests
> added in a preceding commit to test "git help --all"
> output.

Makes sense.

> +static int show_external_commands = -1;
> +static int show_aliases = -1;
>  static struct option builtin_help_options[] = {
>  	OPT_CMDMODE('a', "all", &cmd_mode, N_("print all available commands"),
>  		    HELP_ACTION_ALL),
> +	OPT_BOOL(0, "external-commands", &show_external_commands,
> +		 N_("show external commands in --all")),
> +	OPT_BOOL(0, "aliases", &show_aliases, N_("show aliases in --all")),
>  	OPT_HIDDEN_BOOL(0, "exclude-guides", &exclude_guides, N_("exclude guides")),
>  	OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN),
>  	OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"),
> @@ -75,7 +80,7 @@ static struct option builtin_help_options[] = {
>  };
>  
>  static const char * const builtin_help_usage[] = {
> -	N_("git help [-a|--all] [--[no-]verbose]]"),
> +	N_("git help [-a|--all] [--[no-]verbose]] [--[no-]external-commands] [--[no-]aliases]"),
>  	N_("git help [[-i|--info] [-m|--man] [-w|--web]] [<command>]"),
>  	N_("git help [-g|--guides]"),
>  	N_("git help [-c|--config]"),
> @@ -620,12 +625,19 @@ int cmd_help(int argc, const char **argv, const char *prefix)
>  			builtin_help_usage, 0);
>  	parsed_help_format = help_format;
>  
> +	if (cmd_mode != HELP_ACTION_ALL &&
> +	    (show_external_commands >= 0 ||
> +	     show_aliases >= 0))
> +		usage_msg_opt(_("the '--no-[external-commands|aliases]' options can only be used with '--all'"),
> +			      builtin_help_usage, builtin_help_options);

Nice attention to a small detail.

>  	switch (cmd_mode) {
>  	case HELP_ACTION_ALL:
>  		opt_mode_usage(argc, "--all", help_format);
>  		if (verbose) {
>  			setup_pager();
> -			list_all_cmds_help();
> +			list_all_cmds_help(show_external_commands,
> +					   show_aliases);
>  			return 0;
>  		}
>  		printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
> diff --git a/help.c b/help.c
> index 004117347ee..45a21e7e35c 100644
> --- a/help.c
> +++ b/help.c
> @@ -476,15 +476,17 @@ static void list_all_cmds_help_aliases(int longest)
>  	string_list_clear(&alias_list, 1);
>  }
>  
> -void list_all_cmds_help(void)
> +void list_all_cmds_help(int show_external_commands, int show_aliases)
>  {
>  	int longest;
>  
>  	puts(_("See 'git help <command>' to read about a specific subcommand"));
>  	print_cmd_by_category(main_categories, &longest);
>  
> -	list_all_cmds_help_external_commands();
> -	list_all_cmds_help_aliases(longest);
> +	if (show_external_commands)
> +		list_all_cmds_help_external_commands();
> +	if (show_aliases)
> +		list_all_cmds_help_aliases(longest);
>  }

OK.  Quite straight-forward after the earlier split.