git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v5 5/5] fetch: reduce duplicate in ref update status lines with placeholder

From
Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Date
Jul 1, 2016, 16:03 UTC
Message-ID
<20160701160331.29252-6-pclouds@gmail.com>
In-Reply-To
<20160701160331.29252-1-pclouds@gmail.com>

In the "remote -> local" line, if either ref is a substring of the other, the common part in the other string is replaced with "*". For example

    abc                -> origin/abc
    refs/pull/123/head -> pull/123
become
    abc         -> origin/*
    refs/*/head -> pull/123
Activated with fetch.output=compact.

For the record, this output is not perfect. A single giant ref can push all refs very far to the right and likely be wrapped around. We may have a few options:

 - exclude these long lines smarter
 - break the line after "->", exclude it from column width calculation
 - implement a new format, { -> origin/}foo, which makes the problem
   go away at the cost of a bit harder to read
 - reverse all the arrows so we have "* <- looong-ref", again still
   hard to read.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 Documentation/config.txt    |  5 +++
 Documentation/git-fetch.txt |  5 +++
 builtin/fetch.c             | 77 ++++++++++++++++++++++++++++++++++++++++++++-
 t/t5510-fetch.sh            | 17 +++++++++-
 4 files changed, 102 insertions(+), 2 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 2e1b2e4..7f6e58d 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1220,6 +1220,11 @@ fetch.prune::
 	If true, fetch will automatically behave as if the `--prune`
 	option was given on the command line.  See also `remote.<name>.prune`.
 
+fetch.output::
+	Control how ref update status is printed. Valid values are
+	`full` and `compact`. Default value is `full`. See section
+	OUTPUT in linkgit:git-fetch[1] for detail.
+
 format.attach::
 	Enable multipart/mixed attachments as the default for
 	'format-patch'.  The value can also be a double quoted string
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index 771dde5..9e42169 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -116,6 +116,11 @@ representing the status of a single ref. Each line is of the form:
 The status of up-to-date refs is shown only if the --verbose option is
 used.
 
+In compact output mode, specified with configuration variable
+fetch.output, if either entire `<from>` or `<to>` is found in the
+other string, it will be substituted with `*` in the other string. For
+example, `master -> origin/master` becomes `master -> origin/*`.
+
 flag::
 	A single character indicating the status of the ref:
 (space);; for a successfully fetched fast-forward;
diff --git a/builtin/fetch.c b/builtin/fetch.c
index 2bc609b..0a2eed1 100644
--- a/builtin/fetch.c
+++ b/builtin/fetch.c
@@ -451,6 +451,7 @@ fail:
 }
 
 static int refcol_width = 10;
+static int compact_format;
 
 static void adjust_refcol_width(const struct ref *ref)
 {
@@ -462,6 +463,7 @@ static void adjust_refcol_width(const struct ref *ref)
 
 	max    = term_columns();
 	rlen   = utf8_strwidth(prettify_refname(ref->name));
+
 	llen   = utf8_strwidth(prettify_refname(ref->peer_ref->name));
 
 	/*
@@ -470,10 +472,19 @@ static void adjust_refcol_width(const struct ref *ref)
 	 * anyway because we don't know if the error explanation part
 	 * will be printed in update_local_ref)
 	 */
+	if (compact_format) {
+		llen = 0;
+		max = max * 2 / 3;
+	}
 	len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
 	if (len >= max)
 		return;
 
+	/*
+	 * Not precise calculation for compact mode because '*' can
+	 * appear on the left hand side of '->' and shrink the column
+	 * back.
+	 */
 	if (refcol_width < rlen)
 		refcol_width = rlen;
 }
