Re: [PATCH v2] bisect: mention "view" as an alternative to "visualize"

From: Christian Couder <christian.couder@gmail.com>
Date: Nov 11, 2017, 13:17 UTC
Message-ID: <CAP8UFD2n18AauZbTWo9s3kaYJfMtCdYFTBS-RbyeemVGGpisGA@mail.gmail.com>
In-Reply-To: <alpine.LFD.2.21.1711110528410.4314@localhost.localdomain>

On Sat, Nov 11, 2017 at 11:31 AM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:

> Tweak a number of files to mention "view" as an alternative to
> "visualize".

Good idea.

> @@ -196,15 +196,14 @@ of `git bisect good` and `git bisect bad` to mark commits.
>  Bisect visualize
>  ~~~~~~~~~~~~~~~~

Maybe while at it the section title could be changed to "Bisect visualize/view".

Show 11 quoted lines

> -To see the currently remaining suspects in 'gitk', issue the following
> -command during the bisection process:
> +To see the currently remaining suspects in 'gitk', issue either of the
> +following equivalent commands during the bisection process:
>
>  ------------
>  $ git bisect visualize
> +$ git bisect view
>  ------------
>
> -`view` may also be used as a synonym for `visualize`.

I don't like very much the above changes. They don't make it clear that there is no difference between using "view" and using "visualize".

Show 18 quoted lines

>  If the `DISPLAY` environment variable is not set, 'git log' is used
>  instead.  You can also give command-line options such as `-p` and
>  `--stat`.
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index 3a03e63eb..55ec58986 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -538,10 +538,11 @@ Note that the version which `git bisect` checks out for you at each
>  point is just a suggestion, and you're free to try a different
>  version if you think it would be a good idea.  For example,
>  occasionally you may land on a commit that broke something unrelated;
> -run
> +run either of the equivalent commands
>
>  -------------------------------------------------
>  $ git bisect visualize
> +$ git bisect view
>  -------------------------------------------------

This is the user manual where we want to restrict the amount of information we give, so I am not a big fan of the above change.

I think the other changes after the above are good though.

Thanks, Christian