threads / patch / 7730

patchgit-shortlog: Fix two formatting errors in asciidoc documentation

Subject: [PATCH] git-shortlog: Fix two formatting errors in asciidoc documentation

## tl;dr

One message between Apr 18, 2007 and Apr 18, 2007. Diffs are folded; open one to read it.

replies: 0people: 1as markdown or json

Frank Lichtenheld· Apr 18, 2007, 22:10 UTC · lore

First use [verse] in the SYNOPSIS so that the line break actually shows.

Secondly drop the quotes around '.mailmap' since this exposes a bug in our toolchain (didn't bother enough yet to find out wether it is asciidoc's fault or that of the XSL templates) that leads to the dot not getting escaped correctly in the roff output and thereby swallowing the line.

Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de>
---
 Documentation/git-shortlog.txt |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
 I sometimes wonder if anyone except me actually reads the
 git man pages?
Show changes to Documentation/git-shortlog.txt +3 −1
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index b0df92e..1c8c55e 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -7,6 +7,7 @@ git-shortlog - Summarize 'git log' output
 
 SYNOPSIS
 --------
+[verse]
 git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s]
 git-shortlog [-n|--number] [-s|--summary] [<committish>...]
 
@@ -33,7 +34,8 @@ OPTIONS
 
 FILES
 -----
-'.mailmap'::
+
+.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
-- 
1.5.1.1

← back to recent threads