{ "content": [ { "type": "text", "text": "# GITMAILMAP (man)\n\n## NAME\n\ngitmailmap - Map author/committer names and/or E-Mail addresses\n\n## SYNOPSIS\n\n$GITWORKTREE/.mailmap\n\n## DESCRIPTION\n\nIf the file .mailmap exists at the toplevel of the repository, or at the location pointed to\nby the mailmap.file or mailmap.blob configuration options (see git-config(1)), it is used to\nmap author and committer names and email addresses to canonical real names and email\naddresses.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **SYNTAX**\n- **NOTES**\n- **EXAMPLES**\n- **SEE ALSO**\n- **GIT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "GITMAILMAP", "section": "", "mode": "man", "summary": "gitmailmap - Map author/committer names and/or E-Mail addresses", "synopsis": "$GITWORKTREE/.mailmap", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [ "Your history contains commits by two authors, Jane and Joe, whose names appear in the", "repository under several forms:", "Joe Developer ", "Joe R. Developer ", "Jane Doe ", "Jane Doe ", "Jane D. ", "Now suppose that Joe wants his middle name initial used, and Jane prefers her family name", "fully spelled out. A .mailmap file to correct the names would look like:", "Joe R. Developer ", "Jane Doe ", "Jane Doe ", "Note that there’s no need to map the name for to only correct the names.", "However, leaving the obviously broken and E-Mails", "as-is is usually not what you want. A .mailmap file which also corrects those is:", "Joe R. Developer ", "Jane Doe ", "Jane Doe ", "Finally, let’s say that Joe and Jane shared an E-Mail address, but not a name, e.g. by having", "these two commits in the history generated by a bug reporting system. I.e. names appearing in", "history as:", "Joe ", "Jane ", "A full .mailmap file which also handles those cases (an addition of two lines to the above", "example) would be:", "Joe R. Developer ", "Jane Doe ", "Jane Doe ", "Joe R. Developer Joe ", "Jane Doe Jane " ], "see_also": [ { "name": "git-check-mailmap", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/git-check-mailmap/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 5, "subsections": [] }, { "name": "SYNTAX", "lines": 29, "subsections": [] }, { "name": "NOTES", "lines": 4, "subsections": [] }, { "name": "EXAMPLES", "lines": 45, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "GIT", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "gitmailmap - Map author/committer names and/or E-Mail addresses\n", "subsections": [] }, "SYNOPSIS": { "content": "$GITWORKTREE/.mailmap\n", "subsections": [] }, "DESCRIPTION": { "content": "If the file .mailmap exists at the toplevel of the repository, or at the location pointed to\nby the mailmap.file or mailmap.blob configuration options (see git-config(1)), it is used to\nmap author and committer names and email addresses to canonical real names and email\naddresses.\n", "subsections": [] }, "SYNTAX": { "content": "The # character begins a comment to the end of line, blank lines are ignored.\n\nIn the simple form, each line in the file consists of the canonical real name of an author,\nwhitespace, and an email address used in the commit (enclosed by < and >) to map to the name.\nFor example:\n\nProper Name \n\nThe more complex forms are:\n\n \n\nwhich allows mailmap to replace only the email part of a commit, and:\n\nProper Name \n\nwhich allows mailmap to replace both the name and the email of a commit matching the\nspecified commit email address, and:\n\nProper Name Commit Name \n\nwhich allows mailmap to replace both the name and the email of a commit matching both the\nspecified commit name and email address.\n\nBoth E-Mails and names are matched case-insensitively. For example this would also match the\nCommit Name above:\n\nProper Name CoMmIt NaMe \n", "subsections": [] }, "NOTES": { "content": "Git does not follow symbolic links when accessing a .mailmap file in the working tree. This\nkeeps behavior consistent when the file is accessed from the index or a tree versus from the\nfilesystem.\n", "subsections": [] }, "EXAMPLES": { "content": "Your history contains commits by two authors, Jane and Joe, whose names appear in the\nrepository under several forms:\n\nJoe Developer \nJoe R. Developer \nJane Doe \nJane Doe \nJane D. \n\n\nNow suppose that Joe wants his middle name initial used, and Jane prefers her family name\nfully spelled out. A .mailmap file to correct the names would look like:\n\nJoe R. Developer \nJane Doe \nJane Doe \n\n\nNote that there’s no need to map the name for to only correct the names.\nHowever, leaving the obviously broken and E-Mails\nas-is is usually not what you want. A .mailmap file which also corrects those is:\n\nJoe R. Developer \nJane Doe \nJane Doe \n\n\nFinally, let’s say that Joe and Jane shared an E-Mail address, but not a name, e.g. by having\nthese two commits in the history generated by a bug reporting system. I.e. names appearing in\nhistory as:\n\nJoe \nJane \n\n\nA full .mailmap file which also handles those cases (an addition of two lines to the above\nexample) would be:\n\nJoe R. Developer \nJane Doe \nJane Doe \nJoe R. Developer Joe \nJane Doe Jane \n\n", "subsections": [] }, "SEE ALSO": { "content": "git-check-mailmap(1)\n", "subsections": [] }, "GIT": { "content": "Part of the git(1) suite\n\n\n\nGit 2.34.1 02/26/2026 GITMAILMAP(5)", "subsections": [] } } } }