From: Derrick Stolee <stolee@gmail.com>
To: Elijah Newren <newren@gmail.com>,
Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>,
Eric Sunshine <sunshine@sunshineco.com>,
Sean Allred <allred.sean@gmail.com>,
Junio C Hamano <gitster@pobox.com>,
Derrick Stolee <derrickstolee@github.com>
Subject: Re: [PATCH v3 0/6] Sparse checkout: fix bug with worktree of bare repo
Date: Wed, 29 Dec 2021 12:38:58 -0500 [thread overview]
Message-ID: <1db0f601-4769-15c0-cd58-ecddfa1fc9d5@gmail.com> (raw)
In-Reply-To: <CABPp-BHuO3B366uJuODMQo-y449p8cAMVn0g2MTcO5di3Xa7Zg@mail.gmail.com>
On 12/29/2021 4:39 AM, Elijah Newren wrote:
> On Tue, Dec 28, 2021 at 1:32 PM Derrick Stolee via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
>>
>> This series is based on a merge of en/sparse-checkout-set,
>> en/worktree-chatty-to-stderr, and ds/sparse-checkout-malformed-pattern-fix.
>
> I think you mean es/worktree-chatty-to-stderr (not 'en/')
Yes. Thanks.
>> This patch series includes a fix to the bug reported by Sean Allred [1] and
>> diagnosed by Eric Sunshine [2].
>>
>> The root cause is that 'git sparse-checkout init' writes to the worktree
>> config without checking that core.bare might need to be set. This only
>> matters when the base repository is bare, since creating the config.worktree
>> file and enabling extensions.worktreeConfig will cause Git to treat the base
>> repo's core.bare=false as important for this worktree.
>>
>> This series fixes this, but also puts in place some helpers to prevent this
>> from happening in the future. While here, some of the config paths are
>> modified to take a repository struct.
>>
>> * 'git sparse-checkout' will now modify the worktree config, if enabled. It
>> will no longer auto-upgrade users into using worktree config.
>
> This sounds dangerous to me.
> ...
>> + Let the sparse-checkout builtin use this helper instead of attempting to
>> + initialize the worktree config on its own. This changes behavior of 'git
>> + sparse-checkout set' in a few important ways:
>>
>> - The fix is to have this assignment into config.worktree be handled by
>> - the repo_config_set_worktree_gently() helper.
>> + 1. Git will no longer upgrade the repository format and add the
>> + worktree config extension. The user should run 'git worktree
>> + init-worktree-config' to enable this feature.
>> +
>> + 2. If worktree config is disabled, then this command will set the
>> + core.sparseCheckout (and possibly core.sparseCheckoutCone and
>> + index.sparse) values in the common config file.
>
> Yikes.
>
>> + 3. If the main worktree is bare, then this command will not put the
>> + worktree in a broken state.
>> +
>> + The main reason to use worktree-specific config for the sparse-checkout
>> + builtin was to avoid enabling sparse-checkout patterns in one and
>> + causing a loss of files in another. If a worktree does not have a
>> + sparse-checkout patterns file, then the sparse-checkout logic will not
>> + kick in on that worktree.
>> +
>> + This new logic introduces a new user pattern that could lead to some
>> + confusion. Suppose a user has not upgraded to worktree config and
>> + follows these steps in order:
>> +
>> + 1. Enable sparse-checkout in a worktree.
>> +
>> + 2. Disable sparse-checkout in that worktree without deleting that
>> + worktree's sparse-checkout file.
>> +
>> + 3. Enable sparse-checkout in another worktree.
>> +
>> + After these steps, the first worktree will have sparse-checkout enabled
>> + with whatever patterns exist. The worktree does not immediately have
>> + those patterns applied, but a variety of Git commands would apply the
>> + sparse-checkout patterns and update the worktree state to reflect those
>> + patterns. This situation is likely very rare and the workaround is to
>
> No, it's not even rare, let alone very rare. I'd actually call it
> common. Since 'sparse-checkout disable' does not delete the
> sparse-checkout file, and we've encouraged folks to use the
> sparse-checkout command (or a wrapper thereof) instead of direct
> editing of the sparse-checkout file (and indeed, the sparse-checkout
> command will overwrite the sparse-checkout file which further
> discourages users from feeling they own it), having the file left
> around after disabling is the common case. So, the only question is,
> how often do users disable and re-enable sparse-checkout, and
> potentially only do so in some of their worktrees? At my $DAYJOB,
> that's actually quite common. I got multiple reports quite soon after
> introducing our `sparsify` tool about users doing something like this;
> this is what led me to learn of the extensions.worktreeConfig, and why
> I pointed it out to you on your first submission of
> git-sparse-checkout[1]
> (https://lore.kernel.org/git/CABPp-BFcH5hQqujjmc88L3qGx3QAYZ_chH6PXQXyp13ipfV6hQ@mail.gmail.com/)
Thank you for these comments and the detailed descriptions of things
from your $DAYJOB. That's helpful context and I'm happy to switch back
to enabling the extension in the sparse-checkout builtin. I might need
to rearrange the code so there is an API in worktree.c instead of just
the subcommand in builtin/worktree.c, but that's pretty minor. I'll
keep Eric's earlier suggestion to have the upgrade be a separate call
from the repo_config_set_worktree_gently().
Thanks,
-Stolee
next prev parent reply other threads:[~2021-12-29 17:39 UTC|newest]
Thread overview: 138+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-20 15:57 [PATCH 0/4] Sparse checkout: fix bug with worktree of bare repo Derrick Stolee via GitGitGadget
2021-12-20 15:57 ` [PATCH 1/4] setup: use a repository when upgrading format Derrick Stolee via GitGitGadget
2021-12-20 15:57 ` [PATCH 2/4] config: make some helpers repo-aware Derrick Stolee via GitGitGadget
2021-12-20 15:57 ` [PATCH 3/4] config: add repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2021-12-20 17:32 ` Derrick Stolee
2021-12-21 0:01 ` Eric Sunshine
2021-12-21 5:59 ` Eric Sunshine
2021-12-21 13:41 ` Derrick Stolee
2021-12-21 5:53 ` Eric Sunshine
2021-12-21 13:45 ` Derrick Stolee
2021-12-21 23:29 ` Eric Sunshine
2021-12-20 15:57 ` [PATCH 4/4] sparse-checkout: use repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2021-12-20 16:21 ` [PATCH 0/4] Sparse checkout: fix bug with worktree of bare repo Eric Sunshine
2021-12-20 17:34 ` Derrick Stolee
2021-12-21 6:10 ` Eric Sunshine
2021-12-21 19:14 ` [PATCH v2 0/5] " Derrick Stolee via GitGitGadget
2021-12-21 19:14 ` [PATCH v2 1/5] setup: use a repository when upgrading format Derrick Stolee via GitGitGadget
2021-12-21 19:14 ` [PATCH v2 2/5] config: make some helpers repo-aware Derrick Stolee via GitGitGadget
2021-12-21 19:14 ` [PATCH v2 3/5] worktree: add upgrade_to_worktree_config() Derrick Stolee via GitGitGadget
2021-12-22 0:45 ` Eric Sunshine
2021-12-28 15:03 ` Derrick Stolee
2021-12-28 16:58 ` Eric Sunshine
2021-12-28 17:03 ` Derrick Stolee
2021-12-22 5:38 ` Junio C Hamano
2021-12-28 15:13 ` Derrick Stolee
2021-12-21 19:14 ` [PATCH v2 4/5] config: add repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2021-12-22 1:11 ` Eric Sunshine
2021-12-21 19:14 ` [PATCH v2 5/5] sparse-checkout: use repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2021-12-22 5:48 ` Eric Sunshine
2021-12-22 6:05 ` [PATCH v2 0/5] Sparse checkout: fix bug with worktree of bare repo Eric Sunshine
2021-12-22 22:54 ` Elijah Newren
2021-12-27 7:15 ` Eric Sunshine
2021-12-27 7:34 ` Eric Sunshine
2021-12-27 20:16 ` Elijah Newren
2021-12-28 9:11 ` Eric Sunshine
2021-12-30 6:21 ` Eric Sunshine
2021-12-30 17:40 ` Elijah Newren
2021-12-27 19:35 ` Elijah Newren
2021-12-28 7:33 ` Eric Sunshine
2021-12-28 18:16 ` Elijah Newren
2021-12-30 6:40 ` Eric Sunshine
2021-12-30 18:38 ` Elijah Newren
2022-01-03 6:51 ` Eric Sunshine
2021-12-28 21:32 ` [PATCH v3 0/6] " Derrick Stolee via GitGitGadget
2021-12-28 21:32 ` [PATCH v3 1/6] setup: use a repository when upgrading format Derrick Stolee via GitGitGadget
2021-12-28 21:32 ` [PATCH v3 2/6] config: make some helpers repo-aware Derrick Stolee via GitGitGadget
2021-12-28 21:32 ` [PATCH v3 3/6] worktree: add 'init-worktree-config' subcommand Derrick Stolee via GitGitGadget
2021-12-29 6:48 ` Eric Sunshine
2021-12-30 8:41 ` Eric Sunshine
2021-12-30 17:29 ` Derrick Stolee
2022-01-03 6:38 ` Eric Sunshine
2021-12-28 21:32 ` [PATCH v3 4/6] config: add repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2021-12-28 21:32 ` [PATCH v3 5/6] sparse-checkout: use repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2021-12-30 9:01 ` Eric Sunshine
2021-12-28 21:32 ` [PATCH v3 6/6] worktree: copy sparse-checkout patterns and config on add Derrick Stolee via GitGitGadget
2021-12-29 6:37 ` Eric Sunshine
2021-12-29 17:31 ` Derrick Stolee
2021-12-29 19:51 ` Elijah Newren
2021-12-29 21:39 ` Derrick Stolee
2021-12-29 22:45 ` Elijah Newren
2021-12-30 8:16 ` Eric Sunshine
2021-12-30 8:01 ` Eric Sunshine
2021-12-29 9:39 ` [PATCH v3 0/6] Sparse checkout: fix bug with worktree of bare repo Elijah Newren
2021-12-29 17:38 ` Derrick Stolee [this message]
2021-12-30 7:41 ` Eric Sunshine
2021-12-30 7:40 ` Eric Sunshine
2021-12-30 17:41 ` Derrick Stolee
2021-12-30 19:29 ` Elijah Newren
2022-01-03 7:11 ` Eric Sunshine
2021-12-30 18:46 ` Elijah Newren
2022-01-25 18:42 ` [PATCH v4 0/5] " Derrick Stolee via GitGitGadget
2022-01-25 18:42 ` [PATCH v4 1/5] Documentation: add extensions.worktreeConfig details Derrick Stolee via GitGitGadget
2022-01-26 6:59 ` Bagas Sanjaya
2022-01-27 14:15 ` Derrick Stolee
2022-01-27 6:43 ` Elijah Newren
2022-01-27 14:17 ` Derrick Stolee
2022-01-25 18:42 ` [PATCH v4 2/5] worktree: create init_worktree_config() Derrick Stolee via GitGitGadget
2022-01-27 7:01 ` Elijah Newren
2022-01-25 18:42 ` [PATCH v4 3/5] config: add repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2022-01-25 18:42 ` [PATCH v4 4/5] sparse-checkout: set worktree-config correctly Derrick Stolee via GitGitGadget
2022-01-27 7:15 ` Elijah Newren
2022-01-27 14:24 ` Derrick Stolee
2022-01-25 18:42 ` [PATCH v4 5/5] worktree: copy sparse-checkout patterns and config on add Derrick Stolee via GitGitGadget
2022-01-27 7:09 ` Elijah Newren
2022-01-27 7:20 ` [PATCH v4 0/5] Sparse checkout: fix bug with worktree of bare repo Elijah Newren
2022-01-27 14:29 ` Derrick Stolee
2022-01-31 15:00 ` [PATCH v5 " Derrick Stolee via GitGitGadget
2022-01-31 15:00 ` [PATCH v5 1/5] Documentation: add extensions.worktreeConfig details Derrick Stolee via GitGitGadget
2022-02-06 9:17 ` Eric Sunshine
2022-01-31 15:00 ` [PATCH v5 2/5] worktree: create init_worktree_config() Derrick Stolee via GitGitGadget
2022-02-06 9:32 ` Eric Sunshine
2022-01-31 15:00 ` [PATCH v5 3/5] config: add repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2022-01-31 15:00 ` [PATCH v5 4/5] sparse-checkout: set worktree-config correctly Derrick Stolee via GitGitGadget
2022-02-06 10:21 ` Eric Sunshine
2022-01-31 15:00 ` [PATCH v5 5/5] worktree: copy sparse-checkout patterns and config on add Derrick Stolee via GitGitGadget
2022-02-06 10:36 ` Jean-Noël AVILA
2022-02-07 14:10 ` Derrick Stolee
2022-02-09 7:53 ` Jean-Noël Avila
2022-02-09 14:45 ` Derrick Stolee
2022-02-06 11:30 ` Eric Sunshine
2022-02-06 19:36 ` Eric Sunshine
2022-02-07 14:30 ` Derrick Stolee
2022-02-15 22:01 ` Eric Sunshine
2022-02-16 13:58 ` Derrick Stolee
2022-01-31 16:17 ` [PATCH v5 0/5] Sparse checkout: fix bug with worktree of bare repo Elijah Newren
2022-02-07 21:32 ` [PATCH v6 0/6] " Derrick Stolee via GitGitGadget
2022-02-07 21:32 ` [PATCH v6 1/6] Documentation: add extensions.worktreeConfig details Derrick Stolee via GitGitGadget
2022-02-08 22:20 ` Junio C Hamano
2022-02-09 2:34 ` Derrick Stolee
2022-02-09 17:19 ` Junio C Hamano
2022-02-09 17:26 ` Derrick Stolee
2022-02-09 17:51 ` Elijah Newren
2022-02-09 18:40 ` Junio C Hamano
2022-02-15 20:37 ` Eric Sunshine
2022-02-16 1:51 ` Junio C Hamano
2022-02-09 18:04 ` Elijah Newren
2022-02-09 18:41 ` Junio C Hamano
2022-02-07 21:32 ` [PATCH v6 2/6] worktree: create init_worktree_config() Derrick Stolee via GitGitGadget
2022-02-08 22:09 ` Junio C Hamano
2022-02-09 2:21 ` Derrick Stolee
2022-02-09 17:34 ` Junio C Hamano
2022-02-09 16:43 ` Elijah Newren
2022-02-07 21:33 ` [PATCH v6 3/6] config: add repo_config_set_worktree_gently() Derrick Stolee via GitGitGadget
2022-02-08 22:18 ` Junio C Hamano
2022-02-09 2:27 ` Derrick Stolee
2022-02-09 17:49 ` Junio C Hamano
2022-02-10 14:48 ` Derrick Stolee
2022-02-10 16:45 ` Junio C Hamano
2022-02-07 21:33 ` [PATCH v6 4/6] sparse-checkout: set worktree-config correctly Derrick Stolee via GitGitGadget
2022-02-07 21:33 ` [PATCH v6 5/6] worktree: copy sparse-checkout patterns and config on add Derrick Stolee via GitGitGadget
2022-02-15 22:23 ` Eric Sunshine
2022-02-07 21:33 ` [PATCH v6 6/6] config: make git_configset_get_string_tmp() private Derrick Stolee via GitGitGadget
2022-02-08 4:14 ` [PATCH v6 0/6] Sparse checkout: fix bug with worktree of bare repo Elijah Newren
2022-02-08 5:02 ` Eric Sunshine
2022-02-08 5:18 ` Elijah Newren
2022-02-08 5:42 ` Eric Sunshine
2022-02-16 0:56 ` Eric Sunshine
2022-02-08 14:33 ` Derrick Stolee
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=1db0f601-4769-15c0-cd58-ecddfa1fc9d5@gmail.com \
--to=stolee@gmail.com \
--cc=allred.sean@gmail.com \
--cc=derrickstolee@github.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=newren@gmail.com \
--cc=sunshine@sunshineco.com \
/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).