undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fetch: centralize printing of reference updates

Browse Source 
In order to print updated references during a fetch, the two different
call sites that do this will first call `format_display()` followed by a
call to `fputs()`. This is needlessly roundabout now that we have the
`display_state` structure that encapsulates all of the printing logic
for references.

Move displaying the reference updates into `format_display()` and rename
it to `display_ref_update()` to better match its new purpose, which
finalizes the conversion to make both the formatting and printing logic
of reference updates self-contained. This will make it easier to add new
output formats and printing to a different file descriptor than stderr.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Patrick Steinhardt 2023-03-20 13:35:40 +01:00 committed by Junio C Hamano
parent c4ef5edbc9
commit d6606e02aa
1 changed files with 55 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
builtin/fetch.c
View File

@ -48,6 +48,8 @@ enum {
}; };
struct display_state { struct display_state {
struct strbuf buf;
int refcol_width; int refcol_width;
int compact_format; int compact_format;
@ -787,6 +789,8 @@ static void display_state_init(struct display_state *display_state, struct ref *
memset(display_state, 0, sizeof(*display_state)); memset(display_state, 0, sizeof(*display_state));
strbuf_init(&display_state->buf, 0);
if (raw_url) if (raw_url)
display_state->url = transport_anonymize_url(raw_url); display_state->url = transport_anonymize_url(raw_url);
else else
@ -834,14 +838,15 @@ static void display_state_init(struct display_state *display_state, struct ref *
static void display_state_release(struct display_state *display_state) static void display_state_release(struct display_state *display_state)
{ {
strbuf_release(&display_state->buf);
free(display_state->url); free(display_state->url);
} }
static void print_remote_to_local(struct display_state *display_state, static void print_remote_to_local(struct display_state *display_state,
struct strbuf *display_buffer,
const char *remote, const char *local) const char *remote, const char *local)
{ {
strbuf_addf(display_buffer, "%-*s -> %s", display_state->refcol_width, remote, local); strbuf_addf(&display_state->buf, "%-*s -> %s",
display_state->refcol_width, remote, local);
} }
static int find_and_replace(struct strbuf *haystack, static int find_and_replace(struct strbuf *haystack,
@ -871,14 +876,14 @@ static int find_and_replace(struct strbuf *haystack,
return 1; return 1;
} }
static void print_compact(struct display_state *display_state, struct strbuf *display_buffer, static void print_compact(struct display_state *display_state,
const char *remote, const char *local) const char *remote, const char *local)
{ {
struct strbuf r = STRBUF_INIT; struct strbuf r = STRBUF_INIT;
struct strbuf l = STRBUF_INIT; struct strbuf l = STRBUF_INIT;
if (!strcmp(remote, local)) { if (!strcmp(remote, local)) {
strbuf_addf(display_buffer, "%-*s -> *", display_state->refcol_width, remote); strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
return; return;
} }
@ -887,14 +892,13 @@ static void print_compact(struct display_state *display_state, struct strbuf *di
if (!find_and_replace(&r, local, "*")) if (!find_and_replace(&r, local, "*"))
find_and_replace(&l, remote, "*"); find_and_replace(&l, remote, "*");
print_remote_to_local(display_state, display_buffer, r.buf, l.buf); print_remote_to_local(display_state, r.buf, l.buf);
strbuf_release(&r); strbuf_release(&r);
strbuf_release(&l); strbuf_release(&l);
} }
static void format_display(struct display_state *display_state, static void display_ref_update(struct display_state *display_state, char code,
struct strbuf *display_buffer, char code,
const char *summary, const char *error, const char *summary, const char *error,
const char *remote, const char *local, const char *remote, const char *local,
int summary_width) int summary_width)
@ -904,29 +908,33 @@ static void format_display(struct display_state *display_state,
if (verbosity < 0) if (verbosity < 0)
return; return;
strbuf_reset(&display_state->buf);
if (!display_state->shown_url) { if (!display_state->shown_url) {
strbuf_addf(display_buffer, _("From %.*s\n"), strbuf_addf(&display_state->buf, _("From %.*s\n"),
display_state->url_len, display_state->url); display_state->url_len, display_state->url);
display_state->shown_url = 1; display_state->shown_url = 1;
} }
width = (summary_width + strlen(summary) - gettext_width(summary)); width = (summary_width + strlen(summary) - gettext_width(summary));
strbuf_addf(display_buffer, " %c %-*s ", code, width, summary); strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
if (!display_state->compact_format) if (!display_state->compact_format)
print_remote_to_local(display_state, display_buffer, remote, prettify_refname(local)); print_remote_to_local(display_state, remote, prettify_refname(local));
else else
print_compact(display_state, display_buffer, remote, prettify_refname(local)); print_compact(display_state, remote, prettify_refname(local));
if (error) if (error)
strbuf_addf(display_buffer, " (%s)", error); strbuf_addf(&display_state->buf, " (%s)", error);
strbuf_addch(display_buffer, '\n'); strbuf_addch(&display_state->buf, '\n');
fputs(display_state->buf.buf, stderr);
} }
static int update_local_ref(struct ref *ref, static int update_local_ref(struct ref *ref,
struct ref_transaction *transaction, struct ref_transaction *transaction,
struct display_state *display_state, struct display_state *display_state,
const char *remote, const struct ref *remote_ref, const char *remote, const struct ref *remote_ref,
struct strbuf *display, int summary_width) int summary_width)
{ {
struct commit *current = NULL, *updated; struct commit *current = NULL, *updated;
int fast_forward = 0; int fast_forward = 0;
@ -936,7 +944,7 @@ static int update_local_ref(struct ref *ref,
if (oideq(&ref->old_oid, &ref->new_oid)) { if (oideq(&ref->old_oid, &ref->new_oid)) {
if (verbosity > 0) if (verbosity > 0)
format_display(display_state, display, '=', _("[up to date]"), NULL, display_ref_update(display_state, '=', _("[up to date]"), NULL,
remote, ref->name, summary_width); remote, ref->name, summary_width);
return 0; return 0;
} }
@ -948,7 +956,7 @@ static int update_local_ref(struct ref *ref,
* If this is the head, and it's not okay to update * If this is the head, and it's not okay to update
* the head, and the old value of the head isn't empty... * the head, and the old value of the head isn't empty...
*/ */
format_display(display_state, display, '!', _("[rejected]"), display_ref_update(display_state, '!', _("[rejected]"),
_("can't fetch into checked-out branch"), _("can't fetch into checked-out branch"),
remote, ref->name, summary_width); remote, ref->name, summary_width);
return 1; return 1;
@ -959,12 +967,12 @@ static int update_local_ref(struct ref *ref,
if (force || ref->force) { if (force || ref->force) {
int r; int r;
r = s_update_ref("updating tag", ref, transaction, 0); r = s_update_ref("updating tag", ref, transaction, 0);
format_display(display_state, display, r ? '!' : 't', _("[tag update]"), display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
r ? _("unable to update local ref") : NULL, r ? _("unable to update local ref") : NULL,
remote, ref->name, summary_width); remote, ref->name, summary_width);
return r; return r;
} else { } else {
format_display(display_state, display, '!', _("[rejected]"), display_ref_update(display_state, '!', _("[rejected]"),
_("would clobber existing tag"), _("would clobber existing tag"),
remote, ref->name, summary_width); remote, ref->name, summary_width);
return 1; return 1;
@ -997,7 +1005,7 @@ static int update_local_ref(struct ref *ref,
} }
r = s_update_ref(msg, ref, transaction, 0); r = s_update_ref(msg, ref, transaction, 0);
format_display(display_state, display, r ? '!' : '*', what, display_ref_update(display_state, r ? '!' : '*', what,
r ? _("unable to update local ref") : NULL, r ? _("unable to update local ref") : NULL,
remote, ref->name, summary_width); remote, ref->name, summary_width);
return r; return r;
@ -1019,7 +1027,7 @@ static int update_local_ref(struct ref *ref,
strbuf_addstr(&quickref, ".."); strbuf_addstr(&quickref, "..");
strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV); strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
r = s_update_ref("fast-forward", ref, transaction, 1); r = s_update_ref("fast-forward", ref, transaction, 1);
format_display(display_state, display, r ? '!' : ' ', quickref.buf, display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
r ? _("unable to update local ref") : NULL, r ? _("unable to update local ref") : NULL,
remote, ref->name, summary_width); remote, ref->name, summary_width);
strbuf_release(&quickref); strbuf_release(&quickref);
@ -1031,13 +1039,13 @@ static int update_local_ref(struct ref *ref,
strbuf_addstr(&quickref, "..."); strbuf_addstr(&quickref, "...");
strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV); strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
r = s_update_ref("forced-update", ref, transaction, 1); r = s_update_ref("forced-update", ref, transaction, 1);
format_display(display_state, display, r ? '!' : '+', quickref.buf, display_ref_update(display_state, r ? '!' : '+', quickref.buf,
r ? _("unable to update local ref") : _("forced update"), r ? _("unable to update local ref") : _("forced update"),
remote, ref->name, summary_width); remote, ref->name, summary_width);
strbuf_release(&quickref); strbuf_release(&quickref);
return r; return r;
} else { } else {
format_display(display_state, display, '!', _("[rejected]"), _("non-fast-forward"), display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
remote, ref->name, summary_width); remote, ref->name, summary_width);
return 1; return 1;
} }
@ -1266,10 +1274,9 @@ static int store_updated_refs(struct display_state *display_state,
note.buf, display_state->url, note.buf, display_state->url,
display_state->url_len); display_state->url_len);
strbuf_reset(&note);
if (ref) { if (ref) {
rc |= update_local_ref(ref, transaction, display_state, what, rc |= update_local_ref(ref, transaction, display_state, what,
rm, &note, summary_width); rm, summary_width);
free(ref); free(ref);
} else if (write_fetch_head || dry_run) { } else if (write_fetch_head || dry_run) {
/* /*
@ -1277,13 +1284,11 @@ static int store_updated_refs(struct display_state *display_state,
* would be written to FETCH_HEAD, if --dry-run * would be written to FETCH_HEAD, if --dry-run
* is set). * is set).
*/ */
format_display(display_state, &note, '*', display_ref_update(display_state, '*',
*kind ? kind : "branch", NULL, *kind ? kind : "branch", NULL,
*what ? what : "HEAD", *what ? what : "HEAD",
"FETCH_HEAD", summary_width); "FETCH_HEAD", summary_width);
} }
if (note.len)
fputs(note.buf, stderr);
} }
} }
@ -1419,12 +1424,9 @@ static int prune_refs(struct display_state *display_state,
int summary_width = transport_summary_width(stale_refs); int summary_width = transport_summary_width(stale_refs);
for (ref = stale_refs; ref; ref = ref->next) { for (ref = stale_refs; ref; ref = ref->next) {
struct strbuf sb = STRBUF_INIT; display_ref_update(display_state, '-', _("[deleted]"), NULL,
format_display(display_state, &sb, '-', _("[deleted]"), NULL,
_("(none)"), ref->name, _("(none)"), ref->name,
summary_width); summary_width);
fputs(sb.buf, stderr);
strbuf_release(&sb);
warn_dangling_symref(stderr, dangling_msg, ref->name); warn_dangling_symref(stderr, dangling_msg, ref->name);
} }
} }