Thread (4 messages) flat view 4 messages, 2 authors, 2016-06-15

Problem with git shortlog documentation

From: Gustaf Hendeby <hidden>
Date: 2016-06-15 22:44:01
Subsystem: documentation, the rest · Maintainers: Jonathan Corbet, Linus Torvalds

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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help