From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: "Sergey Organov" <sorganov@gmail.com>,
"Patrick Steinhardt" <ps@pks.im>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH 3/3] gitmailmap.txt: fix rendering of e-mail addresses
Date: Wed, 17 Feb 2021 20:56:06 +0100 [thread overview]
Message-ID: <ee0422ac399daf43a7adcc2b662b50312da04631.1613590761.git.martin.agren@gmail.com> (raw)
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 "@" 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@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@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@laptop.(none)>' and '<jane@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
next prev parent reply other threads:[~2021-02-17 19:57 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-17 19:56 [PATCH 0/3] fix some doc rendering issues since v2.30.0 Martin Ågren
2021-02-17 19:56 ` [PATCH 1/3] rev-list-options.txt: fix rendering of bonus paragraph Martin Ågren
2021-02-17 19:56 ` [PATCH 2/3] git.txt: fix monospace rendering Martin Ågren
2021-02-17 22:47 ` Chris Torek
2021-02-18 6:28 ` Martin Ågren
2021-02-18 6:27 ` Patrick Steinhardt
2021-02-18 6:32 ` Martin Ågren
2021-02-18 18:51 ` Junio C Hamano
2021-02-19 6:33 ` Martin Ågren
2021-02-17 19:56 ` Martin Ågren [this message]
2021-02-18 10:48 ` [PATCH 3/3] gitmailmap.txt: fix rendering of e-mail addresses Ævar Arnfjörð Bjarmason
2021-02-17 21:22 ` [PATCH 0/3] fix some doc rendering issues since v2.30.0 Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ee0422ac399daf43a7adcc2b662b50312da04631.1613590761.git.martin.agren@gmail.com \
--to=martin.agren@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=ps@pks.im \
--cc=sorganov@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).