Introduce usagef() that takes a printf-style format
Some new callers would want to use printf-like formatting, when issuing their usage messages. An option is to change usage() itself also be like printf(), which would make it similar to die() and warn(). But usage() is typically fixed, as opposed to die() and warn() that gives diagnostics depending on the situation. Indeed, the majority of strings given by existing callsites to usage() are fixed strings. If we were to make usage() take printf-style format, they all need to be changed to have "%s" as their first argument. So instead, introduce usagef() so that limited number of callers can use it. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
Nov 9, 2009 at 09:05 UTC
64b1cb74f8312c0a43ce32f51097172efc69355a
2 files changed
+14
-4
git-compat-util.h
+1
@@ -189,6 +189,7 @@ extern char *gitbasename(char *);
189
190
/* General helper functions */
191
extern NORETURN void usage(const char *err);
192
+extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
193
extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
194
extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
195
extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
usage.c
+13
-4
@@ -12,9 +12,9 @@ static void report(const char *prefix, const char *err, va_list params)
12
fprintf(stderr, "%s%s\n", prefix, msg);
13
}
14
15
-static NORETURN void usage_builtin(const char *err)
15
+static NORETURN void usage_builtin(const char *err, va_list params)
16
{
17
- fprintf(stderr, "usage: %s\n", err);
17
+ report("usage: ", err, params);
18
exit(129);
19
}
20
@@ -36,7 +36,7 @@ static void warn_builtin(const char *warn, va_list params)
36
37
/* If we are in a dlopen()ed .so write to a global variable would segfault
38
* (ugh), so keep things static. */
39
-static NORETURN_PTR void (*usage_routine)(const char *err) = usage_builtin;
39
+static NORETURN_PTR void (*usage_routine)(const char *err, va_list params) = usage_builtin;
40
static NORETURN_PTR void (*die_routine)(const char *err, va_list params) = die_builtin;
41
static void (*error_routine)(const char *err, va_list params) = error_builtin;
42
static void (*warn_routine)(const char *err, va_list params) = warn_builtin;
@@ -46,9 +46,18 @@ void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list param
46
die_routine = routine;
47
}
48
49
+void usagef(const char *err, ...)
50
+{
51
+ va_list params;
52
+
53
+ va_start(params, err);
54
+ usage_routine(err, params);
55
+ va_end(params);
56
+}
57
+
58
void usage(const char *err)
59
{
51
- usage_routine(err);
60
+ usagef("%s", err);
61
}
62
63
void die(const char *err, ...)