]> git.ipfire.org Git - thirdparty/git.git/commit
usage: add show_usage_if_asked()
authorJunio C Hamano <gitster@pobox.com>
Thu, 16 Jan 2025 21:35:50 +0000 (13:35 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 17 Jan 2025 21:30:02 +0000 (13:30 -0800)
commit0148fd836a9b1954833471f61b4d2e058797af55
tree5c63baa457ab14d3e426f8162b5e0d1dccc772ed
parent1782abd7734acffb8ebc37b74e120fd4c4b9c4cc
usage: add show_usage_if_asked()

Some commands call usage() when they are asked to give the help
message with "git cmd -h", but this has the same problem as we
fixed with callers of usage_with_options() for the same purpose.

Introduce a helper function that captures the common pattern

if (argc == 2 && !strcmp(argv[1], "-h"))
usage(usage);

and replaces it with

show_usage_if_asked(argc, argv, usage);

to help correct these code paths.

Note that this helper function still exits with status 129, and
t0012 insists on it.  After converting all the mistaken callers of
usage_with_options() to call this new helper, we may want to address
it---the end user is asking us to give the help text, and we are
doing exactly as asked, so there is no reason to exit with non-zero
status.

Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
git-compat-util.h
usage.c