Re: [PATCH v2] rev-list-options: clarify the usage of --reverse

From: Philip Oakley <philipoakley@iee.org>
Date: Sep 27, 2016, 21:51 UTC
Message-ID: <A9427F4400044104B47378E024C7C2A4@PhilipOakley>
In-Reply-To: <010201576d63f422-abe45938-0da1-4fc0-b0e7-3e552b59d10a-000000@eu-west-1.amazonses.com>

From: "Pranit Bauva" <pranit.bauva@gmail.com>

> Specify even more clearly that --reverse works only with the commits
> which are chosen to be shown so as to eliminate the confusion as to
> whether the first n or the last n commits with be shown when used

hi Pranit, micro-nit: 'first' and 'last' can be tricky to distinguish for lists (e.g. of commits) that can be considered from both ends with equal ease (people are so easily confused ;-). In such cases its always worth stating the sort order mechanism (within the appropriate sentence). However, in this case the clarification is to clearly point elsewhere, so I'm OK with the patch.

Show 30 quoted lines

> with `-n --reverse`.
>
> Reported-by: Ruediger Meier <sweet_f_a@gmx.de>
> Signed-off-by: Pranit Bauva <pranit.bauva@gmail.com>
> ---
> Documentation/rev-list-options.txt | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/rev-list-options.txt 
> b/Documentation/rev-list-options.txt
> index 7e462d3..5da7cf5 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -657,8 +657,9 @@ avoid showing the commits from two parallel 
> development track mixed
> together.
>
> --reverse::
> - Output the commits in reverse order.
> - Cannot be combined with `--walk-reflogs`.
> + Output the commits chosen to be shown (see Commit Limiting
> + section above) in reverse order. Cannot be combined with
> + `--walk-reflogs`.
>
> Object Traversal
> ~~~~~~~~~~~~~~~~
>
> --
> https://github.com/git/git/pull/296
>

-- Philip