Skip to content

Commit

Permalink
trace: refactor to support multiple env variables
Browse files Browse the repository at this point in the history
Right now you turn all tracing off and on with GIT_TRACE. To
support new types of tracing without forcing the user to see
all of them, we will soon support turning each tracing area
on with GIT_TRACE_*.

This patch lays the groundwork by providing an interface
which does not assume GIT_TRACE. However, we still maintain
the trace_printf interface so that existing callers do not
need to be refactored.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Jeff King authored and Junio C Hamano committed Mar 8, 2011
1 parent c605354 commit 0679660
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
2 changes: 1 addition & 1 deletion cache.h
Original file line number Diff line number Diff line change
Expand Up @@ -1067,7 +1067,7 @@ extern void alloc_report(void);
/* trace.c */
__attribute__((format (printf, 1, 2)))
extern void trace_printf(const char *format, ...);
extern void trace_vprintf(const char *format, va_list ap);
extern void trace_vprintf(const char *key, const char *format, va_list ap);
__attribute__((format (printf, 2, 3)))
extern void trace_argv_printf(const char **argv, const char *format, ...);
extern void trace_repo_setup(const char *prefix);
Expand Down
28 changes: 18 additions & 10 deletions trace.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@
#include "cache.h"
#include "quote.h"

/* Get a trace file descriptor from GIT_TRACE env variable. */
static int get_trace_fd(int *need_close)
/* Get a trace file descriptor from "key" env variable. */
static int get_trace_fd(const char *key, int *need_close)
{
char *trace = getenv("GIT_TRACE");
char *trace = getenv(key);

if (!trace || !strcmp(trace, "") ||
!strcmp(trace, "0") || !strcasecmp(trace, "false"))
Expand All @@ -50,10 +50,10 @@ static int get_trace_fd(int *need_close)
return fd;
}

fprintf(stderr, "What does '%s' for GIT_TRACE mean?\n", trace);
fprintf(stderr, "What does '%s' for %s mean?\n", trace, key);
fprintf(stderr, "If you want to trace into a file, "
"then please set GIT_TRACE to an absolute pathname "
"(starting with /).\n");
"then please set %s to an absolute pathname "
"(starting with /).\n", key);
fprintf(stderr, "Defaulting to tracing on stderr...\n");

return STDERR_FILENO;
Expand All @@ -62,12 +62,12 @@ static int get_trace_fd(int *need_close)
static const char err_msg[] = "Could not trace into fd given by "
"GIT_TRACE environment variable";

void trace_vprintf(const char *fmt, va_list ap)
void trace_vprintf(const char *key, const char *fmt, va_list ap)
{
struct strbuf buf = STRBUF_INIT;
int fd, need_close = 0;

fd = get_trace_fd(&need_close);
fd = get_trace_fd(key, &need_close);
if (!fd)
return;

Expand All @@ -80,11 +80,19 @@ void trace_vprintf(const char *fmt, va_list ap)
close(fd);
}

void trace_printf_key(const char *key, const char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
trace_vprintf(key, fmt, ap);
va_end(ap);
}

void trace_printf(const char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
trace_vprintf(fmt, ap);
trace_vprintf("GIT_TRACE", fmt, ap);
va_end(ap);
}

Expand All @@ -94,7 +102,7 @@ void trace_argv_printf(const char **argv, const char *fmt, ...)
va_list ap;
int fd, need_close = 0;

fd = get_trace_fd(&need_close);
fd = get_trace_fd("GIT_TRACE", &need_close);
if (!fd)
return;

Expand Down

0 comments on commit 0679660

Please sign in to comment.