From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git List <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 7/7] git-shortlog.txt: make SYNOPSIS match log, update OPTIONS
Date: Sun, 21 Apr 2013 14:20:52 +0530 [thread overview]
Message-ID: <1366534252-12099-8-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1366534252-12099-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.
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 <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..2a66518 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>] [<revision range>] [[\--] <path>...]
DESCRIPTION
-----------
@@ -56,6 +56,23 @@ OPTIONS
If width is `0` (zero) then indent the lines of the output without wrapping
them.
+<revision range>::
+ Consider only commits in the specified revision range. When no
+ <revision range> is specified, it defaults to 'HEAD' (ie. the
+ whole history leading to the current commit). master..next
+ specifies all the commits reachable from 'next, but not from
+ 'master'. For a complete list of ways to spell
+ <revision range>, see the "Specifying Ranges" section of
+ linkgit:gitrevisions[7].
+
+[\--] <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 the revision range, when confusion arises.
MAPPING AUTHORS
---------------
--
1.8.2.1.501.gd2949c7
next prev parent reply other threads:[~2013-04-21 8:51 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-21 8:50 [PATCH v2 0/7] Documentation/shortlog improvements Ramkumar Ramachandra
2013-04-21 8:50 ` [PATCH 1/7] git-shortlog.txt: remove (-h|--help) from OPTIONS Ramkumar Ramachandra
2013-04-21 8:50 ` [PATCH 2/7] builtin/shortlog.c: make usage string consistent with log Ramkumar Ramachandra
2013-04-21 8:50 ` [PATCH 3/7] revisions.txt: clarify the .. and ... syntax Ramkumar Ramachandra
2013-04-21 8:50 ` [PATCH 4/7] git-log.txt: order OPTIONS properly; move <since>..<until> Ramkumar Ramachandra
2013-04-21 8:50 ` [PATCH 5/7] git-log.txt: generalize <since>..<until> Ramkumar Ramachandra
2013-04-21 18:54 ` Junio C Hamano
2013-04-21 8:50 ` [PATCH 6/7] git-log.txt: rewrite note on why "--" may be required Ramkumar Ramachandra
2013-04-21 8:50 ` Ramkumar Ramachandra [this message]
2013-04-21 19:06 ` [PATCH 7/7] 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=1366534252-12099-8-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).