Re: A typesetting problem with git man pages

From: Jeff King <peff@peff.net>
Date: Oct 29, 2008, 19:39 UTC
Message-ID: <20081029193958.GA12856@sigill.intra.peff.net>
In-Reply-To: <87skqfus7v.fsf@iki.fi>

On Wed, Oct 29, 2008 at 09:16:52PM +0200, Teemu Likonen wrote:

> I compile git and its man pages myself and I just noticed that the man
> pages (invoked with "git help log", for example) have a typesetting
> problem. There are ".ft" commands here and there, like this:

I think this is Yet Another docbook or asciidoc issue. The resulting XML from asciidoc is:

  <literallayout>
  &#10;.ft C&#10;
  ... the actual example contents ...
  &#10;.ft&#10;
  </literallayout>

which kind of seems wrong to me, since it implies that that is part of the literal layout, and would be subject to quoting. It gets rendered into git-log.1 as:

  \&.ft C
  ... the actual examples contents
  \&.ft

so the problem is the extra \&. But I don't know why that is being generated. It _should_ be part of the character entity, I thought, but xmlto seems to be rendering it as the newline character entity _plus_ the ampersand.

So it seems like a bug to me in the XML parser, but it is more likely that I'm somehow clueless about XML.

-Peff