git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: John Keeping <john@keeping.me.uk>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Jeff King <peff@peff.net>
Subject: Re: [PATCH] Documentation: don't link to example mail addresses
Date: Mon, 17 Dec 2012 09:44:46 +0000	[thread overview]
Message-ID: <20121217094446.GA24036@river.lan> (raw)
In-Reply-To: <7vobhtnt57.fsf@alter.siamese.dyndns.org>

On Sun, Dec 16, 2012 at 09:29:24PM -0800, Junio C Hamano wrote:
> John Keeping <john@keeping.me.uk> writes:
>>  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)\&. ...

I wonder if you're hitting this bug, which is listed as fixed in
AsciiDoc 8.6.0 [1]:

    FIXED: Sometimes multiple double quoted text elements in the same
    paragraph were mistakenly seen as starting with an inline literal.

As you said in your other message, it may be better to avoid using the
pretty quotes, although I don't think just changing them to `monospace
output` is sufficient as monospace output is not distinguished in the
default man page output.  IMHO that's necessary for any examples that
contain whitespace.  Perhaps a patch series turning MAN_BOLD_LITERAL on
by default and then changing these examples to `monospace output`?


John

[1] http://www.methods.co.nz/asciidoc/CHANGELOG.html#_version_8_6_0_2010_08_16

      reply	other threads:[~2012-12-17  9:45 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-12-15 15:03 [PATCH] Documentation: don't link to example mail addresses John Keeping
2012-12-15 17:20 ` Jeff King
2012-12-15 18:00   ` Junio C Hamano
2012-12-15 18:24   ` John Keeping
2012-12-16 12:04     ` Jeff King
2012-12-16 14:00       ` [PATCH v2] " John Keeping
2012-12-16 18:48         ` Junio C Hamano
2012-12-17  2:24         ` Junio C Hamano
2012-12-17 12:02           ` Jeff King
2012-12-17 19:57             ` Junio C Hamano
2012-12-17  5:29 ` [PATCH] " Junio C Hamano
2012-12-17  9:44   ` John Keeping [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20121217094446.GA24036@river.lan \
    --to=john@keeping.me.uk \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).