diff options
| author | John Keeping <john@keeping.me.uk> | 2012-12-16 14:00:29 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-12-17 01:59:07 (GMT) |
| commit | f430ed8b9991769073bf3095702f8e8801b365fc (patch) | |
| tree | 45f29760739684ebfd3ba04fea96eb91bc1ad00d /Documentation/git-tag.txt | |
| parent | bdd478d620034dc6517aea940f5dc6b88f780c04 (diff) | |
| download | git-f430ed8b9991769073bf3095702f8e8801b365fc.zip git-f430ed8b9991769073bf3095702f8e8801b365fc.tar.gz git-f430ed8b9991769073bf3095702f8e8801b365fc.tar.bz2 | |
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/git-tag.txt')
| -rw-r--r-- | Documentation/git-tag.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 247534e..6470cff 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -129,7 +129,7 @@ This option is only applicable when listing tags without annotation lines. CONFIGURATION ------------- By default, 'git tag' in sign-with-default mode (-s) will use your -committer identity (of the form "Your Name <your@email.address>") to +committer identity (of the form "Your Name <\your@email.address>") to find a key. If you want to use a different default key, you can specify it in the repository configuration as follows: |