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. Thus, looks like
-this
+commit (enclosed by '<' and '>') to map to the name. For example:
--
Proper Name <commit@email.xx>
--
-The more complex forms are
+The more complex forms are:
--
<proper@email.xx> <commit@email.xx>
--
-which allows mailmap to replace only the email part of a commit, and
+which allows mailmap to replace only the email part of a commit, and:
--
Proper Name <proper@email.xx> <commit@email.xx>
--
which allows mailmap to replace both the name and the email of a
-commit matching the specified commit email address, and
+commit matching the specified commit email address, and:
--
Proper Name <proper@email.xx> Commit Name <commit@email.xx>
--
Joe R. Developer <joe@example.com>
------------
-Note how we don't need an entry for <jane@laptop.(none)>, because the
-real name of that author is correct already.
+Note how there is no need for an entry for <jane@laptop.(none)>, because the
+real name of that author is already correct.
Example 2: Your repository contains commits from the following
authors:
CTO <cto@coompany.xx>
------------
-Then, you might want a `.mailmap` file looking like:
+Then you might want a `.mailmap` file that looks like:
------------
<cto@company.xx> <cto@coompany.xx>
Some Dude <some@dude.xx> nick1 <bugs@company.xx>
------------
Use hash '#' for comments that are either on their own line, or after
-the email address.
\ No newline at end of file
+the email address.