{"thread":{"id":"11394","subject":"Problem with git shortlog documentation","startedAt":"2007-12-23T14:16:00Z","lastAt":"2007-12-23T18:46:35Z","messageCount":5,"participants":["Gustaf Hendeby","Jeff King","Junio C Hamano"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"64041","messageId":"476E6DA0.9000908@isy.liu.se","threadId":"11394","inReplyTo":null,"subject":"Problem with git shortlog documentation","fromName":"Gustaf Hendeby","fromEmail":"hendeby@isy.liu.se","sentAt":"2007-12-23T14:16:00Z","receivedAt":"2007-12-23T14:16:00Z","isPatch":false,"sender":{"key":"hendeby@isy.liu.se","avatar":"https://avatars.githubusercontent.com/u/730316?v=4"},"body":"Hi!\n\nI was just looking through the documentation for git shortlog, and realized \nthere is a problem with FILES section close to the bottom. In the version I \nbuilt of the man page (asciidoc 8.2.1, yes I used the compatibility define) the \nfilename .mailmap is missing, and the text starts with \"If this file exists, ...\".\n\nLooking at the webpage version of the man page \n(http://www.kernel.org/pub/software/scm/git/docs/git-shortlog.html) gives \nanother version, still not what I had expected: \"mailmap:: If this file exists, \n...\", which is not much better.\n\nUnfortunately, I'm completely illiterate in asciidoc/xmlto so I have no idea \nwhere to start to look for a fix for this without changes to the text. \nHopefully someone else on the list is more knowledgeable. Or is it maybe better \nto just reformulate this passage slightly to get around the problem? Something \nlike this (would we then like to reindent this? it would make the change look \nmuch bigger), which seems to work with my asciidoc version:\n\ndiff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt\nindex e14720b..c37ab66 100644\n--- a/Documentation/git-shortlog.txt\n+++ b/Documentation/git-shortlog.txt\n@@ -38,8 +38,7 @@ OPTIONS\n FILES\n -----\n\n-.mailmap::\n- If this file exists, it will be used for mapping author email\n+ If the file .mailmap exists, it will be used for mapping author email\n addresses to a real author name. One mapping per line, first\n the author name followed by the email address enclosed by\n '<' and '>'. Use hash '#' for comments. Example:\n\n/Gustaf\n"},{"id":"64047","messageId":"20071223171840.GA8799@sigill.intra.peff.net","threadId":"11394","inReplyTo":"476E6DA0.9000908@isy.liu.se","subject":"Re: Problem with git shortlog documentation","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2007-12-23T17:18:40Z","receivedAt":"2007-12-23T17:18:40Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Sun, Dec 23, 2007 at 03:16:00PM +0100, Gustaf Hendeby wrote:\n\n> I was just looking through the documentation for git shortlog, and realized \n> there is a problem with FILES section close to the bottom. In the version I \n> built of the man page (asciidoc 8.2.1, yes I used the compatibility define) \n> the filename .mailmap is missing, and the text starts with \"If this file \n> exists, ...\".\n\nI mentioned this same issue a few weeks ago:\n\n <20071211124220.GA17929@sigill.intra.peff.net>\n\nbut got no response. Under modern asciidoc, it the man page looks like\nthis:\n\n.SH \"FILES\"\n.PP\n\\.mailmap\n.RS 4\nIf this ...\n\nwhich I would have thought would render fine, but doesn't (though I\ndon't really know troff). Doing \" .mailmap\" looks OK.\n\nHowever, the version of the manpages in Junio's origin/man has the awful\n\"Example 1. .mailmap\" generated by asciidoc, so it's clearly a bug-prone\nconstruct.\n\nI think re-wording is a fine fix, at least for now.\n\n> Something like this (would we then like to reindent this? it would make the \n> change look much bigger), which seems to work with my asciidoc version:\n\nIf by \"reindent\" you mean not just \"wrap the long line\" but \"the whole\nparagraph should start at the beginning of the line, since it's no\nlonger part of the list element\", then\n\nAcked-by: Jeff King \n\n-Peff\n"},{"id":"64050","messageId":"7vbq8htgdt.fsf@gitster.siamese.dyndns.org","threadId":"11394","inReplyTo":"20071223171840.GA8799@sigill.intra.peff.net","subject":"Re: Problem with git shortlog documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2007-12-23T18:28:30Z","receivedAt":"2007-12-23T18:28:30Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"I think re-wording is a good enough workaround in this case too.\n"},{"id":"64051","messageId":"1198434891-25847-1-git-send-email-hendeby@isy.liu.se","threadId":"11394","inReplyTo":"20071223171840.GA8799@sigill.intra.peff.net","subject":"[PATCH] Fix for missing line in man page rendered for git shortlog","fromName":"Gustaf Hendeby","fromEmail":"hendeby@isy.liu.se","sentAt":"2007-12-23T18:34:51Z","receivedAt":"2007-12-23T18:34:51Z","isPatch":true,"sender":{"key":"hendeby@isy.liu.se","avatar":"https://avatars.githubusercontent.com/u/730316?v=4"},"body":"This is a work around for a asciidoc/xmlto problem with lines starting\nwith a '.'. Until a proper fix for this is found, rewrite problematic\nsections.\n\nSigned-off-by: Gustaf Hendeby \nAcked-by: Jeff King \n---\n\nJeff King wrote:\n> On Sun, Dec 23, 2007 at 03:16:00PM +0100, Gustaf Hendeby wrote:\n>\n> I mentioned this same issue a few weeks ago:\n>\n> <20071211124220.GA17929@sigill.intra.peff.net>\n\nAh, I missed that one. Unfortunately, the lack of answers indicate it isn't\ntrivial to find a general fix to the problem. :(\n\n> I think re-wording is a fine fix, at least for now.\n>\n>> Something like this (would we then like to reindent this? it would make the\n>> change look much bigger), which seems to work with my asciidoc version:\n>\n> If by \"reindent\" you mean not just \"wrap the long line\" but \"the whole\n> paragraph should start at the beginning of the line, since it's no\n> longer part of the list element\", then\n>\n> Acked-by: Jeff King \n\nI hope I understood corretly when I added your ACK to the patch.\n\nThanks,\n\tGustaf\n\n Documentation/git-shortlog.txt | 18 ++++++++----------\n 1 files changed, 8 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt\nindex e14720b..854bf7a 100644\n--- a/Documentation/git-shortlog.txt\n+++ b/Documentation/git-shortlog.txt\n@@ -37,16 +37,14 @@ OPTIONS\n \n FILES\n -----\n-\n-.mailmap::\n-\tIf this file exists, it will be used for mapping author email\n-\taddresses to a real author name. One mapping per line, first\n-\tthe author name followed by the email address enclosed by\n-\t'<' and '>'. Use hash '#' for comments. Example:\n-\n-\t\t# Keep alphabetized\n-\t\tAdam Morrow \n-\t\tEve Jones \n+If the file .mailmap exists, it will be used for mapping author email\n+addresses to a real author name. One mapping per line, first the\n+author name followed by the email address enclosed by '<' and '>'. Use\n+hash '#' for comments. Example:\n+\n+\t# Keep alphabetized\n+\tAdam Morrow \n+\tEve Jones \n \n Author\n ------\n-- \n1.5.4.rc1.22.g4b71\n"},{"id":"64052","messageId":"20071223184635.GA31630@coredump.intra.peff.net","threadId":"11394","inReplyTo":"1198434891-25847-1-git-send-email-hendeby@isy.liu.se","subject":"Re: [PATCH] Fix for missing line in man page rendered for git shortlog","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2007-12-23T18:46:35Z","receivedAt":"2007-12-23T18:46:35Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Sun, Dec 23, 2007 at 07:34:51PM +0100, Gustaf Hendeby wrote:\n\n> I hope I understood corretly when I added your ACK to the patch.\n\nYes, perfectly.\n\n-Peff\n"}]}