Skip to content

Commit 46b2a46

Browse files
artagnongitster
authored andcommitted
git-shortlog.txt: make SYNOPSIS match log, update OPTIONS
There are broadly two problems with the current SYNOPSIS. First, it completely omits the detail that paths can be specified. Second, it attempts to list all the options: this is futile as, in addition to the options unique to it, it accepts all the options that git-rev-list accepts. In fixing these problems, make the SYNOPSIS consistent with that in git-log.txt. Also add the corresponding sections to OPTIONS. Save adding the options from rev-list-options.txt for a later patch, as it requires some work to pick out the options that are relevant to shortlog. Signed-off-by: Ramkumar Ramachandra <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 00200e9 commit 46b2a46

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

Documentation/git-shortlog.txt

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ git-shortlog - Summarize 'git log' output
88
SYNOPSIS
99
--------
1010
[verse]
11-
git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
12-
'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] <commit>...
11+
git log --pretty=short | 'git shortlog' [<options>]
12+
'git shortlog' [<options>] [<revision range>] [[\--] <path>...]
1313

1414
DESCRIPTION
1515
-----------
@@ -56,6 +56,21 @@ OPTIONS
5656
If width is `0` (zero) then indent the lines of the output without wrapping
5757
them.
5858

59+
<revision range>::
60+
Show only commits in the specified revision range. When no
61+
<revision range> is specified, it defaults to `HEAD` (i.e. the
62+
whole history leading to the current commit). `origin..HEAD`
63+
specifies all the commits reachable from the current commit
64+
(i.e. `HEAD`), but not from `origin`. For a complete list of
65+
ways to spell <revision range>, see the "Specifying Ranges"
66+
section of linkgit:gitrevisions[7].
67+
68+
[\--] <path>...::
69+
Consider only commits that are enough to explain how the files
70+
that match the specified paths came to be.
71+
+
72+
Paths may need to be prefixed with "\-- " to separate them from
73+
options or the revision range, when confusion arises.
5974

6075
MAPPING AUTHORS
6176
---------------

0 commit comments

Comments
 (0)