threads / patch / 62180

patchsend-email: document --mailmap and associated configuration

Subject: [PATCH] send-email: document --mailmap and associated configuration

## tl;dr

6 messages between Sep 23, 2024 and Sep 24, 2024. Diffs are folded; open one to read it.

replies: 5people: 2as markdown or json

Jacob Keller· Sep 23, 2024, 22:24 UTC · lore

From: Jacob Keller <jacob.keller@gmail.com>

241499aba007 ("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: 241499aba007 ("send-email: add mailmap support via sendemail.mailmap and --mailmap")
Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
---
 Documentation/config/sendemail.txt | 15 +++++++++++++++
 Documentation/git-send-email.txt   |  6 ++++++
 2 files changed, 21 insertions(+)

Show changes to 2 files +21 −0

Documentation/config/sendemail.txt, Documentation/git-send-email.txt

diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.txt
index 6a869d67eb90..14a58b3749e2 100644
--- a/Documentation/config/sendemail.txt
+++ b/Documentation/config/sendemail.txt
@@ -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:git-mailmap[1].
+
+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:git-mailmap[1].
+
 sendemail.aliasesFile::
 	To avoid typing long email addresses, point this to one or more
 	email aliases files.  You must also supply `sendemail.aliasFileType`.
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 2e6f1d63ae4a..dc5b122bb8e6 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -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:git-mailmap[1]) 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
 ~~~~~~~~~~~~~

-- 
2.46.2.828.g9e56e24342b6

Junio C Hamano· Sep 24, 2024, 05:29 UTC · re: Jacob Keller · lore

Re: [PATCH] send-email: document --mailmap and associated configuration

Jacob Keller <jacob.e.keller@intel.com> writes:

Show 6 quoted lines

> From: Jacob Keller <jacob.keller@gmail.com>
>
> 241499aba007 ("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.

Makes sense.  Thanks.  Will queue.

Junio C Hamano· Sep 24, 2024, 21:41 UTC · re: Jacob Keller · lore

Re: [PATCH] send-email: document --mailmap and associated configuration

Jacob Keller <jacob.e.keller@intel.com> writes:

> +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:git-mailmap[1].

No such documentation page git-mailmap[1] exists, hence this breaks "make check-docs".

Junio C Hamano· Sep 24, 2024, 21:45 UTC · re: Junio C Hamano · lore

Re: [PATCH] send-email: document --mailmap and associated configuration

Junio C Hamano <gitster@pobox.com> writes:

Show 9 quoted lines

> Jacob Keller <jacob.e.keller@intel.com> writes:
>
>> +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:git-mailmap[1].
>
> No such documentation page git-mailmap[1] exists, hence this breaks
> "make check-docs".

IOW linkgit:git-mailmap[1] -> linkgit:gitmailmap[5] everywhere. I did that while requeuing and reintegrating 'seen' for today's pushout, so unless there are other things to be updated, no need to resend.

Thanks.

Keller, Jacob E· Sep 24, 2024, 23:15 UTC · re: Junio C Hamano · lore

RE: [PATCH] send-email: document --mailmap and associated configuration

Show 26 quoted lines

> -----Original Message-----
> From: Junio C Hamano <gitster@pobox.com>
> Sent: Tuesday, September 24, 2024 2:45 PM
> To: Keller, Jacob E <jacob.e.keller@intel.com>
> Cc: git@vger.kernel.org; Jacob Keller <jacob.keller@gmail.com>
> Subject: Re: [PATCH] send-email: document --mailmap and associated
> configuration
> 
> Junio C Hamano <gitster@pobox.com> writes:
> 
> > Jacob Keller <jacob.e.keller@intel.com> writes:
> >
> >> +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:git-mailmap[1].
> >
> > No such documentation page git-mailmap[1] exists, hence this breaks
> > "make check-docs".
> 
> IOW linkgit:git-mailmap[1] -> linkgit:gitmailmap[5] everywhere.  I
> did that while requeuing and reintegrating 'seen' for today's
> pushout, so unless there are other things to be updated, no need to
> resend.
> 
> Thanks.

Ah, yes. Thanks for fixing!

Junio C Hamano· Sep 24, 2024, 23:23 UTC · re: Keller, Jacob E · lore

Re: [PATCH] send-email: document --mailmap and associated configuration

"Keller, Jacob E" <jacob.e.keller@intel.com> writes:

Show 28 quoted lines

>> -----Original Message-----
>> From: Junio C Hamano <gitster@pobox.com>
>> Sent: Tuesday, September 24, 2024 2:45 PM
>> To: Keller, Jacob E <jacob.e.keller@intel.com>
>> Cc: git@vger.kernel.org; Jacob Keller <jacob.keller@gmail.com>
>> Subject: Re: [PATCH] send-email: document --mailmap and associated
>> configuration
>> 
>> Junio C Hamano <gitster@pobox.com> writes:
>> 
>> > Jacob Keller <jacob.e.keller@intel.com> writes:
>> >
>> >> +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:git-mailmap[1].
>> >
>> > No such documentation page git-mailmap[1] exists, hence this breaks
>> > "make check-docs".
>> 
>> IOW linkgit:git-mailmap[1] -> linkgit:gitmailmap[5] everywhere.  I
>> did that while requeuing and reintegrating 'seen' for today's
>> pushout, so unless there are other things to be updated, no need to
>> resend.
>> 
>> Thanks.
>
> Ah, yes. Thanks for fixing!

Thanks for updating the documentation.