From: Elijah Newren <newren@gmail.com>
Date: Mon, 11 Mar 2019 19:00:28 GMT
Subject: Re: [PATCH v3 10/21] checkout: split part of it to new command 'switch'
Message-ID: <CABPp-BH+RRaC1bw2_4e7C8PicnF=qT+c9TcRv+E1efbx6X=Akw@mail.gmail.com>
In-Reply-To: <3A57DE38-A5A7-468B-9509-4244C285896A@gmail.com>

On Sun, Mar 10, 2019 at 5:29 PM Jacob Keller <jacob.keller@gmail.com> wrote:
>
> On March 8, 2019 1:57:41 AM PST, "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com> wrote:

> >+<new-branch>::
> >+      Name for the new branch.
> >+
> >+<start-point>::
> >+      The name of a commit at which to switch to before creating a
> >+      new branch or detach from.
>
> The wording here (and a few other places) feels awkward to me. I don't really have a better wording but maybe:
>
> ---
> The name of the commit to switch to when creating a new branch or detaching HEAD
> ---

I also struggle a bit to get better wording in this case.  But maybe
throwing another idea will inspire someone to synthesize (or rewrite)
these into something better, so...

--
The starting point for the new branch.  Specifying a <start-point>
allows you to create a branch based on some other point in history
than where HEAD currently points.  (Or, in the case of --detach,
allows you to inspect and detach from some other point.)
--

I know it's slightly on the longer side, but it's the best I could think of.