Skip to content

Commit 7ffcbaf

Browse files
jacob-kellergitster
authored andcommitted
send-email: document --mailmap and associated configuration
241499a ("send-email: add mailmap support via sendemail.mailmap and --mailmap", 2024-08-27) added support for --mailmap, and the associated sendemail.mailmap.* configuration variables. Add documentation to reflect this feature. Fixes: 241499a ("send-email: add mailmap support via sendemail.mailmap and --mailmap") Signed-off-by: Jacob Keller <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6258f68 commit 7ffcbaf

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

Documentation/config/sendemail.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ sendemail.confirm::
3030
in the linkgit:git-send-email[1] documentation for the meaning of these
3131
values.
3232

33+
sendemail.mailmap::
34+
If true, makes linkgit:git-send-email[1] assume `--mailmap`,
35+
otherwise assume `--no-mailmap`. False by default.
36+
37+
sendemail.mailmap.file::
38+
The location of a linkgit:git-send-email[1] specific augmenting
39+
mailmap file. The default mailmap and `mailmap.file` are loaded
40+
first. Thus, entries in this file take precedence over entries in
41+
the default mailmap locations. See linkgit:gitmailmap[5].
42+
43+
sendemail.mailmap.blob::
44+
Like `sendemail.mailmap.file`, but consider the value as a reference
45+
to a blob in the repository. Entries in `sendemail.mailmap.file`
46+
take precedence over entries here. See linkgit:gitmailmap[5].
47+
3348
sendemail.aliasesFile::
3449
To avoid typing long email addresses, point this to one or more
3550
email aliases files. You must also supply `sendemail.aliasFileType`.

Documentation/git-send-email.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,12 @@ exists when 'git send-email' is asked to add it (especially note that
414414
Failure to do so may not produce the expected result in the
415415
recipient's MUA.
416416

417+
--[no-]mailmap::
418+
Use the mailmap file (see linkgit:gitmailmap[5]) to map all
419+
addresses to their canonical real name and email address. Additional
420+
mailmap data specific to git-send-email may be provided using the
421+
`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
422+
values. Defaults to `sendemail.mailmap`.
417423

418424
Administering
419425
~~~~~~~~~~~~~

0 commit comments

Comments
 (0)