git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/1] checkout: add simple check for 'git checkout -b'

From
Elijah Newren <newren@gmail.com>
Date
Aug 29, 2019, 17:25 UTC
Message-ID
<CABPp-BEgEOr8f7TeD-oqN6A0MtZMDoeuy4SLdCXn--unRwGHwA@mail.gmail.com>
In-Reply-To
<dcf5c60c69d8275a557ffe3d3ae30911d2140162.1567098090.git.gitgitgadget@gmail.com>

On Thu, Aug 29, 2019 at 10:04 AM Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 76 quoted lines
>
> From: Derrick Stolee <dstolee@microsoft.com>
>
> The 'git switch' command was created to separate half of the
> behavior of 'git checkout'. It specifically has the mode to
> do nothing with the index and working directory if the user
> only specifies to create a new branch and change HEAD to that
> branch. This is also the behavior most users expect from
> 'git checkout -b', but for historical reasons it also performs
> an index update by scanning the working directory. This can be
> slow for even moderately-sized repos.
>
> A performance fix for 'git checkout -b' was introduced by
> fa655d8411 (checkout: optimize "git checkout -b <new_branch>"
> 2018-08-16). That change includes details about the config
> setting checkout.optimizeNewBranch when the sparse-checkout
> feature is required. The way this change detected if this
> behavior change is safe was through the skip_merge_working_tree()
> method. This method was complex and needed to be updated
> as new options were introduced.
>
> This behavior was essentially reverted by 65f099b ("switch:
> no worktree status unless real branch switch happens"
> 2019-03-29). Instead, two members of the checkout_opts struct
> were used to distinguish between 'git checkout' and 'git switch':
>
>     * switch_branch_doing_nothing_is_ok
>     * only_merge_on_switching_branches
>
> These settings have opposite values depending on if we start
> in cmd_checkout or cmd_switch.
>
> The message for 64f099b includes "Users of big repos are
> encouraged to move to switch." Making this change while
> 'git switch' is still experimental is too aggressive.
>
> Create a happy medium between these two options by making
> 'git checkout -b <branch>' behave just like 'git switch',
> but only if we read exactly those arguments. This must
> be done in cmd_checkout to avoid the arguments being
> consumed by the option parsing logic.
>
> This differs from the previous change by fa644d8 in that
> the config option checkout.optimizeNewBranch remains
> deleted. This means that 'git checkout -b' will ignore
> the index merge even if we have a sparse-checkout file.
> While this is a behavior change for 'git checkout -b',
> it matches the behavior of 'git switch -c'.
>
> Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
> ---
>  builtin/checkout.c | 9 +++++++++
>  1 file changed, 9 insertions(+)
>
> diff --git a/builtin/checkout.c b/builtin/checkout.c
> index 6123f732a2..116200cf90 100644
> --- a/builtin/checkout.c
> +++ b/builtin/checkout.c
> @@ -1713,6 +1713,15 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
>         opts.overlay_mode = -1;
>         opts.checkout_index = -2;    /* default on */
>         opts.checkout_worktree = -2; /* default on */
> +
> +       if (argc == 3 && !strcmp(argv[1], "-b")) {
> +               /*
> +                * User ran 'git checkout -b <branch>' and expects
> +                * the same behavior as 'git switch -c <branch>'.
> +                */
> +               opts.switch_branch_doing_nothing_is_ok = 0;
> +               opts.only_merge_on_switching_branches = 1;
> +       }
>
>         options = parse_options_dup(checkout_options);
>         options = add_common_options(&opts, options);
> --
> gitgitgadget

Nice! Thanks for doing this; a small and localized performance hack is much nicer than a big and non-localized one. I also appreciate the detailed history in the commit message.

Just for fun, I tested on linux (with a relatively fast SSD) using a simple git-bomb repo with 10M index entries but a sparse checkout of just one file. 'git switch -c' takes approximately 0.004s before or after this patch. 'git checkout -b' before this patch:

$ time git checkout -b newbranch1 Switched to a new branch 'newbranch1'

real 0m13.533s user 0m9.824s sys 0m2.828s

After this patch:

$ time git checkout -b newbranch2 Switched to a new branch 'newbranch2'

real 0m0.003s user 0m0.000s sys 0m0.000s

Anyway, looks good to me.
Previous: Derrick Stolee via GitGitGadgetNext: Phillip Wood
Message 3 of 11 in “checkout: add simple check for 'git checkout -b'”
  1. 0/1 checkout: add simple check for 'git checkout -b'Derrick Stolee via GitGitGadget, Aug 29, 2019
  2. 1/1 checkout: add simple check for 'git checkout -b'Derrick Stolee via GitGitGadget, Aug 29, 2019
  3. Elijah NewrenAug 29, 2019
  4. Phillip WoodAug 29, 2019
  5. Derrick StoleeAug 29, 2019
  6. Pratyush YadavAug 29, 2019
  7. Pratyush YadavAug 29, 2019
  8. Elijah NewrenAug 30, 2019
  9. Taylor BlauAug 30, 2019
  10. Derrick StoleeAug 30, 2019
  11. Junio C HamanoAug 30, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.