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

[PATCH v4 4/4] cat-file: add mailmap support

From
Siddharth Asthana <siddharthasthana31@gmail.com>
Date
Jul 12, 2022, 16:06 UTC
Message-ID
<20220712160634.213956-5-siddharthasthana31@gmail.com>
In-Reply-To
<20220712160634.213956-1-siddharthasthana31@gmail.com>

git-cat-file is used by tools like GitLab to get commit tag contents that are then displayed to users. This content which has author, committer or tagger information, could benefit from passing through the mailmap mechanism before being sent or displayed.

This patch adds --[no-]use-mailmap command line option to the git cat-file command. It also adds --[no-]mailmap option as an alias to --[no-]use-mailmap.

This patch also introduces new test cases to test the mailmap mechanism in git cat-file command.

The tests added in this patch series rely on the side effects of the earlier test case `set up symlink tests`. However, that test case is guarded behind the `SYMLINKS` prereq, therefore it is not run e.g. on Windows which can cause the added tests to fail on Windows. So, fix that by removing the prereq from the `set up` test case, and adjusting its title to reflect its broadened responsibility.

Mentored-by: Christian Couder <christian.couder@gmail.com>
Mentored-by: John Cai <johncai86@gmail.com>
Helped-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Helped-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Signed-off-by: Siddharth Asthana <siddharthasthana31@gmail.com>
---
 Documentation/git-cat-file.txt |  6 ++++
 builtin/cat-file.c             | 43 +++++++++++++++++++++++++-
 t/t4203-mailmap.sh             | 56 +++++++++++++++++++++++++++++++++-
 3 files changed, 103 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index 24a811f0ef..1880e9bba1 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -63,6 +63,12 @@ OPTIONS
 	or to ask for a "blob" with `<object>` being a tag object that
 	points at it.
 
