help: simplify by moving to OPT_CMDMODE()
As preceding commits have incrementally established all of the --all,
--guides, --config and hidden --config-for-completion options are
mutually exclusive. So let's use OPT_CMDMODE() to parse the
command-line instead, and take advantage of its conflicting options
detection.
This is the first command with a hidden CMDMODE, so let's introduce a
OPT_CMDMODE_F() macro to go along with OPT_CMDMODE().
I think this makes the usage information that we emit slightly worse,
e.g. before we'd emit:
    $ git help --all --config
    fatal: --config and --all cannot be combined
    usage: git help [-a|--all] [--[no-]verbose]]
             [[-i|--info] [-m|--man] [-w|--web]] [<command>]
       or: git help [-g|--guides]
       or: git help [-c|--config]
    [...]
    $
And now:
    $ git help --all --config
    error: option `config' is incompatible with --all
    $
But improving that is a general topic for parse-options.c improvement,
i.e. we should probably emit the full usage in that case.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
			
			
				maint
			
			
		
							parent
							
								
									0a5940fbe7
								
							
						
					
					
						commit
						d35d03cf93
					
				|  | @ -34,27 +34,36 @@ enum help_format { | ||||||
| 	HELP_FORMAT_WEB | 	HELP_FORMAT_WEB | ||||||
| }; | }; | ||||||
|  |  | ||||||
| static const char *html_path; | static enum help_action { | ||||||
|  | 	HELP_ACTION_ALL = 1, | ||||||
|  | 	HELP_ACTION_GUIDES, | ||||||
|  | 	HELP_ACTION_CONFIG, | ||||||
|  | 	HELP_ACTION_CONFIG_FOR_COMPLETION, | ||||||
|  | } cmd_mode; | ||||||
|  |  | ||||||
| static int show_all = 0; | static const char *html_path; | ||||||
| static int show_guides = 0; |  | ||||||
| static int show_config; |  | ||||||
| static int verbose = 1; | static int verbose = 1; | ||||||
| static unsigned int colopts; | static unsigned int colopts; | ||||||
| static enum help_format help_format = HELP_FORMAT_NONE; | static enum help_format help_format = HELP_FORMAT_NONE; | ||||||
| static int exclude_guides; | static int exclude_guides; | ||||||
| static struct option builtin_help_options[] = { | static struct option builtin_help_options[] = { | ||||||
| 	OPT_BOOL('a', "all", &show_all, N_("print all available commands")), | 	OPT_CMDMODE('a', "all", &cmd_mode, N_("print all available commands"), | ||||||
|  | 		    HELP_ACTION_ALL), | ||||||
| 	OPT_HIDDEN_BOOL(0, "exclude-guides", &exclude_guides, N_("exclude guides")), | 	OPT_HIDDEN_BOOL(0, "exclude-guides", &exclude_guides, N_("exclude guides")), | ||||||
| 	OPT_BOOL('g', "guides", &show_guides, N_("print list of useful guides")), |  | ||||||
| 	OPT_BOOL('c', "config", &show_config, N_("print all configuration variable names")), |  | ||||||
| 	OPT_SET_INT_F(0, "config-for-completion", &show_config, "", 2, PARSE_OPT_HIDDEN), |  | ||||||
| 	OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN), | 	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"), | 	OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"), | ||||||
| 			HELP_FORMAT_WEB), | 			HELP_FORMAT_WEB), | ||||||
| 	OPT_SET_INT('i', "info", &help_format, N_("show info page"), | 	OPT_SET_INT('i', "info", &help_format, N_("show info page"), | ||||||
| 			HELP_FORMAT_INFO), | 			HELP_FORMAT_INFO), | ||||||
| 	OPT__VERBOSE(&verbose, N_("print command description")), | 	OPT__VERBOSE(&verbose, N_("print command description")), | ||||||
|  |  | ||||||
|  | 	OPT_CMDMODE('g', "guides", &cmd_mode, N_("print list of useful guides"), | ||||||
|  | 		    HELP_ACTION_GUIDES), | ||||||
|  | 	OPT_CMDMODE('c', "config", &cmd_mode, N_("print all configuration variable names"), | ||||||
|  | 		    HELP_ACTION_CONFIG), | ||||||
|  | 	OPT_CMDMODE_F(0, "config-for-completion", &cmd_mode, "", | ||||||
|  | 		    HELP_ACTION_CONFIG_FOR_COMPLETION, PARSE_OPT_HIDDEN), | ||||||
|  |  | ||||||
| 	OPT_END(), | 	OPT_END(), | ||||||
| }; | }; | ||||||
|  |  | ||||||
|  | @ -544,6 +553,13 @@ static const char *check_git_cmd(const char* cmd) | ||||||
| 	return cmd; | 	return cmd; | ||||||
| } | } | ||||||
|  |  | ||||||
|  | static void no_extra_argc(int argc) | ||||||
|  | { | ||||||
|  | 	if (argc) | ||||||
|  | 		usage_msg_opt(_("this option doesn't take any other arguments"), | ||||||
|  | 			      builtin_help_usage, builtin_help_options); | ||||||
|  | } | ||||||
|  |  | ||||||
| int cmd_help(int argc, const char **argv, const char *prefix) | int cmd_help(int argc, const char **argv, const char *prefix) | ||||||
| { | { | ||||||
| 	int nongit; | 	int nongit; | ||||||
|  | @ -554,28 +570,8 @@ int cmd_help(int argc, const char **argv, const char *prefix) | ||||||
| 			builtin_help_usage, 0); | 			builtin_help_usage, 0); | ||||||
| 	parsed_help_format = help_format; | 	parsed_help_format = help_format; | ||||||
|  |  | ||||||
| 	/* Incompatible options */ | 	switch (cmd_mode) { | ||||||
| 	if (show_all && show_config) | 	case HELP_ACTION_ALL: | ||||||
| 		usage_msg_opt(_("--config and --all cannot be combined"), |  | ||||||
| 			      builtin_help_usage, builtin_help_options); |  | ||||||
|  |  | ||||||
| 	if (show_all && show_guides) |  | ||||||
| 		usage_msg_opt(_("--config and --guides cannot be combined"), |  | ||||||
| 			      builtin_help_usage, builtin_help_options); |  | ||||||
|  |  | ||||||
| 	if (show_config && show_guides) |  | ||||||
| 		usage_msg_opt(_("--config and --guides cannot be combined"), |  | ||||||
| 			      builtin_help_usage, builtin_help_options); |  | ||||||
|  |  | ||||||
| 	/* Options that take no further arguments */ |  | ||||||
| 	if (argc && show_config) |  | ||||||
| 		usage_msg_opt(_("--config cannot be combined with command or guide names"), |  | ||||||
| 			      builtin_help_usage, builtin_help_options); |  | ||||||
| 	if (argc && show_guides) |  | ||||||
| 		usage_msg_opt(_("--guides cannot be combined with command or guide names"), |  | ||||||
| 			      builtin_help_usage, builtin_help_options); |  | ||||||
|  |  | ||||||
| 	if (show_all) { |  | ||||||
| 		git_config(git_help_config, NULL); | 		git_config(git_help_config, NULL); | ||||||
| 		if (verbose) { | 		if (verbose) { | ||||||
| 			setup_pager(); | 			setup_pager(); | ||||||
|  | @ -585,25 +581,20 @@ int cmd_help(int argc, const char **argv, const char *prefix) | ||||||
| 		printf(_("usage: %s%s"), _(git_usage_string), "\n\n"); | 		printf(_("usage: %s%s"), _(git_usage_string), "\n\n"); | ||||||
| 		load_command_list("git-", &main_cmds, &other_cmds); | 		load_command_list("git-", &main_cmds, &other_cmds); | ||||||
| 		list_commands(colopts, &main_cmds, &other_cmds); | 		list_commands(colopts, &main_cmds, &other_cmds); | ||||||
| 	} | 		printf("%s\n", _(git_more_info_string)); | ||||||
|  | 		break; | ||||||
| 	if (show_guides) | 	case HELP_ACTION_GUIDES: | ||||||
|  | 		no_extra_argc(argc); | ||||||
| 		list_guides_help(); | 		list_guides_help(); | ||||||
|  |  | ||||||
| 	if (show_all || show_guides) { |  | ||||||
| 		printf("%s\n", _(git_more_info_string)); | 		printf("%s\n", _(git_more_info_string)); | ||||||
| 		return 0; | 		return 0; | ||||||
| 	} | 	case HELP_ACTION_CONFIG_FOR_COMPLETION: | ||||||
|  | 		list_config_help(0); | ||||||
| 	if (show_config) { | 		return 0; | ||||||
| 		int for_human = show_config == 1; | 	case HELP_ACTION_CONFIG: | ||||||
|  | 		no_extra_argc(argc); | ||||||
| 		if (!for_human) { |  | ||||||
| 			list_config_help(for_human); |  | ||||||
| 			return 0; |  | ||||||
| 		} |  | ||||||
| 		setup_pager(); | 		setup_pager(); | ||||||
| 		list_config_help(for_human); | 		list_config_help(1); | ||||||
| 		printf("\n%s\n", _("'git help config' for more information")); | 		printf("\n%s\n", _("'git help config' for more information")); | ||||||
| 		return 0; | 		return 0; | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
|  | @ -169,8 +169,10 @@ struct option { | ||||||
| #define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0) | #define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0) | ||||||
| #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \ | #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \ | ||||||
| 				      (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1} | 				      (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1} | ||||||
| #define OPT_CMDMODE(s, l, v, h, i)  { OPTION_SET_INT, (s), (l), (v), NULL, \ | #define OPT_CMDMODE_F(s, l, v, h, i, f)  { OPTION_SET_INT, (s), (l), (v), NULL, \ | ||||||
| 				      (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) } | 				      (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), NULL, (i) } | ||||||
|  | #define OPT_CMDMODE(s, l, v, h, i)  OPT_CMDMODE_F(s, l, v, h, i, 0) | ||||||
|  |  | ||||||
| #define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0) | #define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0) | ||||||
| #define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \ | #define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \ | ||||||
| 				      N_("n"), (h), PARSE_OPT_NONEG } | 				      N_("n"), (h), PARSE_OPT_NONEG } | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue
	
	 Ævar Arnfjörð Bjarmason
						Ævar Arnfjörð Bjarmason