Re: [PATCH 1/3] git-shortlog.txt: reorder usages

From: Junio C Hamano <gitster@pobox.com>
Date: Mar 13, 2018, 19:19 UTC
Message-ID: <xmqq37133hs2.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <3d4119e89c8d7c1936c29cc68d7c3dcfed8a96f9.1520680894.git.martin.agren@gmail.com>

Martin Ågren <martin.agren@gmail.com> writes:

Show 5 quoted lines

> The first usage we give is the original one where, e.g., `git log` is
> piped through `git shortlog`. The description that follows reads the
> other way round, by first focusing on the general behavior, then ending
> with the behavior when reading from stdin.
> ...

The result looks a lot more useful than without the patch. I think the current ordering is merely a historical accident made in 2006.

Will queue; thanks.

Show 14 quoted lines

> diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
> index ee6c5476c..5e35ea18a 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' [<options>]
>  'git shortlog' [<options>] [<revision range>] [[\--] <path>...]
> +git log --pretty=short | 'git shortlog' [<options>]
>  
>  DESCRIPTION
>  -----------