| Message ID | ee0422ac399daf43a7adcc2b662b50312da04631.1613590761.git.martin.agren@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | f89f46b704c168657e80a8d4097aa7f858f58081 |
| Headers | show |
| Series | fix some doc rendering issues since v2.30.0 | expand |
On Wed, Feb 17 2021, Martin Ågren wrote: > 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. THanks a lot for the fix & cleaning up my mess. This LGTM.
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:
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(-)