Re: Problem with git shortlog documentation

From: Jeff King <peff@peff.net>
Date: Dec 23, 2007, 17:18 UTC
Message-ID: <20071223171840.GA8799@sigill.intra.peff.net>
In-Reply-To: <476E6DA0.9000908@isy.liu.se>

On Sun, Dec 23, 2007 at 03:16:00PM +0100, Gustaf Hendeby wrote:

Show 5 quoted lines

> I was just looking through the documentation for git shortlog, and realized 
> there is a problem with FILES section close to the bottom.  In the version I 
> built of the man page (asciidoc 8.2.1, yes I used the compatibility define) 
> the filename .mailmap is missing, and the text starts with "If this file 
> exists, ...".

I mentioned this same issue a few weeks ago:

  <20071211124220.GA17929@sigill.intra.peff.net>

but got no response. Under modern asciidoc, it the man page looks like this:

.SH "FILES" .PP \.mailmap .RS 4 If this ...

which I would have thought would render fine, but doesn't (though I don't really know troff). Doing " .mailmap" looks OK.

However, the version of the manpages in Junio's origin/man has the awful "Example 1. .mailmap" generated by asciidoc, so it's clearly a bug-prone construct.

I think re-wording is a fine fix, at least for now.

> Something like this (would we then like to reindent this?  it would make the 
> change look much bigger), which seems to work with my asciidoc version:

If by "reindent" you mean not just "wrap the long line" but "the whole paragraph should start at the beginning of the line, since it's no longer part of the list element", then

Acked-by: Jeff King <peff@peff.net>

-Peff