Skip to content

Commit 5ac7b3c

Browse files
committed
.mailmap: Remove stale SVN references
Also explain the true purpose of this file. Signed-off-by: Jeff Squyres <[email protected]>
1 parent 61e900e commit 5ac7b3c

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

.mailmap

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1-
# This file exists to help map usernames to proper names and email addresses
2-
# in the Open MPI github mirror of the canonical SVN repository. The github
3-
# mirror can be found here:
1+
# This file exists to help consolidate names and email addresses
2+
# (e.g., when people accidentally commit with an incorrect or local
3+
# email address). Two common use cases:
44
#
5-
# https://github.com/open-mpi/ompi-svn-mirror
5+
# 1. Consolidate multiple email addresses from a single person.
6+
# Example: one commit from John Smith is from
7+
# <[email protected]> and another is from
8+
# <[email protected]>, and a third is from
9+
# <[email protected]>. But they're all from
10+
# the same John Smith person.
11+
#
12+
# 2. Consolidate misspellings / altername names from a single person.
13+
# Example: one commit is from "John Smith" and another is from
14+
# "John Smith, CONTRACTOR", and third is from "RocketMan 9982". But
15+
# these are all really the same person, who can be listed once in
16+
# AUTHORS as "John Smith".
617
#
718
# The format of this file is documented in git-shortlog(1). Specifically,
819
# a line like this:
@@ -12,12 +23,11 @@
1223
# means that when git sees "[email protected]" it will display
1324
# "Proper Name <[email protected]>" instead in certain circumstances. Those
1425
# circumstances include:
26+
#
1527
# - git shortlog
1628
# - git blame
1729
# - git log --format=tformat:"%aN <%aE>" (and similar)
1830
#
19-
# A copy of this file should be present on each branch in SVN which is being
20-
# tracked in the Git mirror.
2131

2232
# Jeff accidentally stomped on his $HOME/.gitconfig for a short while:
2333
Jeff Squyres <[email protected]> --quiet <--quiet>

0 commit comments

Comments
 (0)