From: Junio C Hamano <gitster@pobox.com>
Date: Mon, 14 Jan 2013 15:59:03 +0000 (-0800)
Subject: Merge branch 'jk/shortlog-no-wrap-doc' into maint
X-Git-Tag: v1.8.1.1~5
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/74abc17f9152e440c4cc672f41473604ed46f60d?hp=-c

Merge branch 'jk/shortlog-no-wrap-doc' into maint

* jk/shortlog-no-wrap-doc:
git-shortlog(1): document behaviour of zero-width wrap
---

74abc17f9152e440c4cc672f41473604ed46f60d
diff --combined Documentation/git-shortlog.txt
index afeb4cdf16,804c84d184..c308e91537
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@@ -3,26 -3,22 +3,26 @@@ git-shortlog(1
  
  NAME
  ----
 -git-shortlog - Summarize 'git-log' output
 +git-shortlog - Summarize 'git log' output
  
  SYNOPSIS
  --------
  [verse]
  git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
 -git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
 +'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] <commit>...
  
  DESCRIPTION
  -----------
 -Summarizes 'git-log' output in a format suitable for inclusion
 -in release announcements. Each commit will be grouped by author and
 -the first line of the commit message will be shown.
 +Summarizes 'git log' output in a format suitable for inclusion
 +in release announcements. Each commit will be grouped by author and title.
  
  Additionally, "[PATCH]" will be stripped from the commit description.
  
 +If no revisions are passed on the command line and either standard input
 +is not a terminal or there is no current branch, 'git shortlog' will
 +output a summary of the log read from standard input, without
 +reference to the current repository.
 +
  OPTIONS
  -------
  
@@@ -43,19 -39,14 +43,22 @@@
  --email::
  	Show the email address of each author.
  
 +--format[=<format>]::
 +	Instead of the commit subject, use some other information to
 +	describe each commit.  '<format>' can be any string accepted
 +	by the `--format` option of 'git log', such as '* [%h] %s'.
 +	(See the "PRETTY FORMATS" section of linkgit:git-log[1].)
 +
 +	Each pretty-printed commit will be rewrapped before it is shown.
 +
  -w[<width>[,<indent1>[,<indent2>]]]::
  	Linewrap the output by wrapping each line at `width`.  The first
  	line of each entry is indented by `indent1` spaces, and the second
  	and subsequent lines are indented by `indent2` spaces. `width`,
  	`indent1`, and `indent2` default to 76, 6 and 9 respectively.
+ +
+ If width is `0` (zero) then indent the lines of the output without wrapping
+ them.
  
  
  MAPPING AUTHORS
@@@ -67,6 -58,15 +70,6 @@@ spelled differently
  
  include::mailmap.txt[]
  
 -
 -Author
 -------
 -Written by Jeff Garzik <jgarzik@pobox.com>
 -
 -Documentation
 ---------------
 -Documentation by Junio C Hamano.
 -
  GIT
  ---
  Part of the linkgit:git[1] suite