[PATCH v2 0/4] Extend mailmap functionality

[PATCH v2 0/4] Extend mailmap functionality

[Marius Storm-Olsen]

  v2: changes since v1
  --------------------
  * Folded in documentation fixup from patch 4 into patch 3.


This patch series extends the mailmap functionality to:
  1) Allow the mailmap file in any location (also outside repo)
  2) Enable mailmap to match on both Name and Email

So, why would this be a good thing?

2) Lets you replace both name and email of an author/committer, based
on a name and/or email. So, should you have done commits with faulty
address, or if an old email simply isn't valid anymore, you can add
a mapping for that to replace it. So, the old style mapping is
    Proper Name <commit@email.xx>

while this patch series adds support for
    Proper Name <proper@email.xx> <commit@email.xx>
    Proper Name <proper@email.xx> Commit Name <commit@email.xx>

1) Lets you keep a private mailmap file, which is not distributed with
your repository.


This extended mapping is necessary when a company wants to have their
repositories open to the public, but needs to protect the identities
of the developers. It enables you to only show nicks and standardized
emails, like 'Dev123 <bugs@company.xx>' in the public repo, but by
using an private mailmap file, map the name back to
'John Doe <john.doe@company.xx>' inside the company.


Patch serie applies cleanly on master branch, and test run shows no
regressions.

Marius Storm-Olsen (4):
  Add log.mailmap as configurational option for mailmap location
  Add find_insert_index, insert_at_index and clear_func functions to
    string_list
  Add map_user() and clear_mailmap() to mailmap
  Change current mailmap usage to do matching on both name and email of
    author/committer.

 Documentation/config.txt         |    9 ++
 Documentation/git-shortlog.txt   |   61 +++++++++---
 Documentation/pretty-formats.txt |    2 +
 builtin-blame.c                  |   52 ++++++----
 builtin-shortlog.c               |   25 ++++-
 cache.h                          |    1 +
 config.c                         |   10 ++
 mailmap.c                        |  207 ++++++++++++++++++++++++++++++++++----
 mailmap.h                        |    4 +
 pretty.c                         |   59 ++++++-----
 string-list.c                    |   43 +++++++-
 string-list.h                    |    9 ++
 t/t4203-mailmap.sh               |  152 ++++++++++++++++++++++++++++
 13 files changed, 541 insertions(+), 93 deletions(-)
 create mode 100755 t/t4203-mailmap.sh

[PATCH v2 1/4] Add log.mailmap as configurational option for mailmap location

[Marius Storm-Olsen]

This allows us to override a repo mailmap file, or to use
mailmap files elsewhere than the repository root.

Should the log.mailmap file not be found, it falls back to ".mailmap".

Signed-off-by: Marius Storm-Olsen <marius@trolltech.com>
---
 Documentation/config.txt       |    9 +++++++
 Documentation/git-shortlog.txt |    3 +-
 builtin-blame.c                |    2 +-
 builtin-shortlog.c             |    3 +-
 cache.h                        |    1 +
 config.c                       |   10 +++++++
 mailmap.c                      |    9 ++++++-
 t/t4203-mailmap.sh             |   53 ++++++++++++++++++++++++++++++++++++++++
 8 files changed, 86 insertions(+), 4 deletions(-)
 create mode 100755 t/t4203-mailmap.sh

diff --git a/Documentation/config.txt b/Documentation/config.txt
index e2b8775..02c7b4c 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1012,6 +1012,15 @@ log.showroot::
 	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
 	normally hide the root commit will now show it. True by default.
 
+log.mailmap::
+	Overrides the default location of the mailmap file. The default
+	mailmap location is .mailmap in the root of the repository.
+	The new location of the mailmap file may be in a repository
+	subdirectory, or somewhere outside of the repository itself.
+	If git can't find the file, it will try to load the default
+	mailmap location instead.
+	See linkgit:git-shortlog[1] and linkgit:git-blame[1].
+
 man.viewer::
 	Specify the programs that may be used to display help in the
 	'man' format. See linkgit:git-help[1].
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index 8f7c0e2..cacbeea 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -48,7 +48,8 @@ OPTIONS
 FILES
 -----
 
