Re: [PATCH] Documentation: don't link to example mail addresses

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 17, 2012, 05:29 UTC
Message-ID: <7vobhtnt57.fsf@alter.siamese.dyndns.org>
In-Reply-To: <20121215150314.GC2725@river.lan>

John Keeping <john@keeping.me.uk> writes:

> I can't see any other uses of the "$$" quote in the documentation, so
> it's probably worth noting that I've tested this with Asciidoc 8.6.8,
> although I can't see anything in the changelog to indicate that
> Asciidoc's treatment of it has changed recently.

Thanks.

Show 18 quoted lines

>  Documentation/git-fast-import.txt | 2 +-
>  Documentation/git-tag.txt         | 2 +-
>  Documentation/mailmap.txt         | 2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
> index d1844ea..05913cc 100644
> --- a/Documentation/git-fast-import.txt
> +++ b/Documentation/git-fast-import.txt
> @@ -427,7 +427,7 @@ they made it.
>  
>  Here `<name>` is the person's display name (for example
>  ``Com M Itter'') and `<email>` is the person's email address
> -(``cm@example.com'').  `LT` and `GT` are the literal less-than (\x3c)
> +(``$$cm@example.com$$'').  `LT` and `GT` are the literal less-than (\x3c)
>  and greater-than (\x3e) symbols.  These are required to delimit
>  the email address from the other fields in the line.  Note that
>  `<name>` and `<email>` are free-form and may contain any sequence

AsciiDoc 8.5.2 gives this:

    asciidoc: WARNING: git-fast-import.txt: line 434: nested inline passthrough

Also in git-fast-import.1, there is this line:

    ... person\(cqs display name (for example `Com M Itter\(aq\(aq) and `<ema...

(notice two leftover `s); not that this is a new issue with this patch.

Which is puzzling, because the next input line formats better:

    ...  email address (\(lqcm@example\&.com\(rq)\&. ...

Other two hunks for git-tag and mailmap seem to give us a better results.