From: Thomas Rast <trast@student.ethz.ch>
To: Jeff King <peff@peff.net>
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Thomas Rast" <trast@student.ethz.ch>,
"Carlos Martín Nieto" <cmn@elego.de>,
"Matthieu Moy" <Matthieu.Moy@imag.fr>,
git@vger.kernel.org
Subject: Re: [PATCH] docs: stop using asciidoc no-inline-literal
Date: Thu, 26 Apr 2012 15:09:51 +0200 [thread overview]
Message-ID: <87obqe8wrk.fsf@thomas.inf.ethz.ch> (raw)
In-Reply-To: <20120426125014.GB25067@sigill.intra.peff.net> (Jeff King's message of "Thu, 26 Apr 2012 08:50:14 -0400")
Jeff King <peff@peff.net> 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)
>> -and greater-than (\x3e) symbols. These are required to delimit
>> +`Com M Itter`) and `<email>` is the person's email address
>> +(`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
>> of bytes, except `LT`, `GT` and `LF`. `<name>` is typically UTF-8 encoded.
>>
>> On my box (asciidoc 8.4.5) the preimage renders as
>>
>> `Com M Itter''
>
> Sorry, do you mean that it is screwed up only after my patch, or that in
> reviewing, you noticed that it is always screwed up?
The markup has always had this form, but I can't tell if it's just my
version of asciidoc that makes a mess of it, or a general problem. [1]
has a correctly formatted copy so that would suggest a narrower problem.
> Yeah, I ran into some weird stuff, too. The gitweb.conf doc behaves
> oddly with `$projname`; I solved it by using "+" to use a teletype face
> without making it literal (since it doesn't actually have any asciidoc
> metacharacters).
>
> Even though I carefully reviewed the output before and after my patch,
> it makes me slightly concerned that somebody with a different asciidoc
> version will get different results. On the other hand, it's nice to
> clean up a mess, so I'm willing to try it and see if we get any bug
> reports.
Your change should _reduce_ the number of places it can break, since the
interpretation of `..` becomes _simpler_. If it really turns out to
vary wildly afterwards, I'd suggest changing to some other markup
format.
[1] http://cs.swan.ac.uk/~csoliver/ok-sat-library/internet_html/doc/doc/Git/1.7.8.4/Documentation/git-fast-import.html
--
Thomas Rast
trast@{inf,student}.ethz.ch
prev parent reply other threads:[~2012-04-26 13:10 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-04-26 8:51 [PATCH] docs: stop using asciidoc no-inline-literal Jeff King
2012-04-26 9:03 ` Jeff King
2012-04-26 9:09 ` Matthieu Moy
2012-04-26 9:13 ` Jeff King
2012-04-26 9:42 ` Thomas Rast
2012-04-26 9:50 ` Thomas Rast
2012-04-26 12:50 ` Jeff King
2012-04-26 13:09 ` Thomas Rast [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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87obqe8wrk.fsf@thomas.inf.ethz.ch \
--to=trast@student.ethz.ch \
--cc=Matthieu.Moy@imag.fr \
--cc=cmn@elego.de \
--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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.