git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Gustaf Hendeby <hendeby@isy.liu.se>
To: Git Mailing List <git@vger.kernel.org>
Subject: Problem with git shortlog documentation
Date: Sun, 23 Dec 2007 15:16:00 +0100	[thread overview]
Message-ID: <476E6DA0.9000908@isy.liu.se> (raw)

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

             reply	other threads:[~2007-12-23 14:16 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-12-23 14:16 Gustaf Hendeby [this message]
2007-12-23 17:18 ` Problem with git shortlog documentation Jeff King
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=476E6DA0.9000908@isy.liu.se \
    --to=hendeby@isy.liu.se \
    --cc=git@vger.kernel.org \
    /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).