Skip to content

Commit

Permalink
Merge branch 'jk/sendemail-mailmap-doc'
Browse files Browse the repository at this point in the history
Docfix.

* jk/sendemail-mailmap-doc:
  send-email: document --mailmap and associated configuration
  • Loading branch information
gitster committed Sep 26, 2024
2 parents f92c61a + 7ffcbaf commit 1522467
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Documentation/config/sendemail.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,21 @@ sendemail.confirm::
in the linkgit:git-send-email[1] documentation for the meaning of these
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::
To avoid typing long email addresses, point this to one or more
email aliases files. You must also supply `sendemail.aliasFileType`.
Expand Down
6 changes: 6 additions & 0 deletions Documentation/git-send-email.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
~~~~~~~~~~~~~
Expand Down

0 comments on commit 1522467

Please sign in to comment.