diff options
| author | John Keeping <john@keeping.me.uk> | 2012-12-16 14:00:29 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-12-16 17:59:07 -0800 |
| commit | f430ed8b9991769073bf3095702f8e8801b365fc (patch) | |
| tree | 45f29760739684ebfd3ba04fea96eb91bc1ad00d /Documentation/mailmap.txt | |
| parent | bdd478d620034dc6517aea940f5dc6b88f780c04 (diff) | |
| download | git-f430ed8b9991769073bf3095702f8e8801b365fc.tar.gz | |
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>
Diffstat (limited to 'Documentation/mailmap.txt')
| -rw-r--r-- | Documentation/mailmap.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/mailmap.txt b/Documentation/mailmap.txt index 288f04e70c..dd89fca3f8 100644 --- a/Documentation/mailmap.txt +++ b/Documentation/mailmap.txt @@ -46,7 +46,7 @@ Jane Doe <jane@desktop.(none)> Joe R. Developer <joe@example.com> ------------ -Note how there is no need for an entry for <jane@laptop.(none)>, because the +Note how there is no need for an entry for `<jane@laptop.(none)>`, because the real name of that author is already correct. Example 2: Your repository contains commits from the following |