git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Christian Couder <christian.couder@gmail.com>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>
Cc: Git Mailing list <git@vger.kernel.org>
Subject: Re: [PATCH v2] bisect: mention "view" as an alternative to "visualize"
Date: Sat, 11 Nov 2017 14:17:59 +0100	[thread overview]
Message-ID: <CAP8UFD2n18AauZbTWo9s3kaYJfMtCdYFTBS-RbyeemVGGpisGA@mail.gmail.com> (raw)
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".

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

>  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

  reply	other threads:[~2017-11-11 13:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-11 10:31 [PATCH v2] bisect: mention "view" as an alternative to "visualize" Robert P. J. Day
2017-11-11 13:17 ` Christian Couder [this message]
2017-11-11 13:20   ` Robert P. J. Day

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAP8UFD2n18AauZbTWo9s3kaYJfMtCdYFTBS-RbyeemVGGpisGA@mail.gmail.com \
    --to=christian.couder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=rpjday@crashcourse.ca \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).