Re: [PATCH 19/19] doc: promote "git switch"
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Jan 31, 2019, 07:39 UTC
- Message-ID
- <CAPig+cRJJtZv0LcchXhV5FFOnbJTVio9Y_R8hyvGJEAGLsJ69A@mail.gmail.com>
- In-Reply-To
- <20190130094831.10420-20-pclouds@gmail.com>
On Wed, Jan 30, 2019 at 4:50 AM Nguyễn Thái Ngọc Duy <pclouds@gmail.com> wrote:
Show 12 quoted lines
> The new command "git switch" is added to avoid the confusion of > one-command-do-all "git checkout" for new users. They are also helpful > to avoid ambiguation context. > > For these reasons, promote it everywhere possible. This includes > documentation, suggestions/advice from other commands... > > Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> > --- > diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt > @@ -319,7 +319,7 @@ NOTES > If you are creating a branch that you want to checkout immediately, it is
s/checkout/switch to/
Show 12 quoted lines
> -easier to use the git checkout command with its `-b` option to create > +easier to use the "git switch" command with its `-c` option to create > a branch and check it out with a single command. > diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt > @@ -302,22 +302,22 @@ ref: refs/heads/master > Examining an old version without creating a new branch > ------------------------------------------------------ > > -The `git checkout` command normally expects a branch head, but will also > +The `git switch` command normally expects a branch head, but will also > accept an arbitrary commit; for example, you can check out the commit > referenced by a tag:
This may need to mention --detach explicitly. Perhaps:
...normally expects a branch head, but will also accept
an arbitrary commit when invoked with --detach;...Show 7 quoted lines
> diff --git a/advice.c b/advice.c
> @@ -191,13 +191,16 @@ void NORETURN die_conclude_merge(void)
> void detach_advice(const char *new_name)
> {
> const char *fmt =
> - _("Note: checking out '%s'.\n\n"
> + _("Note: checking out '%s'.\n"Do you also want to adjust this to avoid saying "checking out"?
Show 5 quoted lines
> + "\n" > "You are in 'detached HEAD' state. You can look around, make experimental\n" > "changes and commit them, and you can discard any commits you make in this\n" > - "state without impacting any branches by performing another checkout.\n\n" > + "state without impacting any branches by performing another checkout.\n"
Ditto: "checkout"?
Show 5 quoted lines
> + "\n" > "If you want to create a new branch to retain commits you create, you may\n" > - "do so (now or later) by using -b with the checkout command again. Example:\n\n" > - " git checkout -b <new-branch-name>\n\n"); > + "do so (now or later) by using -b with the checkout command again. Example:\n"
s/-b/-c/ s/checkout/switch/
Show 9 quoted lines
> + "\n"
> + " git switch -c <new-branch-name>\n\n");
> diff --git a/builtin/clone.c b/builtin/clone.c
> @@ -491,7 +491,7 @@ static enum {
> static const char junk_leave_repo_msg[] =
> N_("Clone succeeded, but checkout failed.\n"
> "You can inspect what was checked out with 'git status'\n"
> - "and retry the checkout with 'git checkout -f HEAD'\n");
> + "and retry the checkout with 'git switch -f HEAD'\n");Just wondering if these uses of "checkout" and "checked out" need adjustment. I don't have any good suggestions, though.
> diff --git a/t/t2020-checkout-detach.sh b/t/t2020-checkout-detach.sh > @@ -204,7 +204,7 @@ test_expect_success 'describe_detached_head prints no SHA-1 ellipsis when not as > If you want to create a new branch to retain commits you create, you may > do so (now or later) by using -b with the checkout command again. Example:
s/-b/-c/ s/checkout/switch/
Show 5 quoted lines
> - git checkout -b <new-branch-name> > + git switch -c <new-branch-name> > @@ -280,7 +280,7 @@ test_expect_success 'describe_detached_head does print SHA-1 ellipsis when asked > If you want to create a new branch to retain commits you create, you may > do so (now or later) by using -b with the checkout command again. Example:
s/-b/-c/ s/checkout/switch/
> - git checkout -b <new-branch-name> > + git switch -c <new-branch-name>