From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git List <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 5/5] git-shortlog.txt: make SYNOPSIS match log, update OPTIONS
Date: Sat, 20 Apr 2013 17:15:13 +0530 [thread overview]
Message-ID: <1366458313-7186-6-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1366458313-7186-1-git-send-email-artagnon@gmail.com>
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.
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
Documentation/git-shortlog.txt | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index c7f7f51..d02ac03 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -8,8 +8,8 @@ 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>]]]] <commit>...
+git log --pretty=short | 'git shortlog' [<options>]
+'git shortlog' [<options>] [<since>..<until>] [[\--] <path>...]
DESCRIPTION
-----------
@@ -26,6 +26,13 @@ reference to the current repository.
OPTIONS
-------
+<since>..<until>::
+ Consider only commits between the named two revisions. When
+ either <since> or <until> is omitted, it defaults to `HEAD`,
+ i.e. the tip of the current branch. For a more complete list
+ of ways to spell <since>..<until>, see
+ linkgit:gitrevisions[7].
+
-n::
--numbered::
Sort output according to the number of commits per author instead
@@ -56,6 +63,16 @@ OPTIONS
If width is `0` (zero) then indent the lines of the output without wrapping
them.
+[\--] <path>...::
+ Consider only commits that are enough to explain how the files
+ that match the specified paths came to be. See "History
+ Simplification" below for details and other simplification
+ modes.
++
+Paths may need to be prefixed with "\-- " to separate them from
+options or revisions, when confusion arises.
+
+include::rev-list-options.txt[]
MAPPING AUTHORS
---------------
--
1.8.2.1.506.gbce9ff0
next prev parent reply other threads:[~2013-04-20 11:45 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-20 11:45 [PATCH 0/5] Documentation/shortlog improvements Ramkumar Ramachandra
2013-04-20 11:45 ` [PATCH 1/5] git-shortlog.txt: remove (-h|--help) from OPTIONS Ramkumar Ramachandra
2013-04-20 11:45 ` [PATCH 2/5] builtin/shortlog.c: make usage string consistent with log Ramkumar Ramachandra
2013-04-20 11:45 ` [PATCH 3/5] git-log.txt: fix description of <since>..<until> Ramkumar Ramachandra
2013-04-20 22:25 ` Jonathan Nieder
2013-04-21 7:18 ` Ramkumar Ramachandra
2013-04-21 7:41 ` Jonathan Nieder
[not found] ` <CAPc5daVcovqrHP-YWnkcQWwev5TW5S8ioX-bWyAnNG2PTg_XMw@mail.gmail.com>
2013-04-21 8:17 ` [PATCH/RFC] glossary: a revision is just a commit Jonathan Nieder
2013-04-21 19:00 ` Junio C Hamano
2013-04-21 7:19 ` [PATCH 3/5] git-log.txt: fix description of <since>..<until> Junio C Hamano
2013-04-21 6:40 ` Junio C Hamano
2013-04-20 11:45 ` [PATCH 4/5] git-log.txt: rewrite note on why "--" may be required Ramkumar Ramachandra
2013-04-21 6:51 ` Junio C Hamano
2013-04-21 7:26 ` Ramkumar Ramachandra
2013-04-21 7:33 ` Junio C Hamano
2013-04-21 7:38 ` Ramkumar Ramachandra
2013-04-21 7:46 ` Junio C Hamano
2013-04-21 8:00 ` Ramkumar Ramachandra
2013-04-21 8:09 ` Jonathan Nieder
2013-04-21 8:15 ` Ramkumar Ramachandra
2013-04-21 8:17 ` Jonathan Nieder
2013-04-21 8:33 ` Junio C Hamano
2013-04-21 9:05 ` Ramkumar Ramachandra
2013-04-21 9:46 ` Ramkumar Ramachandra
2013-04-21 10:09 ` Jonathan Nieder
[not found] ` <CAPc5daV39HsoRR2pj34Tz1kQKFVRrp+NZpMM2BremocqvToA+A@mail.gmail.com>
2013-04-21 8:13 ` Ramkumar Ramachandra
2013-04-21 8:23 ` Ramkumar Ramachandra
2013-04-21 7:39 ` Junio C Hamano
2013-04-21 7:57 ` Ramkumar Ramachandra
2013-04-22 2:40 ` Junio C Hamano
2013-04-22 9:36 ` Thomas Rast
2013-04-22 9:40 ` Thomas Rast
2013-04-22 14:55 ` Junio C Hamano
2013-04-20 11:45 ` Ramkumar Ramachandra [this message]
2013-04-21 7:04 ` [PATCH 5/5] git-shortlog.txt: make SYNOPSIS match log, update OPTIONS Junio C Hamano
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=1366458313-7186-6-git-send-email-artagnon@gmail.com \
--to=artagnon@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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).