From: Patrick Steinhardt <ps@pks.im>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v2 2/4] parse-options: extract functions to print single option
Date: Fri, 02 Oct 2026 10:09:47 +0200 [thread overview]
Message-ID: <20261002-b4-pks-parse-options-subcommand-groups-v2-2-3299bee52dea@pks.im> (raw)
In-Reply-To: <20261002-b4-pks-parse-options-subcommand-groups-v2-0-3299bee52dea@pks.im>
The logic to print a single option has grown somewhat long. Extract the
logic into two functions to print a single option and a flag,
specifically. This refactoring makes a subsequent change easier to
implement.
Signed-off-by: Patrick Steinhardt <ps@pks.im>
---
parse-options.c | 169 +++++++++++++++++++++++++++++++-------------------------
1 file changed, 94 insertions(+), 75 deletions(-)
diff --git a/parse-options.c b/parse-options.c
index 8bb30ec116..fdcb29f2a1 100644
--- a/parse-options.c
+++ b/parse-options.c
@@ -1323,6 +1323,97 @@ static const struct option *find_option_by_long_name(const struct option *opts,
return NULL;
}
+static int usage_print_flag(const struct option *opt,
+ FILE *outfile,
+ const char **positive_name)
+{
+ int off = 0;
+
+ if (opt->short_name) {
+ if (opt->flags & PARSE_OPT_NODASH)
+ off += fprintf(outfile, "%c", opt->short_name);
+ else
+ off += fprintf(outfile, "-%c", opt->short_name);
+ }
+ if (opt->long_name && opt->short_name)
+ off += fprintf(outfile, ", ");
+ if (opt->long_name) {
+ const char *long_name = opt->long_name;
+ if ((opt->flags & PARSE_OPT_NONEG) ||
+ skip_prefix(long_name, "no-", positive_name))
+ off += fprintf(outfile, "--%s", long_name);
+ else
+ off += fprintf(outfile, "--[no-]%s", long_name);
+ }
+
+ if (opt->type == OPTION_NUMBER)
+ off += utf8_fprintf(outfile, _("-NUM"));
+
+ if ((opt->flags & PARSE_OPT_LITERAL_ARGHELP) ||
+ !(opt->flags & PARSE_OPT_NOARG))
+ off += usage_argh(opt, outfile);
+
+ return off;
+}
+
+static void usage_print_option(const struct option *opt,
+ const struct option *all_opts,
+ int full,
+ int *need_newline,
+ FILE *outfile)
+{
+ const char *positive_name = NULL;
+ const char *cp, *np;
+ size_t pos;
+
+ if (opt->type == OPTION_SUBCOMMAND)
+ return;
+ if (!full && (opt->flags & PARSE_OPT_HIDDEN))
+ return;
+ if (opt->type == OPTION_GROUP) {
+ fputc('\n', outfile);
+ *need_newline = 0;
+ if (*opt->help)
+ fprintf(outfile, "%s\n", _(opt->help));
+ return;
+ }
+
+ if (*need_newline) {
+ fputc('\n', outfile);
+ *need_newline = 0;
+ }
+
+ pos = usage_indent(outfile);
+ pos += usage_print_flag(opt, outfile, &positive_name);
+
+ if (opt->type == OPTION_ALIAS) {
+ usage_padding(outfile, pos);
+ fprintf_ln(outfile, _("alias of --%s"),
+ (const char *)opt->value);
+ return;
+ }
+
+ for (cp = opt->help ? _(opt->help) : ""; *cp; cp = np) {
+ np = strchrnul(cp, '\n');
+ if (*np)
+ np++;
+ usage_padding(outfile, pos);
+ fwrite(cp, 1, np - cp, outfile);
+ pos = 0;
+ }
+ fputc('\n', outfile);
+
+ if (positive_name) {
+ if (find_option_by_long_name(all_opts, positive_name))
+ return;
+ pos = usage_indent(outfile);
+ pos += fprintf(outfile, "--%s", positive_name);
+ usage_padding(outfile, pos);
+ fprintf_ln(outfile, _("opposite of --no-%s"),
+ positive_name);
+ }
+}
+
static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t *ctx,
const char * const *usagestr,
const struct option *opts,
@@ -1408,81 +1499,9 @@ static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t
}
need_newline = 1;
-
- for (; opts->type != OPTION_END; opts++) {
- size_t pos;
- const char *cp, *np;
- const char *positive_name = NULL;
-
- if (opts->type == OPTION_SUBCOMMAND)
- continue;
- if (!full && (opts->flags & PARSE_OPT_HIDDEN))
- continue;
- if (opts->type == OPTION_GROUP) {
- fputc('\n', outfile);
- need_newline = 0;
- if (*opts->help)
- fprintf(outfile, "%s\n", _(opts->help));
- continue;
- }
-
- if (need_newline) {
- fputc('\n', outfile);
- need_newline = 0;
- }
-
- pos = usage_indent(outfile);
- if (opts->short_name) {
- if (opts->flags & PARSE_OPT_NODASH)
- pos += fprintf(outfile, "%c", opts->short_name);
- else
- pos += fprintf(outfile, "-%c", opts->short_name);
- }
- if (opts->long_name && opts->short_name)
- pos += fprintf(outfile, ", ");
- if (opts->long_name) {
- const char *long_name = opts->long_name;
- if ((opts->flags & PARSE_OPT_NONEG) ||
- skip_prefix(long_name, "no-", &positive_name))
- pos += fprintf(outfile, "--%s", long_name);
- else
- pos += fprintf(outfile, "--[no-]%s", long_name);
- }
-
- if (opts->type == OPTION_NUMBER)
- pos += utf8_fprintf(outfile, _("-NUM"));
-
- if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
- !(opts->flags & PARSE_OPT_NOARG))
- pos += usage_argh(opts, outfile);
-
- if (opts->type == OPTION_ALIAS) {
- usage_padding(outfile, pos);
- fprintf_ln(outfile, _("alias of --%s"),
- (const char *)opts->value);
- continue;
- }
-
- for (cp = opts->help ? _(opts->help) : ""; *cp; cp = np) {
- np = strchrnul(cp, '\n');
- if (*np)
- np++;
- usage_padding(outfile, pos);
- fwrite(cp, 1, np - cp, outfile);
- pos = 0;
- }
- fputc('\n', outfile);
-
- if (positive_name) {
- if (find_option_by_long_name(all_opts, positive_name))
- continue;
- pos = usage_indent(outfile);
- pos += fprintf(outfile, "--%s", positive_name);
- usage_padding(outfile, pos);
- fprintf_ln(outfile, _("opposite of --no-%s"),
- positive_name);
- }
- }
+ for (; opts->type != OPTION_END; opts++)
+ usage_print_option(opts, all_opts, full,
+ &need_newline, outfile);
fputc('\n', outfile);
if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
--
2.56.0.353.g0856645cf6.dirty
next prev parent reply other threads:[~2026-10-02 8:09 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-01 10:13 [PATCH 0/3] builtin/refs: introduce subcommand groups Patrick Steinhardt
2026-10-01 10:13 ` [PATCH 1/3] parse-options: fix completion format when first option is skipped Patrick Steinhardt
2026-10-01 17:38 ` Junio C Hamano
2026-10-02 7:19 ` Patrick Steinhardt
2026-10-01 10:13 ` [PATCH 2/3] parse-options: allow grouping subcommands Patrick Steinhardt
2026-10-01 17:46 ` Junio C Hamano
2026-10-02 7:19 ` Patrick Steinhardt
2026-10-01 10:13 ` [PATCH 3/3] builtin/refs: introduce subcommand groups Patrick Steinhardt
2026-10-01 17:46 ` Junio C Hamano
2026-10-02 8:09 ` [PATCH v2 0/4] " Patrick Steinhardt
2026-10-02 8:09 ` [PATCH v2 1/4] parse-options: fix completion format when first option is skipped Patrick Steinhardt
2026-10-02 8:09 ` Patrick Steinhardt [this message]
2026-10-02 8:09 ` [PATCH v2 3/4] parse-options: allow grouping subcommands Patrick Steinhardt
2026-10-02 8:09 ` [PATCH v2 4/4] builtin/refs: introduce subcommand groups Patrick Steinhardt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261002-b4-pks-parse-options-subcommand-groups-v2-2-3299bee52dea@pks.im \
--to=ps@pks.im \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox