@matheusbsbs / matheus-bagliano / commits / f430ed8b99

Documentation: don't link to example mail addresses

Email addresses in documentation are converted into mailto: hyperlinks in the HTML output and footnotes in man pages. This isn't desirable for cases where the address is used as an example and is not valid. Particularly annoying is the example "jane@laptop.(none)" which appears in git-shortlog(1) as "jane@laptop[1].(none)", with note 1 saying: 1. jane@laptop mailto:jane@laptop Fix this by escaping these email addresses with a leading backslash, to prevent Asciidoc expanding them as inline macros. In the case of mailmap.txt, render the address monospaced so that it matches the block examples surrounding that paragraph. Helped-by: Jeff King <peff@peff.net> Signed-off-by: John Keeping <john@keeping.me.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>

John Keeping committed Dec 16, 2012 at 14:00 UTC f430ed8b9991769073bf3095702f8e8801b365fc

3 files changed +3 -3

Documentation/git-fast-import.txt

+1 -1

@@ -427,7 +427,7 @@ they made it.

427

428 Here `<name>` is the person's display name (for example

429 ``Com M Itter'') and `<email>` is the person's email address

430 -(``cm@example.com''). `LT` and `GT` are the literal less-than (\x3c)

430 +(``\cm@example.com''). `LT` and `GT` are the literal less-than (\x3c)

431 and greater-than (\x3e) symbols. These are required to delimit

432 the email address from the other fields in the line. Note that

433 `<name>` and `<email>` are free-form and may contain any sequence

Documentation/git-tag.txt

+1 -1

@@ -129,7 +129,7 @@ This option is only applicable when listing tags without annotation lines.

129 CONFIGURATION

130 -------------

131 By default, 'git tag' in sign-with-default mode (-s) will use your

132 -committer identity (of the form "Your Name <your@email.address>") to

132 +committer identity (of the form "Your Name <\your@email.address>") to

133 find a key. If you want to use a different default key, you can specify

134 it in the repository configuration as follows:

135

Documentation/mailmap.txt

+1 -1

@@ -46,7 +46,7 @@ Jane Doe <jane@desktop.(none)>

46 Joe R. Developer <joe@example.com>

47 ------------

49 -Note how there is no need for an entry for <jane@laptop.(none)>, because the

49 +Note how there is no need for an entry for `<jane@laptop.(none)>`, because the

50 real name of that author is already correct.

52 Example 2: Your repository contains commits from the following