aboutsummaryrefslogtreecommitdiff
path: root/.mailmap
diff options
context:
space:
mode:
authorAlex Bennée <alex.bennee@linaro.org>2019-08-28 12:03:23 +0100
committerAlex Bennée <alex.bennee@linaro.org>2019-09-02 10:52:22 +0100
commitf4cf1edc3b897c5fbc82b388285de53b7f614ca8 (patch)
tree9948c7fdfc952b9fcff6d4652cbef7dfd33499f4 /.mailmap
parent1fed8f004465ce1cb6994b5d3de6fd7df91c4c33 (diff)
.mailmap/aliases: add some further commentary
The two files are not interchangeable but a change to one *might* require a change to the other so lets flag that up with an explanation of what both files are trying to achieve. While we are at it document the many forms .mailmap can take in the header. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Aleksandar Markovic <amarkovic@wavecomp.com>
Diffstat (limited to '.mailmap')
-rw-r--r--.mailmap14
1 files changed, 14 insertions, 0 deletions
diff --git a/.mailmap b/.mailmap
index d0fc1d793c..0756a0bf66 100644
--- a/.mailmap
+++ b/.mailmap
@@ -1,4 +1,18 @@
# This mailmap fixes up author names/addresses.
+#
+# If you are adding to this file consider if a similar change needs to
+# be made to contrib/gitdm/aliases. They are not however completely
+# analogous. .mailmap is concerned with fixing up damaged author
+# fields where as the gitdm equivalent is more concerned with making
+# sure multiple email addresses get mapped onto the same author.
+#
+# From man git-shortlog the forms are:
+#
+# Proper Name <commit@email.xx>
+# <proper@email.xx> <commit@email.xx>
+# Proper Name <proper@email.xx> <commit@email.xx>
+# Proper Name <proper@email.xx> Commit Name <commit@email.xx>
+#
# The first section translates weird addresses from the original git import
# into proper addresses so that they are counted properly by git shortlog.