git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] docs: stop using asciidoc no-inline-literal

From
Thomas Rast <trast@student.ethz.ch>
Date
Apr 26, 2012, 13:09 UTC
Message-ID
<87obqe8wrk.fsf@thomas.inf.ethz.ch>
In-Reply-To
<20120426125014.GB25067@sigill.intra.peff.net>
Jeff King <peff@peff.net> writes:
Show 17 quoted lines
>>  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.

Show 10 quoted lines
> 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
Previous: Jeff King
Message 8 of 8 in “docs: stop using asciidoc no-inline-literal”
  1. docs: stop using asciidoc no-inline-literalJeff King, Apr 26, 2012
  2. Jeff KingApr 26, 2012
  3. Matthieu MoyApr 26, 2012
  4. Jeff KingApr 26, 2012
  5. Thomas RastApr 26, 2012
  6. Thomas RastApr 26, 2012
  7. Jeff KingApr 26, 2012
  8. Thomas RastApr 26, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.