Skip to content

Commit 42957af

Browse files
avargitster
authored andcommitted
mailmap doc: create a new "gitmailmap(5)" man page
Create a gitmailmap(5) page similar to how .gitmodules and .gitignore have their own pages at gitmodules(5) and gitignore(5). Now instead of "check-mailmap", "blame" and "shortlog" documentation including the description of the format we link to one canonical place. This makes things easier for readers, since in our manpage or web-based[1] output it's not clear that the "MAPPING AUTHORS" sections aren't subtly different, as opposed to just included. 1. https://git-scm.com/docs/git-check-mailmap Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 72c4083 commit 42957af

File tree

6 files changed

+38
-7
lines changed

6 files changed

+38
-7
lines changed

Documentation/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ MAN1_TXT += gitweb.txt
2121
MAN5_TXT += gitattributes.txt
2222
MAN5_TXT += githooks.txt
2323
MAN5_TXT += gitignore.txt
24+
MAN5_TXT += gitmailmap.txt
2425
MAN5_TXT += gitmodules.txt
2526
MAN5_TXT += gitrepository-layout.txt
2627
MAN5_TXT += gitweb.conf.txt

Documentation/git-blame.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ commit commentary), a blame viewer will not care.
226226
MAPPING AUTHORS
227227
---------------
228228

229-
include::mailmap.txt[]
229+
See linkgit:gitmailmap[5].
230230

231231

232232
SEE ALSO

Documentation/git-check-mailmap.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ printed; otherwise only ``$$<user@host>$$'' is printed.
3939
MAPPING AUTHORS
4040
---------------
4141

42-
include::mailmap.txt[]
42+
See linkgit:gitmailmap[5].
4343

4444

4545
GIT

Documentation/git-shortlog.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,7 @@ include::rev-list-options.txt[]
111111
MAPPING AUTHORS
112112
---------------
113113

114-
The `.mailmap` feature is used to coalesce together commits by the same
115-
person in the shortlog, where their name and/or email address was
116-
spelled differently.
117-
118-
include::mailmap.txt[]
114+
See linkgit:gitmailmap[5].
119115

120116
GIT
121117
---

Documentation/mailmap.txt renamed to Documentation/gitmailmap.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
1+
gitmailmap(5)
2+
=============
3+
4+
NAME
5+
----
6+
gitmailmap - Map author/committer names and/or E-Mail addresses
7+
8+
SYNOPSIS
9+
--------
10+
$GIT_WORK_DIR/.mailmap
11+
12+
13+
DESCRIPTION
14+
-----------
15+
116
If the file `.mailmap` exists at the toplevel of the repository, or at
217
the location pointed to by the mailmap.file or mailmap.blob
318
configuration options, it
419
is used to map author and committer names and email addresses to
520
canonical real names and email addresses.
621

22+
23+
SYNTAX
24+
------
25+
726
In the simple form, each line in the file consists of the canonical
827
real name of an author, whitespace, and an email address used in the
928
commit (enclosed by '<' and '>') to map to the name. For example:
@@ -27,6 +46,10 @@ commit matching the specified commit email address, and:
2746
which allows mailmap to replace both the name and the email of a
2847
commit matching both the specified commit name and email address.
2948

49+
50+
EXAMPLES
51+
--------
52+
3053
Example 1: Your history contains commits by two authors, Jane
3154
and Joe, whose names appear in the repository under several forms:
3255

@@ -73,3 +96,13 @@ Santa Claus <[email protected]> <[email protected]>
7396

7497
Use hash '#' for comments that are either on their own line, or after
7598
the email address.
99+
100+
101+
SEE ALSO
102+
--------
103+
linkgit:git-check-mailmap[1]
104+
105+
106+
GIT
107+
---
108+
Part of the linkgit:git[1] suite

command-list.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ gitfaq guide
204204
gitglossary guide
205205
githooks guide
206206
gitignore guide
207+
gitmailmap guide
207208
gitmodules guide
208209
gitnamespaces guide
209210
gitremote-helpers guide

0 commit comments

Comments
 (0)