@@ -481,6 +492,16 @@ static void adjust_refcol_width(const struct ref *ref)
 static void prepare_format_display(struct ref *ref_map)
 {
 	struct ref *rm;
+	const char *format = "full";
+
+	git_config_get_string_const("fetch.output", &format);
+	if (!strcasecmp(format, "full"))
+		compact_format = 0;
+	else if (!strcasecmp(format, "compact"))
+		compact_format = 1;
+	else
+		die(_("configuration fetch.output contains invalid value %s"),
+		    format);
 
 	for (rm = ref_map; rm; rm = rm->next) {
 		if (rm->status == REF_STATUS_REJECT_SHALLOW ||
@@ -492,12 +513,66 @@ static void prepare_format_display(struct ref *ref_map)
 	}
 }
 
+static void print_remote_to_local(struct strbuf *display,
+				  const char *remote, const char *local)
+{
+	strbuf_addf(display, "%-*s -> %s", refcol_width, remote, local);
+}
+
+static int find_and_replace(struct strbuf *haystack,
+			    const char *needle,
+			    const char *placeholder)
+{
+	const char *p = strstr(haystack->buf, needle);
+	int plen, nlen;
+
+	if (!p)
+		return 0;
+
+	if (p > haystack->buf && p[-1] != '/')
+		return 0;
+
+	plen = strlen(p);
+	nlen = strlen(needle);
+	if (plen > nlen && p[nlen] != '/')
+		return 0;
+
+	strbuf_splice(haystack, p - haystack->buf, nlen,
+		      placeholder, strlen(placeholder));
+	return 1;
+}
+
+static void print_compact(struct strbuf *display,
+			  const char *remote, const char *local)
+{
+	struct strbuf r = STRBUF_INIT;
+	struct strbuf l = STRBUF_INIT;
+
+	if (!strcmp(remote, local)) {
+		strbuf_addf(display, "%-*s -> *", refcol_width, remote);
+		return;
+	}
+
+	strbuf_addstr(&r, remote);
+	strbuf_addstr(&l, local);
+
+	if (!find_and_replace(&r, local, "*"))
+		find_and_replace(&l, remote, "*");
+	print_remote_to_local(display, r.buf, l.buf);
+
+	strbuf_release(&r);
+	strbuf_release(&l);
+}
+
 static void format_display(struct strbuf *display, char code,
 			   const char *summary, const char *error,
 			   const char *remote, const char *local)
 {
 	strbuf_addf(display, "%c %-*s ", code, TRANSPORT_SUMMARY(summary));
-	strbuf_addf(display, "%-*s -> %s", refcol_width, remote, local);
+	if (!compact_format)
+		print_remote_to_local(display, remote, local);
+	else
+		print_compact(display, remote, local);
 	if (error)
 		strbuf_addf(display, "  (%s)", error);
 }
diff --git a/t/t5510-fetch.sh b/t/t5510-fetch.sh
index f50497e..6032776 100755
--- a/t/t5510-fetch.sh
+++ b/t/t5510-fetch.sh
@@ -693,7 +693,7 @@ test_expect_success 'fetch aligned output' '
 	test_commit looooooooooooong-tag &&
 	(
 		cd full-output &&
-		git fetch origin 2>&1 | \
+		git -c fetch.output=full fetch origin 2>&1 | \
 			grep -e "->" | cut -c 22- >../actual
 	) &&
 	cat >expect <<-\EOF &&
@@ -703,4 +703,19 @@ test_expect_success 'fetch aligned output' '
 	test_cmp expect actual
 '
 
+test_expect_success 'fetch compact output' '
+	git clone . compact &&
+	test_commit extraaa &&
+	(
+		cd compact &&
+		git -c fetch.output=compact fetch origin 2>&1 | \
+			grep -e "->" | cut -c 22- >../actual
+	) &&
+	cat >expect <<-\EOF &&
+	master     -> origin/*
+	extraaa    -> *
+	EOF
+	test_cmp expect actual
+'
+
 test_done

-- 
2.8.2.531.gd073806
Previous: Nguyễn Thái Ngọc DuyNext: Nguyễn Thái Ngọc Duy
Message 65 of 71 in “Better ref summary alignment in "git fetch"”
  1. 0/2 Better ref summary alignment in "git fetch"Nguyễn Thái Ngọc Duy, May 22, 2016
  2. 1/2 fetch: better alignment in ref summaryNguyễn Thái Ngọc Duy, May 22, 2016
  3. Junio C HamanoMay 23, 2016
  4. Duy NguyenMay 23, 2016
  5. Marc BranchaudMay 26, 2016
  6. Jeff KingMay 26, 2016
  7. Junio C HamanoMay 26, 2016
  8. Marc BranchaudMay 26, 2016
  9. Junio C HamanoMay 26, 2016
  10. Marc BranchaudMay 26, 2016
  11. Jeff KingMay 26, 2016
  12. Duy NguyenJun 2, 2016
  13. Junio C HamanoJun 2, 2016
  14. 2/2 fetch: reduce ref column size when there are enough short ref namesNguyễn Thái Ngọc Duy, May 22, 2016
  15. 0/3 Better ref summary alignment in "git fetch"Nguyễn Thái Ngọc Duy, Jun 3, 2016
  16. 1/3 git-fetch.txt: document fetch outputNguyễn Thái Ngọc Duy, Jun 3, 2016
  17. Marc BranchaudJun 3, 2016
  18. Jeff KingJun 3, 2016
  19. 2/3 fetch: refactor ref update status formatting codeNguyễn Thái Ngọc Duy, Jun 3, 2016
  20. Junio C HamanoJun 3, 2016
  21. 3/3 fetch: reduce duplicate in ref update status linesNguyễn Thái Ngọc Duy, Jun 3, 2016
  22. Marc BranchaudJun 3, 2016
  23. Junio C HamanoJun 3, 2016
  24. Marc BranchaudJun 3, 2016
  25. Junio C HamanoJun 3, 2016
  26. Duy NguyenJun 4, 2016
  27. Duy NguyenJun 4, 2016
  28. Junio C HamanoJun 4, 2016
  29. Duy NguyenJun 5, 2016
  30. Junio C HamanoJun 3, 2016
  31. Duy NguyenJun 3, 2016
  32. Jeff KingJun 3, 2016
  33. Duy NguyenJun 3, 2016
  34. Junio C HamanoJun 4, 2016
  35. Jeff KingJun 3, 2016
  36. Junio C HamanoJun 3, 2016
  37. 0/6 Better ref summary alignment in "git fetch"Nguyễn Thái Ngọc Duy, Jun 5, 2016
  38. 1/6 git-fetch.txt: document fetch outputNguyễn Thái Ngọc Duy, Jun 5, 2016
  39. Marc BranchaudJun 6, 2016
  40. 2/6 fetch: refactor ref update status formatting codeNguyễn Thái Ngọc Duy, Jun 5, 2016
  41. 3/6 fetch: change flag code for displaying tag update and deleted refNguyễn Thái Ngọc Duy, Jun 5, 2016
  42. 4/6 fetch: align all "remote -> local" outputNguyễn Thái Ngọc Duy, Jun 5, 2016
  43. 5/6 fetch: reduce duplicate in ref update status lines with { -> }Nguyễn Thái Ngọc Duy, Jun 5, 2016
  44. 6/6 fetch: reduce duplicate in ref update status lines with placeholderNguyễn Thái Ngọc Duy, Jun 5, 2016
  45. 0/5 Better ref summary alignment in "git fetch"Nguyễn Thái Ngọc Duy, Jun 26, 2016
  46. 1/5 git-fetch.txt: document fetch outputNguyễn Thái Ngọc Duy, Jun 26, 2016
  47. Jakub NarębskiJul 4, 2016
  48. Duy NguyenJul 4, 2016
  49. Jakub NarębskiJul 4, 2016
  50. Duy NguyenJul 4, 2016
  51. 2/5 fetch: refactor ref update status formatting codeNguyễn Thái Ngọc Duy, Jun 26, 2016
  52. 3/5 fetch: change flag code for displaying tag update and deleted refNguyễn Thái Ngọc Duy, Jun 26, 2016
  53. 4/5 fetch: align all "remote -> local" outputNguyễn Thái Ngọc Duy, Jun 26, 2016
  54. 5/5 fetch: reduce duplicate in ref update status lines with placeholderNguyễn Thái Ngọc Duy, Jun 26, 2016
  55. Eric SunshineJun 27, 2016
  56. Duy NguyenJun 27, 2016
  57. Junio C HamanoJun 27, 2016
  58. Jeff KingJun 27, 2016
  59. Duy NguyenJun 27, 2016
  60. Duy NguyenJun 30, 2016
  61. Jeff KingJul 1, 2016
  62. 0/5 Better ref summary alignment in "git fetch"Nguyễn Thái Ngọc Duy, Jul 1, 2016
  63. 1/5 git-fetch.txt: document fetch outputNguyễn Thái Ngọc Duy, Jul 1, 2016
  64. 2/5 fetch: refactor ref update status formatting codeNguyễn Thái Ngọc Duy, Jul 1, 2016
  65. 5/5 fetch: reduce duplicate in ref update status lines with placeholderNguyễn Thái Ngọc Duy, Jul 1, 2016
  66. 3/5 fetch: change flag code for displaying tag update and deleted refNguyễn Thái Ngọc Duy, Jul 1, 2016
  67. 4/5 fetch: align all "remote -> local" outputNguyễn Thái Ngọc Duy, Jul 1, 2016
  68. Junio C HamanoJul 1, 2016
  69. Duy NguyenJul 2, 2016
  70. Marc BranchaudJul 4, 2016
  71. Duy NguyenJul 4, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.