From: Junio C Hamano <gitster@pobox.com>
Date: Sun, 21 Apr 2013 19:06:51 GMT
Subject: Re: [PATCH 7/7] git-shortlog.txt: make SYNOPSIS match log, update OPTIONS
Message-ID: <7vip3fsnxw.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1366534252-12099-8-git-send-email-artagnon@gmail.com>

Ramkumar Ramachandra <artagnon@gmail.com> writes:

> 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>...]

You will need to update what you added in [PATCH 2/7] to
builtin/shortlog.c to match this in this patch.

>  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].

Match the text you modified in 'log.txt' in [PATCH 5/7], perhaps?

> +[\--] <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.

Have you read the resulting "git shortlog --help"?  Do we even have
"below"?

> ++
> +Paths may need to be prefixed with "\-- " to separate them from
> +options or the revision range, when confusion arises.
>  
>  MAPPING AUTHORS
>  ---------------