diff options
author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2022-02-21 20:38:50 +0100 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2022-02-23 13:41:37 -0800 |
commit | 503cddacb63b9a37d063de5b11ac188de822e06f (patch) | |
tree | a29bf3320d0a3f0d3e91fdf071d8a4f31b01599b /builtin/help.c | |
parent | 5e8068b74df8d0c58042a3ffe1c09dbffbbc63f7 (diff) | |
download | git-503cddacb63b9a37d063de5b11ac188de822e06f.tar.gz |
help: error if [-a|-g|-c] and [-i|-m|-w] are combined
Add more sanity checking to "git help" usage by erroring out if these
man viewer options are combined with incompatible command-modes that
will never use these documentation viewers.
This continues the work started in d35d03cf93e (help: simplify by
moving to OPT_CMDMODE(), 2021-09-22) of adding more sanity checking to
"git help". Doing this allows us to clarify the "SYNOPSIS" in the
documentation, and the "git help -h" output.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'builtin/help.c')
-rw-r--r-- | builtin/help.c | 41 |
1 files changed, 35 insertions, 6 deletions
diff --git a/builtin/help.c b/builtin/help.c index b682446bbf..1fc45adfcc 100644 --- a/builtin/help.c +++ b/builtin/help.c @@ -574,12 +574,40 @@ static const char *check_git_cmd(const char* cmd) return cmd; } -static void opt_mode_usage(int argc, const char *opt_mode) +static void no_help_format(const char *opt_mode, enum help_format fmt) +{ + const char *opt_fmt; + + switch (fmt) { + case HELP_FORMAT_NONE: + return; + case HELP_FORMAT_MAN: + opt_fmt = "--man"; + break; + case HELP_FORMAT_INFO: + opt_fmt = "--info"; + break; + case HELP_FORMAT_WEB: + opt_fmt = "--web"; + break; + default: + BUG("unreachable"); + } + + usage_msg_optf(_("options '%s' and '%s' cannot be used together"), + builtin_help_usage, builtin_help_options, opt_mode, + opt_fmt); +} + +static void opt_mode_usage(int argc, const char *opt_mode, + enum help_format fmt) { if (argc) usage_msg_optf(_("the '%s' option doesn't take any non-option arguments"), builtin_help_usage, builtin_help_options, opt_mode); + + no_help_format(opt_mode, fmt); } int cmd_help(int argc, const char **argv, const char *prefix) @@ -594,7 +622,7 @@ int cmd_help(int argc, const char **argv, const char *prefix) switch (cmd_mode) { case HELP_ACTION_ALL: - opt_mode_usage(argc, "--all"); + opt_mode_usage(argc, "--all", help_format); if (verbose) { setup_pager(); list_all_cmds_help(); @@ -606,20 +634,21 @@ int cmd_help(int argc, const char **argv, const char *prefix) printf("%s\n", _(git_more_info_string)); break; case HELP_ACTION_GUIDES: - opt_mode_usage(argc, "--guides"); + opt_mode_usage(argc, "--guides", help_format); list_guides_help(); printf("%s\n", _(git_more_info_string)); return 0; case HELP_ACTION_CONFIG_FOR_COMPLETION: - opt_mode_usage(argc, "--config-for-completion"); + opt_mode_usage(argc, "--config-for-completion", help_format); list_config_help(SHOW_CONFIG_VARS); return 0; case HELP_ACTION_CONFIG_SECTIONS_FOR_COMPLETION: - opt_mode_usage(argc, "--config-sections-for-completion"); + opt_mode_usage(argc, "--config-sections-for-completion", + help_format); list_config_help(SHOW_CONFIG_SECTIONS); return 0; case HELP_ACTION_CONFIG: - opt_mode_usage(argc, "--config"); + opt_mode_usage(argc, "--config", help_format); setup_pager(); list_config_help(SHOW_CONFIG_HUMAN); printf("\n%s\n", _("'git help config' for more information")); |