Skip to content

Commit 0148fd8

Browse files
committed
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 1782abd commit 0148fd8

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed

git-compat-util.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,8 @@ int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
701701
void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
702702
void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
703703

704+
void show_usage_if_asked(int ac, const char **av, const char *err);
705+
704706
#ifndef NO_OPENSSL
705707
#ifdef APPLE_COMMON_CRYPTO
706708
#include "compat/apple-common-crypto.h"

usage.c

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
#include "gettext.h"
99
#include "trace2.h"
1010

11-
static void vreportf(const char *prefix, const char *err, va_list params)
11+
static void vfreportf(FILE *f, const char *prefix, const char *err, va_list params)
1212
{
1313
char msg[4096];
1414
char *p, *pend = msg + sizeof(msg);
@@ -32,8 +32,13 @@ static void vreportf(const char *prefix, const char *err, va_list params)
3232
}
3333

3434
*(p++) = '\n'; /* we no longer need a NUL */
35-
fflush(stderr);
36-
write_in_full(2, msg, p - msg);
35+
fflush(f);
36+
write_in_full(fileno(f), msg, p - msg);
37+
}
38+
39+
static void vreportf(const char *prefix, const char *err, va_list params)
40+
{
41+
vfreportf(stderr, prefix, err, params);
3742
}
3843

3944
static NORETURN void usage_builtin(const char *err, va_list params)
@@ -173,6 +178,22 @@ void NORETURN usage(const char *err)
173178
usagef("%s", err);
174179
}
175180

181+
static void show_usage_if_asked_helper(const char *err, ...)
182+
{
183+
va_list params;
184+
185+
va_start(params, err);
186+
vfreportf(stdout, _("usage: "), err, params);
187+
va_end(params);
188+
exit(129);
189+
}
190+
191+
void show_usage_if_asked(int ac, const char **av, const char *err)
192+
{
193+
if (ac == 2 && !strcmp(av[1], "-h"))
194+
show_usage_if_asked_helper(err);
195+
}
196+
176197
void NORETURN die(const char *err, ...)
177198
{
178199
va_list params;

0 commit comments

Comments
 (0)