diff mbox series

PATCH] parse-options: allow omitting option help text

Message ID 2b08dc43-621d-2170-c4a6-c2aac33a9a19@web.de (mailing list archive)
State New, archived
Headers show
Series PATCH] parse-options: allow omitting option help text | expand

Commit Message

René Scharfe Aug. 26, 2023, 8:06 a.m. UTC
1b68387e02 (builtin/receive-pack.c: use parse_options API, 2016-03-02)
added the options --stateless-rpc, --advertise-refs and
--reject-thin-pack-for-testing with a NULL `help` string; 03831ef7b5
(difftool: implement the functionality in the builtin, 2017-01-19)
similarly added the "helpless" option --prompt.  Presumably this was
done because all four options are hidden and self-explanatory.

They cause a NULL pointer dereference when using the option --help-all
with their respective tool, though.  Handle such options gracefully
instead by turning the NULL pointer into an empty string at the top of
the loop, always printing a newline at the end and passing through the
separating newlines from the help text.

Signed-off-by: René Scharfe <l.s.r@web.de>
---
 parse-options.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

--
2.42.0

Comments

Junio C Hamano Aug. 28, 2023, 3:19 p.m. UTC | #1
René Scharfe <l.s.r@web.de> writes:

> 1b68387e02 (builtin/receive-pack.c: use parse_options API, 2016-03-02)
> added the options --stateless-rpc, --advertise-refs and
> --reject-thin-pack-for-testing with a NULL `help` string; 03831ef7b5
> (difftool: implement the functionality in the builtin, 2017-01-19)
> similarly added the "helpless" option --prompt.  Presumably this was
> done because all four options are hidden and self-explanatory.
>
> They cause a NULL pointer dereference when using the option --help-all
> with their respective tool, though.

Good find.  Will apply.  Thanks.
diff mbox series

Patch

diff --git a/parse-options.c b/parse-options.c
index 76d2e76b49..e8e076c3a6 100644
--- a/parse-options.c
+++ b/parse-options.c
@@ -1186,14 +1186,15 @@  static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t
 			continue;
 		}

-		for (cp = _(opts->help); *cp; cp = np) {
+		for (cp = opts->help ? _(opts->help) : ""; *cp; cp = np) {
 			np = strchrnul(cp, '\n');
-			usage_padding(outfile, pos);
-			fprintf(outfile, "%.*s\n", (int)(np - cp), cp);
 			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))