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 <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Jan 12, 2021 at 21:17 UTC
42957af0273a338de232a6a0071a3ddcf92f9fee
6 files changed
+38
-7
Documentation/Makefile
+1
@@ -21,6 +21,7 @@ MAN1_TXT += gitweb.txt
21
MAN5_TXT += gitattributes.txt
22
MAN5_TXT += githooks.txt
23
MAN5_TXT += gitignore.txt
24
+MAN5_TXT += gitmailmap.txt
25
MAN5_TXT += gitmodules.txt
26
MAN5_TXT += gitrepository-layout.txt
27
MAN5_TXT += gitweb.conf.txt
Documentation/git-blame.txt
+1
-1
@@ -226,7 +226,7 @@ commit commentary), a blame viewer will not care.
226
MAPPING AUTHORS
227
---------------
228
229
-include::mailmap.txt[]
229
+See linkgit:gitmailmap[5].
230
231
232
SEE ALSO
Documentation/git-check-mailmap.txt
+1
-1
@@ -39,7 +39,7 @@ printed; otherwise only ``$$<user@host>$$'' is printed.
39
MAPPING AUTHORS
40
---------------
41
42
-include::mailmap.txt[]
42
+See linkgit:gitmailmap[5].
43
44
45
GIT
Documentation/git-shortlog.txt
+1
-5
@@ -111,11 +111,7 @@ include::rev-list-options.txt[]
111
MAPPING AUTHORS
112
---------------
113
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].
115
116
GIT
117
---
Documentation/gitmailmap.txt
renamed
+33
@@ -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
+
16
If the file `.mailmap` exists at the toplevel of the repository, or at
17
the location pointed to by the mailmap.file or mailmap.blob
18
configuration options, it
19
is used to map author and committer names and email addresses to
20
canonical real names and email addresses.
21
22
+
23
+SYNTAX
24
+------
25
+
26
In the simple form, each line in the file consists of the canonical
27
real name of an author, whitespace, and an email address used in the
28
commit (enclosed by '<' and '>') to map to the name. For example:
@@ -27,6 +46,10 @@ commit matching the specified commit email address, and:
46
which allows mailmap to replace both the name and the email of a
47
commit matching both the specified commit name and email address.
48
49
+
50
+EXAMPLES
51
+--------
52
+
53
Example 1: Your history contains commits by two authors, Jane
54
and Joe, whose names appear in the repository under several forms:
55
@@ -73,3 +96,13 @@ Santa Claus <santa.claus@northpole.xx> <me@company.xx>
96
97
Use hash '#' for comments that are either on their own line, or after
98
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
+1
@@ -204,6 +204,7 @@ gitfaq guide
204
gitglossary guide
205
githooks guide
206
gitignore guide
207
+gitmailmap guide
208
gitmodules guide
209
gitnamespaces guide
210
gitremote-helpers guide