Documentation: don't link to example mail addresses
commitf430ed8b9991769073bf3095702f8e8801b365fc
authorJohn Keeping <john@keeping.me.uk>
Sun, 16 Dec 2012 14:00:29 +0000 (16 14:00 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 17 Dec 2012 01:59:07 +0000 (16 17:59 -0800)
tree45f29760739684ebfd3ba04fea96eb91bc1ad00d
parentbdd478d620034dc6517aea940f5dc6b88f780c04
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>
Documentation/git-fast-import.txt
Documentation/git-tag.txt
Documentation/mailmap.txt