Skip to content

Commit f430ed8

Browse files
johnkeepinggitster
authored andcommitted
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 <[email protected]> Signed-off-by: John Keeping <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent bdd478d commit f430ed8

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

Documentation/git-fast-import.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ they made it.
427427

428428
Here `<name>` is the person's display name (for example
429429
``Com M Itter'') and `<email>` is the person's email address
430-
(``[email protected]''). `LT` and `GT` are the literal less-than (\x3c)
430+
(``\[email protected]''). `LT` and `GT` are the literal less-than (\x3c)
431431
and greater-than (\x3e) symbols. These are required to delimit
432432
the email address from the other fields in the line. Note that
433433
`<name>` and `<email>` are free-form and may contain any sequence

Documentation/git-tag.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ This option is only applicable when listing tags without annotation lines.
129129
CONFIGURATION
130130
-------------
131131
By default, 'git tag' in sign-with-default mode (-s) will use your
132-
committer identity (of the form "Your Name <[email protected]>") to
132+
committer identity (of the form "Your Name <\[email protected]>") to
133133
find a key. If you want to use a different default key, you can specify
134134
it in the repository configuration as follows:
135135

Documentation/mailmap.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Jane Doe <jane@desktop.(none)>
4646
Joe R. Developer <[email protected]>
4747
------------
4848

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
5050
real name of that author is already correct.
5151

5252
Example 2: Your repository contains commits from the following

0 commit comments

Comments
 (0)