-If a file `.mailmap` exists at the toplevel of the repository,
+If a file `.mailmap` exists at the toplevel of the repository, or at the
+location pointed to by the log.mailmap configuration option,
 it is used to map an author email address to a canonical real name. This
 can be used to coalesce together commits by the same person where their
 name was spelled differently (whether with the same email address or
diff --git a/builtin-blame.c b/builtin-blame.c
index aae14ef..4b63775 100644
--- a/builtin-blame.c
+++ b/builtin-blame.c
@@ -2394,7 +2394,7 @@ parse_done:
 		die("reading graft file %s failed: %s",
 		    revs_file, strerror(errno));
 
-	read_mailmap(&mailmap, ".mailmap", NULL);
+	read_mailmap(&mailmap, NULL, NULL);
 
 	if (!incremental)
 		setup_pager();
diff --git a/builtin-shortlog.c b/builtin-shortlog.c
index 5f9f3f0..04832a8 100644
--- a/builtin-shortlog.c
+++ b/builtin-shortlog.c
@@ -219,7 +219,7 @@ void shortlog_init(struct shortlog *log)
 {
 	memset(log, 0, sizeof(*log));
 
-	read_mailmap(&log->mailmap, ".mailmap", &log->common_repo_prefix);
+	read_mailmap(&log->mailmap, NULL, &log->common_repo_prefix);
 
 	log->list.strdup_strings = 1;
 	log->wrap = DEFAULT_WRAPLEN;
@@ -248,6 +248,7 @@ int cmd_shortlog(int argc, const char **argv, const char *prefix)
 	struct parse_opt_ctx_t ctx;
 
 	prefix = setup_git_directory_gently(&nongit);
+	git_config(git_default_config, NULL);
 	shortlog_init(&log);
 	init_revisions(&rev, prefix);
 	parse_options_start(&ctx, argc, argv, PARSE_OPT_KEEP_DASHDASH |
diff --git a/cache.h b/cache.h
index 45e713e..3eef7ea 100644
--- a/cache.h
+++ b/cache.h
@@ -867,6 +867,7 @@ extern int user_ident_explicitly_given;
 
 extern const char *git_commit_encoding;
 extern const char *git_log_output_encoding;
+extern const char *git_log_mailmap;
 
 /* IO helper functions */
 extern void maybe_flush_or_die(FILE *, const char *);
diff --git a/config.c b/config.c
index 790405a..9ebcbbe 100644
--- a/config.c
+++ b/config.c
@@ -565,6 +565,13 @@ static int git_default_branch_config(const char *var, const char *value)
 	return 0;
 }
 
+static int git_default_log_config(const char *var, const char *value)
+{
+	if (!strcmp(var, "log.mailmap"))
+		return git_config_string(&git_log_mailmap, var, value);
+	return 0;
+}
+
 int git_default_config(const char *var, const char *value, void *dummy)
 {
 	if (!prefixcmp(var, "core."))
@@ -579,6 +586,9 @@ int git_default_config(const char *var, const char *value, void *dummy)
 	if (!prefixcmp(var, "branch."))
 		return git_default_branch_config(var, value);
 
+	if (!prefixcmp(var, "log."))
+		return git_default_log_config(var, value);
+
 	if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
 		pager_use_color = git_config_bool(var,value);
 		return 0;
diff --git a/mailmap.c b/mailmap.c
index 88fc6f3..32eab6c 100644
--- a/mailmap.c
+++ b/mailmap.c
@@ -2,11 +2,18 @@
 #include "string-list.h"
 #include "mailmap.h"
 
+const char *git_log_mailmap;
 int read_mailmap(struct string_list *map, const char *filename, char **repo_abbrev)
 {
 	char buffer[1024];
-	FILE *f = fopen(filename, "r");
+	FILE *f = NULL;
 
+	if (filename)
+		f = fopen(filename, "r");
+	if (f == NULL && git_log_mailmap)
+		f = fopen(git_log_mailmap, "r");
+	if (f == NULL)
+		f = fopen(".mailmap", "r");
 	if (f == NULL)
 		return 1;
 	while (fgets(buffer, sizeof(buffer), f) != NULL) {
diff --git a/t/t4203-mailmap.sh b/t/t4203-mailmap.sh
new file mode 100755
index 0000000..57fd88e
--- /dev/null
+++ b/t/t4203-mailmap.sh
@@ -0,0 +1,53 @@
+#!/bin/sh
+
+test_description='.mailmap configurations'
+
+. ./test-lib.sh
+
+test_expect_success setup '
+	echo one >one &&
+	git add one &&
+	test_tick &&
+	git commit -m initial
+'
+
+test_expect_success 'No mailmap' '
+	git shortlog >actual &&
+	echo "A U Thor (1):" >expect; echo "      initial" >>expect; echo >>expect &&
+	test_cmp expect actual
+'
+
+test_expect_success 'default .mailmap' '
+	echo "Repo Guy <author@example.com>" > .mailmap &&
+	git shortlog >actual &&
+	echo "Repo Guy (1):" >expect; echo "      initial" >>expect; echo >>expect &&
+	test_cmp expect actual
+'
+
+# Using a mailmap file in a subdirectory of the repo here, but
+# could just as well have been a file outside of the repository
+test_expect_success 'log.mailmap set' '
+	mkdir internal_mailmap &&
+	echo "Internal Guy <author@example.com>" > internal_mailmap/.mailmap &&
+	git config log.mailmap internal_mailmap/.mailmap &&
+	git shortlog >actual &&
+	echo "Internal Guy (1):" >expect; echo "      initial" >>expect; echo >>expect &&
+	test_cmp expect actual
+'
+
+test_expect_success 'log.mailmap file non-existant' '
+	rm internal_mailmap/.mailmap &&
+	rmdir internal_mailmap &&
+	git shortlog >actual &&
+	echo "Repo Guy (1):" >expect; echo "      initial" >>expect; echo >>expect &&
+	test_cmp expect actual
+'
+
+test_expect_success 'No mailmap files, but configured' '
+	rm .mailmap &&
+	git shortlog >actual &&
+	echo "A U Thor (1):" >expect; echo "      initial" >>expect; echo >>expect &&
+	test_cmp expect actual
+'
+
+test_done
-- 
1.6.1.2.257.g34f62

[PATCH v2 2/4] Add find_insert_index, insert_at_index and clear_func functions to string_list

[Marius Storm-Olsen]

string_list_find_insert_index() and string_list_insert_at_index() enables you to see if an item is in the string_list, and to insert at the appropriate index in the list, if not there.
This is usefull if you need to manipulate an existing item, if present, and insert a new item if not.

Future mailmap code will use this construct to enable complex (old_name, old_email) -> (new_name, new_email) lookups.

The string_list_clear_func() allows to call a custom cleanup function on each item in a string_list, which is useful is the util member points to a complex structure.

Signed-off-by: Marius Storm-Olsen <marius@trolltech.com>
---
 string-list.c |   43 +++++++++++++++++++++++++++++++++++++++----
 string-list.h |    9 +++++++++
 2 files changed, 48 insertions(+), 4 deletions(-)

diff --git a/string-list.c b/string-list.c
index ddd83c8..15e14cf 100644
--- a/string-list.c
+++ b/string-list.c
@@ -26,10 +26,10 @@ static int get_entry_index(const struct string_list *list, const char *string,
 }
 
 /* returns -1-index if already exists */
-static int add_entry(struct string_list *list, const char *string)
+static int add_entry(int insert_at, struct string_list *list, const char *string)
 {
-	int exact_match;
-	int index = get_entry_index(list, string, &exact_match);
+	int exact_match = 0;
+	int index = insert_at != -1 ? insert_at : get_entry_index(list, string, &exact_match);
 
 	if (exact_match)
 		return -1 - index;
@@ -53,7 +53,13 @@ static int add_entry(struct string_list *list, const char *string)
 
 struct string_list_item *string_list_insert(const char *string, struct string_list *list)
 {
-	int index = add_entry(list, string);
+	return string_list_insert_at_index(-1, string, list);
+}
+
+struct string_list_item *string_list_insert_at_index(int insert_at,
+						     const char *string, struct string_list *list)
+{
+	int index = add_entry(insert_at, list, string);
 
 	if (index < 0)
 		index = -1 - index;
@@ -68,6 +74,16 @@ int string_list_has_string(const struct string_list *list, const char *string)
 	return exact_match;
 }
 
+int string_list_find_insert_index(const struct string_list *list, const char *string,
+				  int negative_existing_index)
+{
+	int exact_match;
+	int index = get_entry_index(list, string, &exact_match);
+	if (exact_match)
+		index = -1 - (negative_existing_index ? index : 0);
+	return index;
+}
+
 struct string_list_item *string_list_lookup(const char *string, struct string_list *list)
 {
 	int exact_match, i = get_entry_index(list, string, &exact_match);
@@ -94,6 +110,25 @@ void string_list_clear(struct string_list *list, int free_util)
 	list->nr = list->alloc = 0;
 }
 
+void string_list_clear_func(struct string_list *list, string_list_clear_func_t clearfunc)
+{
+	if (list->items) {
+		int i;
+		if (clearfunc) {
+			for (i = 0; i < list->nr; i++)
+				clearfunc(list->items[i].util, list->items[i].string);
+		}
+		if (list->strdup_strings) {
+			for (i = 0; i < list->nr; i++)
+				free(list->items[i].string);
+		}
+		free(list->items);
+	}
+	list->items = NULL;
+	list->nr = list->alloc = 0;
+}
+
+
 void print_string_list(const char *text, const struct string_list *p)
 {
 	int i;
diff --git a/string-list.h b/string-list.h
index 4d6a705..d32ba05 100644
--- a/string-list.h
+++ b/string-list.h
@@ -15,9 +15,18 @@ struct string_list
 void print_string_list(const char *text, const struct string_list *p);
 void string_list_clear(struct string_list *list, int free_util);
 
+/* Use this function to call a custom clear function on each util pointer */
+/* The string associated with the util pointer is passed as the second argument */
+typedef void (*string_list_clear_func_t)(void *p, const char *str);
+void string_list_clear_func(struct string_list *list, string_list_clear_func_t clearfunc);
+
 /* Use these functions only on sorted lists: */
 int string_list_has_string(const struct string_list *list, const char *string);
+int string_list_find_insert_index(const struct string_list *list, const char *string,
+				  int negative_existing_index);
 struct string_list_item *string_list_insert(const char *string, struct string_list *list);
+struct string_list_item *string_list_insert_at_index(int insert_at,
+						     const char *string, struct string_list *list);
 struct string_list_item *string_list_lookup(const char *string, struct string_list *list);
 
 /* Use these functions only on unsorted lists: */
-- 
1.6.1.2.257.g34f62

[PATCH v2 3/4] Add map_user() and clear_mailmap() to mailmap

[Marius Storm-Olsen]

map_user() allows to lookup and replace both email and name of a user, based on a new style mailmap file.
The possible mailmap definitions now are:
  proper_name <commit_email>                             // Old style
  proper_name <proper_email> <commit_email>              // New style
  proper_name <proper_email> commit_name <commit_email>  // New style

map_email() operates the same as before, with the exception that it also will to try to match on a name passed in through the name return buffer.

clear_mailmap() is needed to now clear the more complex mailmap structure.

Signed-off-by: Marius Storm-Olsen <marius@trolltech.com>
---
 Documentation/git-shortlog.txt |   58 +++++++++---
 mailmap.c                      |  198 ++++++++++++++++++++++++++++++++++++----
 mailmap.h                      |    4 +
 3 files changed, 227 insertions(+), 33 deletions(-)

diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index cacbeea..d64dabf 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -50,20 +50,29 @@ FILES
 
 If a file `.mailmap` exists at the toplevel of the repository, or at the
 location pointed to by the log.mailmap configuration option,
-it is used to map an author email address to a canonical real name. This
-can be used to coalesce together commits by the same person where their
-name was spelled differently (whether with the same email address or
-not).
-
-Each line in the file consists, in this order, of the canonical real name
-of an author, whitespace, and an email address (enclosed by '<' and '>')
-to map to the name. Use hash '#' for comments, either on their own line,
-or after the email address.
-
-A canonical name may appear in more than one line, associated with
-different email addresses, but it doesn't make sense for a given address
-to appear more than once (if that happens, a later line overrides the
-earlier ones).
+it is used to map author and committer names and email addresses to
+canonical real names and email addresses.
+This can be used to coalesce together commits by the same person where
+their name and/or email address was spelled differently.
+
+In the simple form, each line in the file consists of the canonical real name
+of an author, whitespace, and an email address used in the commit
+(enclosed by '<' and '>') to map to the name. Thus, looks like this
+--
+	Proper Name <commit@email.xx>
+--
+
+The more complex forms are
+--
+	Proper Name <proper@email.xx> <commit@email.xx>
+--
+which allows mailmap to replace both the name and the email of a commit
+matching the specified commit email address. And
+--
+	Proper Name <proper@email.xx> Commit Name <commit@email.xx>
+--
+which allows mailmap to replace both the name and the email of a commit
+matching the specified commit name and email address.
 
 So, for example, if your history contains commits by two authors, Jane
 and Joe, whose names appear in the repository under several forms:
@@ -86,6 +95,27 @@ Jane Doe <jane@desktop.(none)>
 Joe R. Developer <joe@random.com>
 ------------
 
+Now, suppose your repository contains commits from the following authors:
+
+------------
+nick1 <bugs@company.xx>
+nick2 <bugs@company.xx>
+nick2 <nick2@company.xx>
+santa <me@company.xx>
+claus <me@company.xx>
+------------
+
+Then, you might want a `.mailmap` file looking like:
+------------
+Some Dude <some@dude.xx>         nick1 <bugs@company.xx>
+Other Author <other@author.xx>   nick2 <bugs@company.xx>
+Other Author <other@author.xx>         <nick2@company.xx>
+Santa Claus <santa.claus@northpole.xx> <me@company.xx>
+------------
+
+Use hash '#' for comments, either on their own line, or after the email address.
+
+
 Author
 ------
 Written by Jeff Garzik <jgarzik@pobox.com>
diff --git a/mailmap.c b/mailmap.c
index 32eab6c..937aa07 100644
--- a/mailmap.c
+++ b/mailmap.c
@@ -2,7 +2,87 @@
 #include "string-list.h"
 #include "mailmap.h"
 
+#define DEBUG_MAILMAP 0
+#if DEBUG_MAILMAP
+#define debug_mm(...) fprintf(stderr, __VA_ARGS__)
+#else
+inline void debug_mm(const char *format, ...) {}
+#endif
+
 const char *git_log_mailmap;
+
+struct mailmap_info {
+	char *name;
+	char *email;
+};
+
+struct mailmap_entry {
+	/* name and email for the simple mail-only case */
+	char *name;
+	char *email;
+
+	/* name and email for the complex mail and name matching case */
+	struct string_list namemap;
+};
+
+void free_mailmap_info(void *p, const char *s)
+{
+	struct mailmap_info *mi = (struct mailmap_info *)p;
+	debug_mm("mailmap: -- complex: '%s' -> '%s' <%s>\n", s, mi->name, mi->email);
+	free(mi->name);
+	free(mi->email);
+}
+
+void free_mailmap_entry(void *p, const char *s)
+{
+	struct mailmap_entry *me = (struct mailmap_entry *)p;
+	debug_mm("mailmap: removing entries for <%s>, with %d sub-entries\n", s, me->namemap.nr);
+	debug_mm("mailmap: - simple: '%s' <%s>\n", me->name, me->email);
+	free(me->name);
+	free(me->email);
+
+	me->namemap.strdup_strings = 1;
+	string_list_clear_func(&me->namemap, free_mailmap_info);
+}
+
+void add_mapping(struct string_list *map,
+		 char *name1, char *email1, char *name2, char *email2)
+{
+	struct mailmap_entry *me;
+	int index = string_list_find_insert_index(map, email1, 1);
+	if (index < 0) {
+		/* mailmap entry exists, invert index value */
+		index = -1 - index;
+	} else {
+		/* create mailmap entry */
+		struct string_list_item *item = string_list_insert_at_index(index, email1, map);
+		item->util = xmalloc(sizeof(struct mailmap_entry));
+		memset(item->util, 0, sizeof(struct mailmap_entry));
+	}
+	me = (struct mailmap_entry *)map->items[index].util;
+
+	if (name2 == NULL) {
+		debug_mm("mailmap: adding (simple) entry for %s at index %d\n", email1, index);
+		/* Replace current name and new email for simple entry */
+		free(me->name);
+		free(me->email);
+		me->name = xstrdup(name1);
+		if (email2)
+			me->email = xstrdup(email2);
+	} else {
+		struct mailmap_info *mi = xmalloc(sizeof(struct mailmap_info));
+		debug_mm("mailmap: adding (complex) entry for %s at index %d\n", email1, index);
+		mi->name = xstrdup(name2);
+		if (email2)
+			mi->email = xstrdup(email2);
+		string_list_insert(name1, &me->namemap)->util = mi;
+	}
+
+	debug_mm("mailmap:  '%s' <%s> -> '%s' <%s>\n",
+		 name2 ? name1 : "", email1,
+		 name2 ? name2 : name1, email2 ? email2 : "");
+}
+
 int read_mailmap(struct string_list *map, const char *filename, char **repo_abbrev)
 {
 	char buffer[1024];
@@ -17,8 +97,8 @@ int read_mailmap(struct string_list *map, const char *filename, char **repo_abbr
 	if (f == NULL)
 		return 1;
 	while (fgets(buffer, sizeof(buffer), f) != NULL) {
-		char *end_of_name, *left_bracket, *right_bracket;
-		char *name, *email;
+		char *end_of_name, *left_bracket1, *right_bracket1, *left_bracket2, *right_bracket2;
+		char *name1, *email1, *name2, *email2;
 		int i;
 		if (buffer[0] == '#') {
 			static const char abbrev[] = "# repo-abbrev:";
@@ -43,41 +123,95 @@ int read_mailmap(struct string_list *map, const char *filename, char **repo_abbr
 			}
 			continue;
 		}
-		if ((left_bracket = strchr(buffer, '<')) == NULL)
+		/* Locate name and email */
+		if ((left_bracket1 = strchr(buffer, '<')) == NULL)
 			continue;
-		if ((right_bracket = strchr(left_bracket + 1, '>')) == NULL)
+		if ((right_bracket1 = strchr(left_bracket1 + 1, '>')) == NULL)
 			continue;
-		if (right_bracket == left_bracket + 1)
+		if (right_bracket1 == left_bracket1 + 1)
 			continue;
-		for (end_of_name = left_bracket;
+		for (end_of_name = left_bracket1;
 		     end_of_name != buffer && isspace(end_of_name[-1]);
 		     end_of_name--)
 			; /* keep on looking */
 		if (end_of_name == buffer)
 			continue;
-		name = xmalloc(end_of_name - buffer + 1);
-		strlcpy(name, buffer, end_of_name - buffer + 1);
-		email = xmalloc(right_bracket - left_bracket);
-		for (i = 0; i < right_bracket - left_bracket - 1; i++)
-			email[i] = tolower(left_bracket[i + 1]);
-		email[right_bracket - left_bracket - 1] = '\0';
-		string_list_insert(email, map)->util = name;
+		name1 = xmalloc(end_of_name - buffer + 1);
+		strlcpy(name1, buffer, end_of_name - buffer + 1);
+		email1 = xmalloc(right_bracket1 - left_bracket1);
+		for (i = 0; i < right_bracket1 - left_bracket1 - 1; i++)
+			email1[i] = tolower(left_bracket1[i + 1]);
+		email1[right_bracket1 - left_bracket1 - 1] = '\0';
+
+		/* Locate 2nd name and email. Possible mappings in mailmap file are:
+		 *   proper_name <commit_email>
+		 *   proper_name <proper_email> <commit_email>
+		 *   proper_name <proper_email> commit_name <commit_email>
+		 */
+		do {
+			email2 = name2 = 0;
+			right_bracket1 += 1;
+			if ((left_bracket2 = strchr(right_bracket1, '<')) == NULL)
+				continue;
+			if ((right_bracket2 = strchr(left_bracket2 + 1, '>')) == NULL)
+				continue;
+			if (right_bracket2 == left_bracket2 + 1)
+				continue;
+			for (end_of_name = left_bracket2;
+			     end_of_name != right_bracket1 && isspace(end_of_name[-1]);
+			     end_of_name--)
+				; /* keep on looking for name end */
+			for (;
+			     end_of_name != right_bracket1 && isspace(right_bracket1[0]);
+			     right_bracket1++)
+				; /* keep on looking for name start */
+			if (end_of_name != right_bracket1) {
+				name2 = xmalloc(end_of_name - right_bracket1 + 1);
+				strlcpy(name2, right_bracket1, end_of_name - right_bracket1 + 1);
+				char *tmp = name1;
+				name1 = name2;
+				name2 = tmp;
+			}
+			email2 = xmalloc(right_bracket2 - left_bracket2);
+			for (i = 0; i < right_bracket2 - left_bracket2 - 1; i++)
+				email2[i] = tolower(left_bracket2[i + 1]);
+			email2[right_bracket2 - left_bracket2 - 1] = '\0';
+			char *tmp = email1;
+			email1 = email2;
+			email2 = tmp;
+		} while(0);
+
+		add_mapping(map, name1, email1, name2, email2);
 	}
 	fclose(f);
 	return 0;
 }
 
-int map_email(struct string_list *map, const char *email, char *name, int maxlen)
+void clear_mailmap(struct string_list *map)
+{
+	debug_mm("mailmap: clearing %d entries...\n", map->nr);
+	map->strdup_strings = 1;
+	string_list_clear_func(map, free_mailmap_entry);
+	debug_mm("mailmap: cleared\n");
+}
+
+int map_user(struct string_list *map,
+	     char *email, int maxlen_email, char *name, int maxlen_name)
 {
 	char *p;
 	struct string_list_item *item;
+	struct mailmap_entry *me;
 	char buf[1024], *mailbuf;
 	int i;
 
-	/* autocomplete common developers */
+	/* figure out space requirement for email */
 	p = strchr(email, '>');
-	if (!p)
-		return 0;
+	if (!p) {
+		/* email passed in might not be wrapped in <>, but end with a \0 */
+		p = memchr(email, '\0', maxlen_email);
+		if (p == 0)
+			return 0;
+	}
 	if (p - email + 1 < sizeof(buf))
 		mailbuf = buf;
 	else
@@ -87,13 +221,39 @@ int map_email(struct string_list *map, const char *email, char *name, int maxlen
 	for (i = 0; i < p - email; i++)
 		mailbuf[i] = tolower(email[i]);
 	mailbuf[i] = 0;
+
+	debug_mm("map_user: map '%s' <%s>\n", name, mailbuf);
 	item = string_list_lookup(mailbuf, map);
+	if (item != NULL) {
+		me = (struct mailmap_entry *)item->util;
+		if (me->namemap.nr) {
+			/* The item has multiple items, so we'll look up on name too */
+			/* If the name is not found, we choose the simple entry      */
+			struct string_list_item *subitem = string_list_lookup(name, &me->namemap);
+			if (subitem)
+				item = subitem;
+		}
+	}
 	if (mailbuf != buf)
 		free(mailbuf);
 	if (item != NULL) {
-		const char *realname = (const char *)item->util;
-		strlcpy(name, realname, maxlen);
+		struct mailmap_info *mi = (struct mailmap_info *)item->util;
+		if (mi->email == NULL && mi->name == NULL) {
+			debug_mm("map_user:  -- (no simple mapping)\n");
+			return 0;
+		}
+		if (maxlen_email && mi->email)
+			strlcpy(email, mi->email, maxlen_email);
+		if (maxlen_name && mi->name)
+			strlcpy(name, mi->name, maxlen_name);
+		debug_mm("map_user:  to '%s' <%s>\n", name, mi->email ? email : mailbuf);
 		return 1;
 	}
+	debug_mm("map_user:  --\n");
 	return 0;
 }
+
+int map_email(struct string_list *map, const char *email, char *name, int maxlen)
+{
+	return map_user(map, (char *)email, 0, name, maxlen);
+}
diff --git a/mailmap.h b/mailmap.h
index 6e48f83..1b5ae69 100644
--- a/mailmap.h
+++ b/mailmap.h
@@ -2,6 +2,10 @@
 #define MAILMAP_H
 
 int read_mailmap(struct string_list *map, const char *filename, char **repo_abbrev);
+void clear_mailmap(struct string_list *map);
+
 int map_email(struct string_list *mailmap, const char *email, char *name, int maxlen);
+int map_user(struct string_list *mailmap,
+	     char *email, int maxlen_email, char *name, int maxlen_name);
 
 #endif
-- 
1.6.1.2.257.g34f62

[PATCH v2 4/4] Change current mailmap usage to do matching on both name and email of author/committer.

[Marius Storm-Olsen]

Signed-off-by: Marius Storm-Olsen <marius@trolltech.com>
---
 Documentation/pretty-formats.txt |    2 +
 builtin-blame.c                  |   50 ++++++++++++-------
 builtin-shortlog.c               |   22 +++++++--
 pretty.c                         |   59 ++++++++++++-----------
 t/t4203-mailmap.sh               |   99 ++++++++++++++++++++++++++++++++++++++
 5 files changed, 180 insertions(+), 52 deletions(-)

diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 3d87d3e..28808b7 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -103,6 +103,7 @@ The placeholders are:
 - '%an': author name
 - '%aN': author name (respecting .mailmap)
 - '%ae': author email
+- '%aE': author email (respecting .mailmap)
 - '%ad': author date (format respects --date= option)
 - '%aD': author date, RFC2822 style
 - '%ar': author date, relative
@@ -111,6 +112,7 @@ The placeholders are:
 - '%cn': committer name
 - '%cN': committer name (respecting .mailmap)
 - '%ce': committer email
+- '%cE': committer email (respecting .mailmap)
 - '%cd': committer date
 - '%cD': committer date, RFC2822 style
 - '%cr': committer date, relative
diff --git a/builtin-blame.c b/builtin-blame.c
index 4b63775..c166ba1 100644
--- a/builtin-blame.c
+++ b/builtin-blame.c
@@ -1263,11 +1263,12 @@ struct commit_info
  * Parse author/committer line in the commit object buffer
  */
 static void get_ac_line(const char *inbuf, const char *what,
-			int bufsz, char *person, const char **mail,
+			int person_len, char *person,
+			int mail_len, char *mail,
 			unsigned long *time, const char **tz)
 {
 	int len, tzlen, maillen;
-	char *tmp, *endp, *timepos;
+	char *tmp, *endp, *timepos, *mailpos;
 
 	tmp = strstr(inbuf, what);
 	if (!tmp)
@@ -1278,10 +1279,11 @@ static void get_ac_line(const char *inbuf, const char *what,
 		len = strlen(tmp);
 	else
 		len = endp - tmp;
-	if (bufsz <= len) {
+	if (person_len <= len) {
 	error_out:
 		/* Ugh */
-		*mail = *tz = "(unknown)";
+		*tz = "(unknown)";
+		strcpy(mail, *tz);
 		*time = 0;
 		return;
 	}
@@ -1304,9 +1306,10 @@ static void get_ac_line(const char *inbuf, const char *what,
 	*tmp = 0;
 	while (*tmp != ' ')
 		tmp--;
-	*mail = tmp + 1;
+	mailpos = tmp + 1;
 	*tmp = 0;
 	maillen = timepos - tmp;
+	memcpy(mail, mailpos, maillen);
 
 	if (!mailmap.nr)
 		return;
@@ -1315,20 +1318,23 @@ static void get_ac_line(const char *inbuf, const char *what,
 	 * mailmap expansion may make the name longer.
 	 * make room by pushing stuff down.
 	 */
-	tmp = person + bufsz - (tzlen + 1);
+	tmp = person + person_len - (tzlen + 1);
 	memmove(tmp, *tz, tzlen);
 	tmp[tzlen] = 0;
 	*tz = tmp;
 
-	tmp = tmp - (maillen + 1);
-	memmove(tmp, *mail, maillen);
-	tmp[maillen] = 0;
-	*mail = tmp;
-
 	/*
-	 * Now, convert e-mail using mailmap
+	 * Now, convert both name and e-mail using mailmap
 	 */
-	map_email(&mailmap, tmp + 1, person, tmp-person-1);
+	if(map_user(&mailmap, mail+1, mail_len-1, person, tmp-person-1)) {
+		/* Add a trailing '>' to email, since map_user returns plain emails
+		   Note: It already has '<', since we replace from mail+1 */
+		mailpos = memchr(mail, '\0', mail_len);
+		if (mailpos && mailpos-mail < mail_len - 1) {
+			*mailpos = '>';
+			*(mailpos+1) = '\0';
+		}
+	}
 }
 
 static void get_commit_info(struct commit *commit,
@@ -1337,8 +1343,10 @@ static void get_commit_info(struct commit *commit,
 {
 	int len;
 	char *tmp, *endp, *reencoded, *message;
-	static char author_buf[1024];
-	static char committer_buf[1024];
+	static char author_name[1024];
+	static char author_mail[1024];
+	static char committer_name[1024];
+	static char committer_mail[1024];
 	static char summary_buf[1024];
 
 	/*
@@ -1356,9 +1364,11 @@ static void get_commit_info(struct commit *commit,
 	}
 	reencoded = reencode_commit_message(commit, NULL);
 	message   = reencoded ? reencoded : commit->buffer;
-	ret->author = author_buf;
+	ret->author = author_name;
+	ret->author_mail = author_mail;
 	get_ac_line(message, "\nauthor ",
-		    sizeof(author_buf), author_buf, &ret->author_mail,
+		    sizeof(author_name), author_name,
+		    sizeof(author_mail), author_mail,
 		    &ret->author_time, &ret->author_tz);
 
 	if (!detailed) {
@@ -1366,9 +1376,11 @@ static void get_commit_info(struct commit *commit,
 		return;
 	}
 
-	ret->committer = committer_buf;
+	ret->committer = committer_name;
+	ret->committer_mail = committer_mail;
 	get_ac_line(message, "\ncommitter ",
-		    sizeof(committer_buf), committer_buf, &ret->committer_mail,
+		    sizeof(committer_name), committer_name,
+		    sizeof(committer_mail), committer_mail,
 		    &ret->committer_time, &ret->committer_tz);
 
 	ret->summary = summary_buf;
diff --git a/builtin-shortlog.c b/builtin-shortlog.c
index 04832a8..19975ce 100644
--- a/builtin-shortlog.c
+++ b/builtin-shortlog.c
@@ -40,6 +40,7 @@ static void insert_one_record(struct shortlog *log,
 	char *buffer, *p;
 	struct string_list_item *item;
 	char namebuf[1024];
+	char emailbuf[1024];
 	size_t len;
 	const char *eol;
 	const char *boemail, *eoemail;
@@ -51,7 +52,19 @@ static void insert_one_record(struct shortlog *log,
 	eoemail = strchr(boemail, '>');
 	if (!eoemail)
 		return;
-	if (!map_email(&log->mailmap, boemail+1, namebuf, sizeof(namebuf))) {
+
+	/* copy author name to namebuf, to support matching on both name and email */
+	memcpy(namebuf, author, boemail - author);
+	len = boemail - author;
+	while(len > 0 && isspace(namebuf[len-1]))
+		len--;
+	namebuf[len] = 0;
+
+	/* copy email name to emailbuf, to allow email replacement as well */
+	memcpy(emailbuf, boemail+1, eoemail - boemail);
+	emailbuf[eoemail - boemail - 1] = 0;
+
+	if (!map_user(&log->mailmap, emailbuf, sizeof(emailbuf), namebuf, sizeof(namebuf))) {
 		while (author < boemail && isspace(*author))
 			author++;
 		for (len = 0;
@@ -67,8 +80,8 @@ static void insert_one_record(struct shortlog *log,
 
 	if (log->email) {
 		size_t room = sizeof(namebuf) - len - 1;
-		int maillen = eoemail - boemail + 1;
-		snprintf(namebuf + len, room, " %.*s", maillen, boemail);
+		int maillen = strlen(emailbuf);
+		snprintf(namebuf + len, room, " <%.*s>", maillen, emailbuf);
 	}
 
 	item = string_list_insert(namebuf, &log->list);
@@ -321,6 +334,5 @@ void shortlog_output(struct shortlog *log)
 
 	log->list.strdup_strings = 1;
 	string_list_clear(&log->list, 1);
-	log->mailmap.strdup_strings = 1;
-	string_list_clear(&log->mailmap, 1);
+	clear_mailmap(&log->mailmap);
 }
diff --git a/pretty.c b/pretty.c
index cc460b5..e93e472 100644
--- a/pretty.c
+++ b/pretty.c
@@ -305,23 +305,14 @@ static char *logmsg_reencode(const struct commit *commit,
 	return out;
 }
 
-static int mailmap_name(struct strbuf *sb, const char *email)
+static int mailmap_name(char *email, int email_len, char *name, int name_len)
 {
 	static struct string_list *mail_map;
-	char buffer[1024];
-
 	if (!mail_map) {
 		mail_map = xcalloc(1, sizeof(*mail_map));
-		read_mailmap(mail_map, ".mailmap", NULL);
+		read_mailmap(mail_map, NULL, NULL);
 	}
-
-	if (!mail_map->nr)
-		return -1;
-
-	if (!map_email(mail_map, email, buffer, sizeof(buffer)))
-		return -1;
-	strbuf_addstr(sb, buffer);
-	return 0;
+	return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
 }
 
 static size_t format_person_part(struct strbuf *sb, char part,
@@ -332,6 +323,9 @@ static size_t format_person_part(struct strbuf *sb, char part,
 	int start, end, tz = 0;
 	unsigned long date = 0;
 	char *ep;
+	const char *name_start, *name_end, *mail_start, *mail_end, *msg_end = msg+len;
+	char person_name[1024];
+	char person_mail[1024];
 
 	/* advance 'end' to point to email start delimiter */
 	for (end = 0; end < len && msg[end] != '<'; end++)
@@ -345,25 +339,34 @@ static size_t format_person_part(struct strbuf *sb, char part,
 	if (end >= len - 2)
 		goto skip;
 
+	/* Seek for both name and email part */
+	name_start = msg;
+	name_end = msg+end;
+	while (name_end > name_start && isspace(*(name_end-1)))
+		name_end--;
+	mail_start = msg+end+1;
+	mail_end = mail_start;
+	while (mail_end < msg_end && *mail_end != '>')
+		mail_end++;
+	if (mail_end == msg_end)
+		goto skip;
+	end = mail_end-msg;
+
+	if (part == 'N' || part == 'E') { /* mailmap lookup */
+		strlcpy(person_name, name_start, name_end-name_start+1);
+		strlcpy(person_mail, mail_start, mail_end-mail_start+1);
+		mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
+		name_start = person_name;
+		name_end = name_start + strlen(person_name);
+		mail_start = person_mail;
+		mail_end = mail_start +  strlen(person_mail);
+	}
 	if (part == 'n' || part == 'N') {	/* name */
-		while (end > 0 && isspace(msg[end - 1]))
-			end--;
-		if (part != 'N' || !msg[end] || !msg[end + 1] ||
-		    mailmap_name(sb, msg + end + 2) < 0)
-			strbuf_add(sb, msg, end);
+		strbuf_add(sb, name_start, name_end-name_start);
 		return placeholder_len;
 	}
-	start = ++end; /* save email start position */
-
-	/* advance 'end' to point to email end delimiter */
-	for ( ; end < len && msg[end] != '>'; end++)
-		; /* do nothing */
-
-	if (end >= len)
-		goto skip;
-
-	if (part == 'e') {	/* email */
-		strbuf_add(sb, msg + start, end - start);
+	if (part == 'e' || part == 'E') {	/* email */
+		strbuf_add(sb, mail_start, mail_end-mail_start);
 		return placeholder_len;
 	}
 
diff --git a/t/t4203-mailmap.sh b/t/t4203-mailmap.sh
index 57fd88e..271ef26 100755
--- a/t/t4203-mailmap.sh
+++ b/t/t4203-mailmap.sh
@@ -50,4 +50,103 @@ test_expect_success 'No mailmap files, but configured' '
 	test_cmp expect actual
 '
 
+# Extended mailmap configurations should give us the following output for shortlog
+cat >expect <<\EOF
+A U Thor <author@example.com> (1):
+      initial
+
+Other Author <other@author.xx> (2):
+      third
+      fourth
+
+Santa Claus <santa.claus@northpole.xx> (2):
+      fifth
+      sixth
+
+Some Dude <some@dude.xx> (1):
+      second
+
+EOF
+
+test_expect_success 'Shortlog output (complex mapping)' '
+
+	echo two >>one &&
+	git add one &&
+	test_tick &&
+	git commit --author "nick1 <bugs@company.xx>" -m second &&
+
+	echo three >>one &&
+	git add one &&
+	test_tick &&
+	git commit --author "nick2 <bugs@company.xx>" -m third &&
+
+	echo four >>one &&
+	git add one &&
+	test_tick &&
+	git commit --author "nick2 <nick2@company.xx>" -m fourth &&
+
+	echo five >>one &&
+	git add one &&
+	test_tick &&
+	git commit --author "santa <me@company.xx>" -m fifth &&
+
+	echo six >>one &&
+	git add one &&
+	test_tick &&
+	git commit --author "claus <me@company.xx>" -m sixth &&
+
+	mkdir internal_mailmap &&
+	echo "Committed <committer@example.com>" > internal_mailmap/.mailmap &&
+	echo "Some Dude <some@dude.xx>         nick1 <bugs@company.xx>" >> internal_mailmap/.mailmap &&
+	echo "Other Author <other@author.xx>   nick2 <bugs@company.xx>" >> internal_mailmap/.mailmap &&
+	echo "Other Author <other@author.xx>         <nick2@company.xx>" >> internal_mailmap/.mailmap &&
+	echo "Santa Claus <santa.claus@northpole.xx> <me@company.xx>" >> internal_mailmap/.mailmap &&
+	echo "Santa Claus <santa.claus@northpole.xx> <me@company.xx>" >> internal_mailmap/.mailmap &&
+
+	git shortlog -e >actual &&
+	test_cmp expect actual
+
+'
+
+# git log with --pretty format which uses the name and email mailmap placemarkers
+cat >expect <<\EOF
+Author claus <me@company.xx> maps to Santa Claus <santa.claus@northpole.xx>
+Committer C O Mitter <committer@example.com> maps to Committed <committer@example.com>
+
+Author santa <me@company.xx> maps to Santa Claus <santa.claus@northpole.xx>
+Committer C O Mitter <committer@example.com> maps to Committed <committer@example.com>
+
+Author nick2 <nick2@company.xx> maps to Other Author <other@author.xx>
+Committer C O Mitter <committer@example.com> maps to Committed <committer@example.com>
+
+Author nick2 <bugs@company.xx> maps to Other Author <other@author.xx>
+Committer C O Mitter <committer@example.com> maps to Committed <committer@example.com>
+
+Author nick1 <bugs@company.xx> maps to Some Dude <some@dude.xx>
+Committer C O Mitter <committer@example.com> maps to Committed <committer@example.com>
+
+Author A U Thor <author@example.com> maps to A U Thor <author@example.com>
+Committer C O Mitter <committer@example.com> maps to Committed <committer@example.com>
+EOF
+
+test_expect_success 'Log output (complex mapping)' '
+	git log --pretty=format:"Author %an <%ae> maps to %aN <%aE>%nCommitter %cn <%ce> maps to %cN <%cE>%n" >actual &&
+	test_cmp expect actual
+'
+
+# git blame
+cat >expect <<\EOF
+^3a2fdcb (A U Thor     2005-04-07 15:13:13 -0700 1) one
+e0f60492 (Some Dude    2005-04-07 15:14:13 -0700 2) two
+4db1a3df (Other Author 2005-04-07 15:15:13 -0700 3) three
+e3718380 (Other Author 2005-04-07 15:16:13 -0700 4) four
+25e4bf3d (Santa Claus  2005-04-07 15:17:13 -0700 5) five
+17c39712 (Santa Claus  2005-04-07 15:18:13 -0700 6) six
+EOF
+
+test_expect_success 'Blame output (complex mapping)' '
+	git blame one >actual &&
+	test_cmp expect actual
+'
+
 test_done
-- 
1.6.1.2.257.g34f62

Re: [PATCH v2 2/4] Add find_insert_index, insert_at_index and clear_func functions to string_list

[Junio C Hamano]

Marius Storm-Olsen <marius@trolltech.com> writes:

> string_list_find_insert_index() and string_list_insert_at_index() enables you to see if an item is in the string_list, and to insert at the appropriate index in the list, if not there.
> This is usefull if you need to manipulate an existing item, if present, and insert a new item if not.
>
> Future mailmap code will use this construct to enable complex (old_name, old_email) -> (new_name, new_email) lookups.
>
> The string_list_clear_func() allows to call a custom cleanup function on each item in a string_list, which is useful is the util member points to a complex structure.

What's with these overlong lines?  You do not have them in your other
patches.

Re: [PATCH v2 2/4] Add find_insert_index, insert_at_index and clear_func functions to string_list

[Marius Storm-Olsen]

[-- Attachment #1: Type: text/plain, Size: 1079 bytes --]

Junio C Hamano said the following on 02.02.2009 04:03:
> Marius Storm-Olsen <marius@trolltech.com> writes:
> 
>> string_list_find_insert_index() and string_list_insert_at_index()
>> enables you to see if an item is in the string_list, and to
>> insert at the appropriate index in the list, if not there. This
>> is usefull if you need to manipulate an existing item, if
>> present, and insert a new item if not.
>> 
>> Future mailmap code will use this construct to enable complex
>> (old_name, old_email) -> (new_name, new_email) lookups.
>> 
>> The string_list_clear_func() allows to call a custom cleanup
>> function on each item in a string_list, which is useful is the
>> util member points to a complex structure.
> 
> What's with these overlong lines?  You do not have them in your
> other patches.

Sorry, that was my editor which wrapped them visibly at column 70, and 
I forgot to insert manual line-breaks before saving.
I'll correct it for the next version.

-- 
.marius [@trolltech.com]
'if you know what you're doing, it's not research'


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 187 bytes --]

Re: [PATCH v2 1/4] Add log.mailmap as configurational option for mailmap location

[Junio C Hamano]

Marius Storm-Olsen <marius@trolltech.com> writes:

> This allows us to override a repo mailmap file, or to use
> mailmap files elsewhere than the repository root.

I think the new feature is not so well conceived.

Should it always be a wholesale override, or should it also support
augmenting the repository version with a private copy?

> diff --git a/builtin-blame.c b/builtin-blame.c
> index aae14ef..4b63775 100644
> --- a/builtin-blame.c
> +++ b/builtin-blame.c
> @@ -2394,7 +2394,7 @@ parse_done:
>  		die("reading graft file %s failed: %s",
>  		    revs_file, strerror(errno));
>  
> -	read_mailmap(&mailmap, ".mailmap", NULL);
> +	read_mailmap(&mailmap, NULL, NULL);

Your callers always seem to pass NULL for the second argument.  Doesn't it
make a lot more sense to get rid of it?

Re: [PATCH v2 1/4] Add log.mailmap as configurational option for mailmap location

[Marius Storm-Olsen]

[-- Attachment #1: Type: text/plain, Size: 1331 bytes --]

Junio C Hamano said the following on 02.02.2009 04:01:
> Marius Storm-Olsen <marius@trolltech.com> writes:
>> This allows us to override a repo mailmap file, or to use
>> mailmap files elsewhere than the repository root.
> 
> I think the new feature is not so well conceived.
> 
> Should it always be a wholesale override, or should it also support
> augmenting the repository version with a private copy?

Sure, I can rewrite it to be augmenting, rather than overriding.
I assume that the normal .mailmap file should be parsed first, then 
the log.mailmap one?


>> diff --git a/builtin-blame.c b/builtin-blame.c
>> index aae14ef..4b63775 100644
>> --- a/builtin-blame.c
>> +++ b/builtin-blame.c
>> @@ -2394,7 +2394,7 @@ parse_done:
>>  		die("reading graft file %s failed: %s",
>>  		    revs_file, strerror(errno));
>>  
>> -	read_mailmap(&mailmap, ".mailmap", NULL);
>> +	read_mailmap(&mailmap, NULL, NULL);
> 
> Your callers always seem to pass NULL for the second argument.  Doesn't it
> make a lot more sense to get rid of it?

Sure, but I left it in to allow "old-style" usage. Just in case the 
were use-cases for not using the log.mailmap one. I can nuke the 
arguments if you don't want them anymore.

-- 
.marius [@trolltech.com]
'if you know what you're doing, it's not research'


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 187 bytes --]

Re: [PATCH v2 1/4] Add log.mailmap as configurational option for mailmap location

[Junio C Hamano]

Marius Storm-Olsen <marius@trolltech.com> writes:

> Junio C Hamano said the following on 02.02.2009 04:01:
>> Marius Storm-Olsen <marius@trolltech.com> writes:
>>> This allows us to override a repo mailmap file, or to use
>>> mailmap files elsewhere than the repository root.
>>
>> I think the new feature is not so well conceived.
>>
>> Should it always be a wholesale override, or should it also support
>> augmenting the repository version with a private copy?
>
> Sure, I can rewrite it to be augmenting, rather than overriding.
> I assume that the normal .mailmap file should be parsed first, then
> the log.mailmap one?

Augmenting one would behave that way.  I was more wondering if people
would want to be able to choose either, perhaps from the command line
option or something.

> Sure, but I left it in to allow "old-style" usage. Just in case the
> were use-cases for not using the log.mailmap one. I can nuke the
> arguments if you don't want them anymore.

What I think would be sensible, if we really want to make this feature
flexible, would be to introduce a command line option (and perhaps
environment variable) that takes the usual precidence (the command line
that specifies the mailmap file, then the environment and then finally the
log.mailmap config variable).  And if we go that route, that "usuall NULL"
parameter would be where the callers pass the filename they got from their
command line.

But if you feel it is overengineering, I would not disagree.  In such a
case, however, I do not think there is a reason for one particular caller
to pass some custom value there, just to be inconsistent from others.

Re: [PATCH v2 1/4] Add log.mailmap as configurational option for mailmap location

[Marius Storm-Olsen]

[-- Attachment #1: Type: text/plain, Size: 2713 bytes --]

Junio C Hamano said the following on 02.02.2009 08:56:
> Marius Storm-Olsen <marius@trolltech.com> writes:
>> Junio C Hamano said the following on 02.02.2009 04:01:
>>> Should it always be a wholesale override, or should it also
>>> support augmenting the repository version with a private copy?
>> Sure, I can rewrite it to be augmenting, rather than overriding. 
>> I assume that the normal .mailmap file should be parsed first,
>> then the log.mailmap one?
> 
> Augmenting one would behave that way.  I was more wondering if
> people would want to be able to choose either, perhaps from the
> command line option or something.

Oh, I see. *ponder* maybe, though you could say that about any option 
in the .git/config file, right?


>> Sure, but I left it in to allow "old-style" usage. Just in case
>> the were use-cases for not using the log.mailmap one. I can nuke
>> the arguments if you don't want them anymore.
> 
> What I think would be sensible, if we really want to make this
> feature flexible, would be to introduce a command line option (and
> perhaps environment variable) that takes the usual precidence (the
> command line that specifies the mailmap file, then the environment
> and then finally the log.mailmap config variable).  And if we go
> that route, that "usuall NULL" parameter would be where the callers
> pass the filename they got from their command line.
> 
> But if you feel it is overengineering, I would not disagree.  In
> such a case, however, I do not think there is a reason for one
> particular caller to pass some custom value there, just to be
> inconsistent from others.

I'm not sure of the use case of the command line option. In which case 
would you want to only use the mailmap for that one command? It 
doesn't normally affect your git commands, so it doesn't hurt to just 
set the log.mailmap option. The environment use case would be just 
like setting it in your ~/.gitconfig, other than you can have a 
different one for each console, I guess.

Now, if we extended the mailmap feature even further, to report the 
mappings from the rev-list code ((optional of course)), so that any 
log viewer would show the mapped information; _then_ I would consider 
the command-line and environment variables as mandatory. Since, then 
you might want the feature off by default, and only use the mappings 
when you need to figure out a breakage, thus need a quick way to 
enable it.

So, unless anyone raises their hand that they need 
command-line/environment ways of setting the mailmap file used, I'll 
leave it as is for now. Ok?

-- 
.marius [@trolltech.com]
'if you know what you're doing, it's not research'


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 187 bytes --]

Re: [PATCH v2 1/4] Add log.mailmap as configurational option for mailmap location

[Junio C Hamano]

Marius Storm-Olsen <marius@trolltech.com> writes:

> Junio C Hamano said the following on 02.02.2009 08:56:
>> Marius Storm-Olsen <marius@trolltech.com> writes:
>>> Junio C Hamano said the following on 02.02.2009 04:01:
>>>> Should it always be a wholesale override, or should it also
>>>> support augmenting the repository version with a private copy?
>>> Sure, I can rewrite it to be augmenting, rather than overriding. I
>>> assume that the normal .mailmap file should be parsed first,
>>> then the log.mailmap one?
>>
>> Augmenting one would behave that way.  I was more wondering if
>> people would want to be able to choose either, perhaps from the
>> command line option or something.
>
> Oh, I see. *ponder* maybe, though you could say that about any option
> in the .git/config file, right?

I was more thinking along the line of how .gitignore works, accumulating
exclude patterns we find from .gitignore files along the way while
descending into the directory hierarchy, and all the while honoring what
the user added in .git/info/excludes.

> I'm not sure of the use case of the command line option. In which case
> would you want to only use the mailmap for that one command? It
> doesn't normally affect your git commands, so it doesn't hurt to just
> set the log.mailmap option. The environment use case would be just
> like setting it in your ~/.gitconfig, other than you can have a
> different one for each console, I guess.

Yeah, that is exactly why I suggested you to say that is overengineered
and is not useful ;-)

> Now, if we extended the mailmap feature even further, to report the
> mappings from the rev-list code ((optional of course)), so that any
> log viewer would show the mapped information; _then_ I would consider
> the command-line and environment variables as mandatory. Since, then
> you might want the feature off by default, and only use the mappings
> when you need to figure out a breakage, thus need a quick way to
> enable it.

Now you mention it, it might be wonderful if "git log --author" honored
the mailmap file, but I do not think command line nor environment do not
have much to do with it.

In any case, it is an independent issue from how mailmap maching and
rewriting should work, which was the main point fo your series.

> So, unless anyone raises their hand that they need
> command-line/environment ways of setting the mailmap file used, I'll
> leave it as is for now. Ok?

My point was that you should drop the second always-NULL parameter if the
plan is not to have any command line filename.  And I agree with your
reasoning that a command line filename is not useful, so...

Re: [PATCH v2 0/4] Extend mailmap functionality

[Junio C Hamano]

Marius Storm-Olsen <marius@trolltech.com> writes:

> 2) Lets you replace both name and email of an author/committer, based
> on a name and/or email. So, should you have done commits with faulty
> address, or if an old email simply isn't valid anymore, you can add
> a mapping for that to replace it. So, the old style mapping is
>     Proper Name <commit@email.xx>
>
> while this patch series adds support for
>     Proper Name <proper@email.xx> <commit@email.xx>
>     Proper Name <proper@email.xx> Commit Name <commit@email.xx>
>
> This extended mapping is necessary when a company wants to have their
> repositories open to the public, but needs to protect the identities
> of the developers. It enables you to only show nicks and standardized
> emails, like 'Dev123 <bugs@company.xx>' in the public repo, but by
> using an private mailmap file, map the name back to
> 'John Doe <john.doe@company.xx>' inside the company.

I do not find the "necessary" argument very convincing nor I find the
particular use case sane.  You may want to do things that way, but I do
not know if it is the best way to go about it.

The new mapping however brings in more flexibility, and there may be other
use cases where people benefit from that flexibility.  I am slightly in
favor than neutral to this new feature.

Re: [PATCH v2 0/4] Extend mailmap functionality

[Sverre Rabbelier]

On Mon, Feb 2, 2009 at 04:03, Junio C Hamano <gitster@pobox.com> wrote:
> The new mapping however brings in more flexibility, and there may be other
> use cases where people benefit from that flexibility.  I am slightly in
> favor than neutral to this new feature.

It sure does, I use git-svn for a project hosted on Google Code, and
the e-mail addresses are totally borked (e.g., "gmail-account-id"
<gmail-account-id@the-svn-repo-uuid>). Not only that, but some
developers (including me I must admit) have a rather obscure
gmail-account-id, which is uses as the user's name for the commit
message. It would be very nice if I could provide a mapping from
"borked svn id's" to "normal, sensible e-mail addresses, including
real names", a feature which this series seems to add :).

-- 
Cheers,

Sverre Rabbelier

Re: [PATCH v2 0/4] Extend mailmap functionality

[Marius Storm-Olsen]

[-- Attachment #1: Type: text/plain, Size: 2183 bytes --]

Junio C Hamano said the following on 02.02.2009 04:03:
>> This extended mapping is necessary when a company wants to have
>> their repositories open to the public, but needs to protect the
>> identities of the developers. It enables you to only show nicks
>> and standardized emails, like 'Dev123 <bugs@company.xx>' in the
>> public repo, but by using an private mailmap file, map the name
>> back to 'John Doe <john.doe@company.xx>' inside the company.
> 
> I do not find the "necessary" argument very convincing nor I find
> the particular use case sane.  You may want to do things that way,
> but I do not know if it is the best way to go about it.

Well, this is the use-case for my company. We have open-source repos, 
which are the exact same repos which the company's developers work on, 
not a modified mirror repo.
However, laws in some countries requires that employees information be 
kept away from the public, should they so wish. So, for our developers 
to work on the exact same repo as the open-source community, we need a 
way to map both Names and Emails back to the original author, inside 
the company without using a different repo.

Also, the company commit policy might be such that the email on the 
commit is always the companys <bugs@company.xx>. This might be so that 
if someone finds a bug to your commit, they send the bug report to the 
companys bug-tracker instead of the individual email address.
However, that breaks the old mailmap system, since it requires unique 
email addresses to map to a name.

> The new mapping however brings in more flexibility, and there may
> be other use cases where people benefit from that flexibility.  I
> am slightly in favor than neutral to this new feature.

You could use this feature in git.git itself, where for example
     Junio C Hamano <gitster@pobox.com>
     Junio C Hamano <gitster@pobox.com> <junio@twinsun.com>
(or any of the others in the .mailmap file with X number of different 
email addresses), to ensure that you are always associated with one 
specific email address.

-- 
.marius [@trolltech.com]
'if you know what you're doing, it's not research'


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 187 bytes --]