+--[no-]mailmap::
+--[no-]use-mailmap::
+       Use mailmap file to map author, committer and tagger names
+       and email addresses to canonical real names and email addresses.
+       See linkgit:git-shortlog[1].
+
 --textconv::
 	Show the content as transformed by a textconv filter. In this case,
 	`<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in
diff --git a/builtin/cat-file.c b/builtin/cat-file.c
index 50cf38999d..4b68216b51 100644
--- a/builtin/cat-file.c
+++ b/builtin/cat-file.c
@@ -16,6 +16,7 @@
 #include "packfile.h"
 #include "object-store.h"
 #include "promisor-remote.h"
+#include "mailmap.h"
 
 enum batch_mode {
 	BATCH_MODE_CONTENTS,
@@ -36,6 +37,22 @@ struct batch_options {
 
 static const char *force_path;
 
+static struct string_list mailmap = STRING_LIST_INIT_NODUP;
+static int use_mailmap;
+
+static char *replace_idents_using_mailmap(char *, size_t *);
+
+static char *replace_idents_using_mailmap(char *object_buf, size_t *size)
+{
+	struct strbuf sb = STRBUF_INIT;
+	const char *headers[] = { "author ", "committer ", "tagger ", NULL };
+
+	strbuf_attach(&sb, object_buf, *size, *size + 1);
+	apply_mailmap_to_header(&sb, headers, &mailmap);
+	*size = sb.len;
+	return strbuf_detach(&sb, NULL);
+}
+
 static int filter_object(const char *path, unsigned mode,
 			 const struct object_id *oid,
 			 char **buf, unsigned long *size)
@@ -152,6 +169,12 @@ static int cat_one_file(int opt, const char *exp_type, const char *obj_name,
 		if (!buf)
 			die("Cannot read object %s", obj_name);
 
+		if (use_mailmap) {
+			size_t s = size;
+			buf = replace_idents_using_mailmap(buf, &s);
+			size = cast_size_t_to_ulong(s);
+		}
+
 		/* otherwise just spit out the data */
 		break;
 
@@ -183,6 +206,12 @@ static int cat_one_file(int opt, const char *exp_type, const char *obj_name,
 		}
 		buf = read_object_with_reference(the_repository, &oid,
 						 exp_type_id, &size, NULL);
+
+		if (use_mailmap) {
+			size_t s = size;
+			buf = replace_idents_using_mailmap(buf, &s);
+			size = cast_size_t_to_ulong(s);
+		}
 		break;
 	}
 	default:
@@ -348,11 +377,18 @@ static void print_object_or_die(struct batch_options *opt, struct expand_data *d
 		void *contents;
 
 		contents = read_object_file(oid, &type, &size);
+
+		if (use_mailmap) {
+			size_t s = size;
+			contents = replace_idents_using_mailmap(contents, &s);
+			size = cast_size_t_to_ulong(s);
+		}
+
 		if (!contents)
 			die("object %s disappeared", oid_to_hex(oid));
 		if (type != data->type)
 			die("object %s changed type!?", oid_to_hex(oid));
-		if (data->info.sizep && size != data->size)
+		if (data->info.sizep && size != data->size && !use_mailmap)
 			die("object %s changed size!?", oid_to_hex(oid));
 
 		batch_write(opt, contents, size);
@@ -843,6 +879,8 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix)
 		OPT_CMDMODE('s', NULL, &opt, N_("show object size"), 's'),
 		OPT_BOOL(0, "allow-unknown-type", &unknown_type,
 			  N_("allow -s and -t to work with broken/corrupt objects")),
+		OPT_BOOL(0, "use-mailmap", &use_mailmap, N_("use mail map file")),
+		OPT_ALIAS(0, "mailmap", "use-mailmap"),
 		/* Batch mode */
 		OPT_GROUP(N_("Batch objects requested on stdin (or --batch-all-objects)")),
 		OPT_CALLBACK_F(0, "batch", &batch, N_("format"),
@@ -885,6 +923,9 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix)
 	opt_cw = (opt == 'c' || opt == 'w');
 	opt_epts = (opt == 'e' || opt == 'p' || opt == 't' || opt == 's');
 
+	if (use_mailmap)
+		read_mailmap(&mailmap);
+
 	/* --batch-all-objects? */
 	if (opt == 'b')
 		batch.all_objects = 1;
diff --git a/t/t4203-mailmap.sh b/t/t4203-mailmap.sh
index 0b2d21ec55..dba0a8ac56 100755
--- a/t/t4203-mailmap.sh
+++ b/t/t4203-mailmap.sh
@@ -932,7 +932,7 @@ test_expect_success 'find top-level mailmap from subdir' '
 	test_cmp expect actual
 '
 
-test_expect_success SYMLINKS 'set up symlink tests' '
+test_expect_success 'prepare for symlink/--use-mailmap tests' '
 	git commit --allow-empty -m foo --author="Orig <orig@example.com>" &&
 	echo "New <new@example.com> <orig@example.com>" >map &&
 	rm -f .mailmap
@@ -963,4 +963,58 @@ test_expect_success SYMLINKS 'symlinks not respected in-tree' '
 	test_cmp expect actual
 '
 
+test_expect_success '--no-use-mailmap disables mailmap in cat-file' '
+	test_when_finished "rm .mailmap" &&
+	cat >.mailmap <<-EOF &&
+	A U Thor <author@example.com> Orig <orig@example.com>
+	EOF
+	cat >expect <<-EOF &&
+	author Orig <orig@example.com>
+	EOF
+	git cat-file --no-use-mailmap commit HEAD >log &&
+	sed -n "/^author /s/\([^>]*>\).*/\1/p" log >actual &&
+	test_cmp expect actual
+'
+
+test_expect_success '--use-mailmap enables mailmap in cat-file' '
+	test_when_finished "rm .mailmap" &&
+	cat >.mailmap <<-EOF &&
+	A U Thor <author@example.com> Orig <orig@example.com>
+	EOF
+	cat >expect <<-EOF &&
+	author A U Thor <author@example.com>
+	EOF
+	git cat-file --use-mailmap commit HEAD >log &&
+	sed -n "/^author /s/\([^>]*>\).*/\1/p" log >actual &&
+	test_cmp expect actual
+'
+
+test_expect_success '--no-mailmap disables mailmap in cat-file for annotated tag objects' '
+	test_when_finished "rm .mailmap" &&
+	cat >.mailmap <<-EOF &&
+	Orig <orig@example.com> C O Mitter <committer@example.com>
+	EOF
+	cat >expect <<-EOF &&
+	tagger C O Mitter <committer@example.com>
+	EOF
+	git tag -a -m "annotated tag" v1 &&
+	git cat-file --no-mailmap -p v1 >log &&
+	sed -n "/^tagger /s/\([^>]*>\).*/\1/p" log >actual &&
+	test_cmp expect actual
+'
+
+test_expect_success '--mailmap enables mailmap in cat-file for annotated tag objects' '
+	test_when_finished "rm .mailmap" &&
+	cat >.mailmap <<-EOF &&
+	Orig <orig@example.com> C O Mitter <committer@example.com>
+	EOF
+	cat >expect <<-EOF &&
+	tagger Orig <orig@example.com>
+	EOF
+	git tag -a -m "annotated tag" v2 &&
+	git cat-file --mailmap -p v2 >log &&
+	sed -n "/^tagger /s/\([^>]*>\).*/\1/p" log >actual &&
+	test_cmp expect actual
+'
+
 test_done

-- 
2.37.0.6.g69b7ad898b
Previous: Christian CouderNext: Siddharth Asthana
Message 51 of 68 in “Add support for mailmap in cat-file”
  1. 0/3 Add support for mailmap in cat-fileSiddharth Asthana, Jun 30, 2022
  2. 2/3 ident: rename commit_rewrite_person() to rewrite_ident_line()Siddharth Asthana, Jun 30, 2022
  3. Phillip WoodJun 30, 2022
  4. Christian CouderJun 30, 2022
  5. Junio C HamanoJun 30, 2022
  6. 1/3 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jun 30, 2022
  7. Đoàn Trần Công DanhJun 30, 2022
  8. Junio C HamanoJun 30, 2022
  9. 3/3 cat-file: add mailmap supportSiddharth Asthana, Jun 30, 2022
  10. Phillip WoodJun 30, 2022
  11. Phillip WoodJun 30, 2022
  12. Christian CouderJun 30, 2022
  13. Junio C HamanoJun 30, 2022
  14. Christian CouderJul 7, 2022
  15. Ævar Arnfjörð BjarmasonJun 30, 2022
  16. Junio C HamanoJun 30, 2022
  17. Christian CouderJul 7, 2022
  18. Junio C HamanoJun 30, 2022
  19. Junio C HamanoJun 30, 2022
  20. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 7, 2022
  21. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 7, 2022
  22. Junio C HamanoJul 7, 2022
  23. Đoàn Trần Công DanhJul 8, 2022
  24. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 7, 2022
  25. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 7, 2022
  26. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 7, 2022
  27. Junio C HamanoJul 7, 2022
  28. Johannes SchindelinJul 8, 2022
  29. Junio C HamanoJul 7, 2022
  30. Junio C HamanoJul 7, 2022
  31. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 9, 2022
  32. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 9, 2022
  33. Johannes SchindelinJul 12, 2022
  34. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 9, 2022
  35. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 9, 2022
  36. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 9, 2022
  37. Junio C HamanoJul 10, 2022
  38. Johannes SchindelinJul 12, 2022
  39. Junio C HamanoJul 12, 2022
  40. Siddharth AsthanaJul 12, 2022
  41. Junio C HamanoJul 12, 2022
  42. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 12, 2022
  43. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 12, 2022
  44. Ævar Arnfjörð BjarmasonJul 13, 2022
  45. Christian CouderJul 13, 2022
  46. Junio C HamanoJul 14, 2022
  47. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 12, 2022
  48. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 12, 2022
  49. Ævar Arnfjörð BjarmasonJul 13, 2022
  50. Christian CouderJul 13, 2022
  51. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 12, 2022
  52. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 16, 2022
  53. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 16, 2022
  54. Junio C HamanoJul 17, 2022
  55. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 16, 2022
  56. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 16, 2022
  57. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 16, 2022
  58. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 18, 2022
  59. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 18, 2022
  60. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 18, 2022
  61. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 18, 2022
  62. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 18, 2022
  63. Junio C HamanoJul 25, 2022
  64. Christian CouderJul 28, 2022
  65. Junio C HamanoJul 28, 2022
  66. Siddharth AsthanaJul 30, 2022
  67. Đoàn Trần Công DanhJul 9, 2022
  68. Christian CouderJul 9, 2022

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.