Problem with git shortlog documentation

Problem with git shortlog documentation

[Gustaf Hendeby]

Hi!

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, ...".

Looking at the webpage version of the man page 
(http://www.kernel.org/pub/software/scm/git/docs/git-shortlog.html) gives 
another version, still not what I had expected: "mailmap::  If this file exists, 
...", which is not much better.

Unfortunately, I'm completely illiterate in asciidoc/xmlto so I have no idea 
where to start to look for a fix for this without changes to the text. 
Hopefully someone else on the list is more knowledgeable.  Or is it maybe better 
to just reformulate this passage slightly to get around the problem?  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:

diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index e14720b..c37ab66 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -38,8 +38,7 @@ OPTIONS
  FILES
  -----

-.mailmap::
-       If this file exists, it will be used for mapping author email
+       If the file .mailmap exists, it will be used for mapping author email
         addresses to a real author name. One mapping per line, first
         the author name followed by the email address enclosed by
         '<' and '>'. Use hash '#' for comments. Example:

/Gustaf

Re: Problem with git shortlog documentation

[Jeff King]

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

Re: Problem with git shortlog documentation

[Junio C Hamano]

I think re-wording is a good enough workaround in this case too.

[PATCH] Fix for missing line in man page rendered for git shortlog

[Gustaf Hendeby]

This is a work around for a asciidoc/xmlto problem with lines starting
with a '.'.  Until a proper fix for this is found, rewrite problematic
sections.

Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se>
Acked-by: Jeff King <peff@peff.net>
---

Jeff King wrote:
> On Sun, Dec 23, 2007 at 03:16:00PM +0100, Gustaf Hendeby wrote:
>
> I mentioned this same issue a few weeks ago:
>
>   <20071211124220.GA17929@sigill.intra.peff.net>

Ah, I missed that one.  Unfortunately, the lack of answers indicate it isn't
trivial to find a general fix to the problem. :(

> 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>

I hope I understood corretly when I added your ACK to the patch.

Thanks,
	Gustaf

 Documentation/git-shortlog.txt |   18 ++++++++----------
 1 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index e14720b..854bf7a 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -37,16 +37,14 @@ OPTIONS
 
 FILES
 -----
-
-.mailmap::
-	If this file exists, it will be used for mapping author email
-	addresses to a real author name. One mapping per line, first
-	the author name followed by the email address enclosed by
-	'<' and '>'. Use hash '#' for comments. Example:
-
-		# Keep alphabetized
-		Adam Morrow <adam@localhost.localdomain>
-		Eve Jones <eve@laptop.(none)>
+If the file .mailmap exists, it will be used for mapping author email
+addresses to a real author name. One mapping per line, first the
+author name followed by the email address enclosed by '<' and '>'. Use
+hash '#' for comments. Example:
+
+	# Keep alphabetized
+	Adam Morrow <adam@localhost.localdomain>
+	Eve Jones <eve@laptop.(none)>
 
 Author
 ------
-- 
1.5.4.rc1.22.g4b71

Re: [PATCH] Fix for missing line in man page rendered for git shortlog

[Jeff King]

On Sun, Dec 23, 2007 at 07:34:51PM +0100, Gustaf Hendeby wrote:

> I hope I understood corretly when I added your ACK to the patch.

Yes, perfectly.

-Peff