W3cubDocs

/Git

git-check-mailmap

Name

git-check-mailmap - Show canonical names and email addresses of contacts

Synopsis

git check-mailmap [<options>] <contact>…​

Description

For each “Name <[email protected]>” or “<[email protected]>” from the command-line or standard input (when using --stdin), look up the person’s canonical name and email address (see "Mapping Authors" below). If found, print them; otherwise print the input as-is.

Options

--stdin

Read contacts, one per line, from the standard input after exhausting contacts provided on the command-line.

Output

For each contact, a single line is output, terminated by a newline. If the name is provided or known to the mailmap, “Name <[email protected]>” is printed; otherwise only “<[email protected]>” is printed.

Mapping authors

If the file .mailmap exists at the toplevel of the repository, or at the location pointed to by the mailmap.file or mailmap.blob configuration options, it is used to map author and committer names and email addresses to canonical real names and email addresses.

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. For example:

Proper Name <[email protected]>

The more complex forms are:

which allows mailmap to replace only the email part of a commit, and:

which allows mailmap to replace both the name and the email of a commit matching the specified commit email address, and:

Proper Name <[email protected]> Commit Name <[email protected]>

which allows mailmap to replace both the name and the email of a commit matching both the specified commit name and email address.

Example 1: Your history contains commits by two authors, Jane and Joe, whose names appear in the repository under several forms:

Joe Developer <[email protected]>
Joe R. Developer <[email protected]>
Jane Doe <[email protected]>
Jane Doe <[email protected](none)>
Jane D. <[email protected](none)>

Now suppose that Joe wants his middle name initial used, and Jane prefers her family name fully spelled out. A proper .mailmap file would look like:

Jane Doe         <[email protected](none)>
Joe R. Developer <[email protected]>

Note how there is no need for an entry for <[email protected](none)>, because the real name of that author is already correct.

Example 2: Your repository contains commits from the following authors:

Then you might want a .mailmap file that looks like:

Use hash # for comments that are either on their own line, or after the email address.

© 2012–2018 Scott Chacon and others
Licensed under the MIT License.
https://git-scm.com/docs/git-check-mailmap