git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Gustaf Hendeby <hendeby@isy.liu.se>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: Problem with git shortlog documentation
Date: Sun, 23 Dec 2007 12:18:40 -0500	[thread overview]
Message-ID: <20071223171840.GA8799@sigill.intra.peff.net> (raw)
In-Reply-To: <476E6DA0.9000908@isy.liu.se>

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

> 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

  reply	other threads:[~2007-12-23 17:19 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-12-23 14:16 Problem with git shortlog documentation Gustaf Hendeby
2007-12-23 17:18 ` Jeff King [this message]
2007-12-23 18:28   ` Junio C Hamano
2007-12-23 18:34   ` [PATCH] Fix for missing line in man page rendered for git shortlog Gustaf Hendeby
2007-12-23 18:46     ` Jeff King

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=20071223171840.GA8799@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=hendeby@isy.liu.se \
    /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 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 NNTP newsgroup(s).