summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMartin Ågren <martin.agren@gmail.com>2021-02-17 19:56:06 (GMT)
committerJunio C Hamano <gitster@pobox.com>2021-02-18 18:53:33 (GMT)
commitf89f46b704c168657e80a8d4097aa7f858f58081 (patch)
tree1e994bcde67105e48d6bc1379a0ea7e8e478daea /Documentation
parent83171ede2229b71ef46cd4d2f800c1eef27cc511 (diff)
downloadgit-f89f46b704c168657e80a8d4097aa7f858f58081.zip
git-f89f46b704c168657e80a8d4097aa7f858f58081.tar.gz
git-f89f46b704c168657e80a8d4097aa7f858f58081.tar.bz2
gitmailmap.txt: fix rendering of e-mail addresses
Both AsciiDoc and Asciidoctor are eager to pick up the e-mail addresses in this document and turn them into references at the bottom of the manpage / clickable links. We don't really need that for these dummy addresses. Spell "@" as "&#64;" to make them not do this. In the open block, we can instead avoid this by indenting the contents, similar to the earlier blocks. Fix a backtick which should have been a single quote mark. With all the quoting that is going on around here, this mistake trips up the parsing and rendering quite a bit. Before this commit, we have the same failure mode with AsciiDoc 8.6.10 and Asciidoctor 1.5.5, and this change makes both of them happy. Signed-off-by: Martin Ågren <martin.agren@gmail.com> Acked-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/gitmailmap.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/gitmailmap.txt b/Documentation/gitmailmap.txt
index 052209b..3fb39f8 100644
--- a/Documentation/gitmailmap.txt
+++ b/Documentation/gitmailmap.txt
@@ -50,9 +50,9 @@ which allows mailmap to replace both the name and the email of a
commit matching both the specified commit name and email address.
Both E-Mails and names are matched case-insensitively. For example
-this would also match the 'Commit Name <commit@email.xx>' above:
+this would also match the 'Commit Name <commit&#64;email.xx>' above:
--
-Proper Name <proper@email.xx> CoMmIt NaMe <CoMmIt@EmAiL.xX>
+ Proper Name <proper@email.xx> CoMmIt NaMe <CoMmIt@EmAiL.xX>
--
EXAMPLES
@@ -79,9 +79,9 @@ Jane Doe <jane@example.com>
Jane Doe <jane@desktop.(none)>
------------
-Note that there's no need to map the name for 'jane@laptop.(none)' to
+Note that there's no need to map the name for '<jane&#64;laptop.(none)>' to
only correct the names. However, leaving the obviously broken
-`<jane@laptop.(none)>' and '<jane@desktop.(none)>' E-Mails as-is is
+'<jane&#64;laptop.(none)>' and '<jane&#64;desktop.(none)>' E-Mails as-is is
usually not what you want. A `.mailmap` file which also corrects those
is: