git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 3/3] gitmailmap.txt: fix rendering of e-mail addresses

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Feb 17, 2021, 19:56 UTC
Message-ID
<ee0422ac399daf43a7adcc2b662b50312da04631.1613590761.git.martin.agren@gmail.com>
In-Reply-To
<cover.1613590761.git.martin.agren@gmail.com>

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>
---
 doc-diff:
 --- a/97c686dd7ba1bbd1c0be6f7f61a3a033adf8adb6-asciidoctor-cut-footer/home/martin/share/man/man5/gitmailmap.5
 +++ b/ee0422ac399daf43a7adcc2b662b50312da04631-asciidoctor-cut-footer/home/martin/share/man/man5/gitmailmap.5
 @@ -40,9 +40,9 @@ SYNTAX
         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[1]> above:
 +       would also match the Commit Name <commit@email.xx> above:
 
 -       Proper Name <proper@email.xx[2]> CoMmIt NaMe <CoMmIt@EmAiL.xX[3]>
 +           Proper Name <proper@email.xx> CoMmIt NaMe <CoMmIt@EmAiL.xX>
 
  EXAMPLES
         Your history contains commits by two authors, Jane and Joe, whose names
 @@ -62,11 +62,10 @@ EXAMPLES
             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@laptop.(none)> to
         only correct the names. However, leaving the obviously broken
 -       <jane@laptop.(none)>' and '<jane@desktop.(none)>' E-Mails as-is is
 -       usually not what you want. A `.mailmap file which also corrects those
 -       is:
 +       <jane@laptop.(none)> and <jane@desktop.(none)> E-Mails as-is is usually
 +       not what you want. A .mailmap file which also corrects those is:
 
             Joe R. Developer <joe@example.com>
             Jane Doe <jane@example.com> <jane@laptop.(none)>
 @@ -93,13 +92,3 @@ SEE ALSO
 
  GIT
         Part of the git(1) suite
 -
 -NOTES
 -        1. commit@email.xx
 -           mailto:commit@email.xx
 -
 -        2. proper@email.xx
 -           mailto:proper@email.xx
 -
 -        3. CoMmIt@EmAiL.xX
 -           mailto:CoMmIt@EmAiL.xX
 Documentation/gitmailmap.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/gitmailmap.txt b/Documentation/gitmailmap.txt
index 052209b33b..3fb39f801f 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:
 
-- 
2.30.0.284.gd98b1dd5ea
Previous: Martin ÅgrenNext: Ævar Arnfjörð Bjarmason
Message 10 of 12 in “fix some doc rendering issues since v2.30.0”
  1. 0/3 fix some doc rendering issues since v2.30.0Martin Ågren, Feb 17, 2021
  2. 1/3 rev-list-options.txt: fix rendering of bonus paragraphMartin Ågren, Feb 17, 2021
  3. 2/3 git.txt: fix monospace renderingMartin Ågren, Feb 17, 2021
  4. Chris TorekFeb 17, 2021
  5. Martin ÅgrenFeb 18, 2021
  6. Patrick SteinhardtFeb 18, 2021
  7. Martin ÅgrenFeb 18, 2021
  8. Junio C HamanoFeb 18, 2021
  9. Martin ÅgrenFeb 19, 2021
  10. 3/3 gitmailmap.txt: fix rendering of e-mail addressesMartin Ågren, Feb 17, 2021
  11. Ævar Arnfjörð BjarmasonFeb 18, 2021
  12. Junio C HamanoFeb 17, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.