mirrors/git
0
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-23 18:05:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

send-email: document --mailmap and associated configuration

Browse Source 
241499aba0 ("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: 241499aba0 ("send-email: add mailmap support via sendemail.mailmap and --mailmap")
Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jacob Keller 2024-09-23 15:24:28 -07:00 committed by Junio C Hamano
parent 6258f68c3c
commit 7ffcbafbf3
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/config/sendemail.txt
View File

@ -30,6 +30,21 @@ sendemail.confirm::
in the linkgit:git-send-email[1] documentation for the meaning of these in the linkgit:git-send-email[1] documentation for the meaning of these
values. values.
sendemail.mailmap::
If true, makes linkgit:git-send-email[1] assume `--mailmap`,
otherwise assume `--no-mailmap`. False by default.
sendemail.mailmap.file::
The location of a linkgit:git-send-email[1] specific augmenting
mailmap file. The default mailmap and `mailmap.file` are loaded
first. Thus, entries in this file take precedence over entries in
the default mailmap locations. See linkgit:gitmailmap[5].
sendemail.mailmap.blob::
Like `sendemail.mailmap.file`, but consider the value as a reference
to a blob in the repository. Entries in `sendemail.mailmap.file`
take precedence over entries here. See linkgit:gitmailmap[5].
sendemail.aliasesFile:: sendemail.aliasesFile::
To avoid typing long email addresses, point this to one or more To avoid typing long email addresses, point this to one or more
email aliases files. You must also supply `sendemail.aliasFileType`. email aliases files. You must also supply `sendemail.aliasFileType`.

6
Documentation/git-send-email.txt
View File

@ -414,6 +414,12 @@ exists when 'git send-email' is asked to add it (especially note that
Failure to do so may not produce the expected result in the Failure to do so may not produce the expected result in the
recipient's MUA. recipient's MUA.
--[no-]mailmap::
Use the mailmap file (see linkgit:gitmailmap[5]) to map all
addresses to their canonical real name and email address. Additional
mailmap data specific to git-send-email may be provided using the
`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
values. Defaults to `sendemail.mailmap`.
Administering Administering
~~~~~~~~~~~~~ ~~~~~~~~~~~~~