admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

short help: allow multi-line opthelp

Browse Source 
When "-h" triggers the short-help in a command that implements its
option parsing using the parse-options API, the option help text is
shown with a single fprintf() as a long line.  When the text is
multi-line, the second and subsequent lines are not left padded,
that breaks the alignment across options.

Borrowing the idea from the advice API where its hint strings are
shown with (localized) "hint:" prefix, let's internally split the
(localized) help text into lines, and showing the first line, pad
the remaining lines to align.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano
2023-07-18 15:54:04 -07:00
parent fb7d80edca
commit 448abbba63
3 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
parse-options.c
View File

@@ -1109,6 +1109,7 @@ static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t
for (; opts->type != OPTION_END; opts++) {
size_t pos;
int pad;
const char *cp, *np;
if (opts->type == OPTION_SUBCOMMAND)
continue;
@@ -1157,7 +1158,16 @@ static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t
(const char *)opts->value);
continue;
}
fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
for (cp = _(opts->help); *cp; cp = np) {
np = strchrnul(cp, '\n');
fprintf(outfile,
"%*s%.*s\n", pad + USAGE_GAP, "",
(int)(np - cp), cp);
if (*np)
np++;
pad = USAGE_OPTS_WIDTH;
}
}
fputc('\n', outfile);