Skip to contentSkip to conversation

mailmap: Update comments for with format and more detalis

PATCH Applied Kees Cook 3 participants 4 messages Aug 8, 2020 – Aug 11, 2020 Documentation

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 mailmap: Update comments for with format and more detalis

Without having first read the git-shortlog man-page first, the format of .mailmap may not be immediately obvious. Add comments with pointers to the man-page, along with other details.

---
I'm adding this to my earlier .mailmap update series:
https://lore.kernel.org/lkml/[email protected]/

---
 .mailmap | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
.mailmap +7 -2
index 6c1c04a63b18..3a991e19928c 100644
@@ -2,11 +2,16 @@
 # This list is used by git-shortlog to fix a few botched name translations
 # in the git archive, either because the author's full name was messed up
 # and/or not always written the same way, making contributions from the
-# same person appearing not to be so or badly displayed.
+# same person appearing not to be so or badly displayed. Also allows for
+# old email addresses to map to new email addresses.
 #
+# For format details, see "MAPPING AUTHORS" in "man git-shortlog".
+#
+# Please keep this list dictionary sorted.
+#
+# This comment is parsed by git-shortlog:
 # repo-abbrev: /pub/scm/linux/kernel/git/
 #
-
 Aaron Durbin <[email protected]>
 Adam Oldham <[email protected]>
 Adam Radford <[email protected]>
Signature · 5 lines
2.25.1


-- 
Kees Cook
#1 lore raw
Quoted 17 lines · Kees Cook

Without having first read the git-shortlog man-page first, the format of .mailmap may not be immediately obvious. Add comments with pointers to the man-page, along with other details.

---
I'm adding this to my earlier .mailmap update series:
https://lore.kernel.org/lkml/[email protected]/

---
 .mailmap | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
.mailmap +0 -0
index 6c1c04a63b18..3a991e19928c 100644

.mailmap line 2

Quoted 1 line
.mailmap +0 -0
@@ -2,11 +2,16 @@
 # This list is used by git-shortlog

and scripts/get_maintainer.pl

Today, this list is primarily used not for
messed up email addresses. It's mostly used
to map no longer in-use email addresses to
current email address.

Quoted 22 lines
.mailmap +7 -2
 to fix a few botched name translations
 # in the git archive, either because the author's full name was messed up
 # and/or not always written the same way, making contributions from the
-# same person appearing not to be so or badly displayed.
+# same person appearing not to be so or badly displayed. Also allows for
+# old email addresses to map to new email addresses.
 #
+# For format details, see "MAPPING AUTHORS" in "man git-shortlog".
+#
+# Please keep this list dictionary sorted.
+#
+# This comment is parsed by git-shortlog:
 # repo-abbrev: /pub/scm/linux/kernel/git/
 #
-
 Aaron Durbin <[email protected]>
 Adam Oldham <[email protected]>

Adam Radford <[email protected]>

Signature · 1 line
2.25.1
maintainer Applied
#2 lore raw
In reply to Kees Cook
Quoted 5 lines · On Sat, 8 Aug 2020 00:14:36 -0700 Kees Cook <[email protected]> wrote:

Without having first read the git-shortlog man-page first, the format of .mailmap may not be immediately obvious. Add comments with pointers to the man-page, along with other details.

Applied, thanks. I did take the liberty of removing the redundant "first" from the changelog, though :)

jon

author
#3 lore raw
Quoted 11 lines · Jonathan Corbet
Quoted 5 lines · On Sat, 8 Aug 2020 00:14:36 -0700 Kees Cook <[email protected]> wrote:

Without having first read the git-shortlog man-page first, the format of .mailmap may not be immediately obvious. Add comments with pointers to the man-page, along with other details.

Applied, thanks. I did take the liberty of removing the redundant "first" from the changelog, though :)

It seems I can only edit other people's writing. ;)

Thank you!

Signature · 1 line
Kees Cook