From: "Derrick Stolee via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: stolee@gmail.com, sunshine@sunshineco.com, allred.sean@gmail.com,
gitster@pobox.com, Elijah Newren <newren@gmail.com>,
Derrick Stolee <derrickstolee@github.com>,
Derrick Stolee <dstolee@microsoft.com>
Subject: [PATCH v4 4/5] sparse-checkout: set worktree-config correctly
Date: Tue, 25 Jan 2022 18:42:13 +0000 [thread overview]
Message-ID: <fbfaa17797c023f4a86eeac200a83c2e1954daf5.1643136134.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1101.v4.git.1643136134.gitgitgadget@gmail.com>
From: Derrick Stolee <dstolee@microsoft.com>
The previous change added repo_config_set_worktree_gently() to assist
writing config values into the config.worktree file, if enabled. An
earlier change added init_worktree_config() as a helper to initialize
extensions.worktreeConfig if not already enabled.
Let the sparse-checkout builtin use these helpers instead of attempting to
initialize the worktree config on its own. This changes behavior of 'git
sparse-checkout set' in a few important ways:
1. Git will no longer upgrade the repository format, since this is not
a requirement for understanding extensions.worktreeConfig.
2. 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.
Reported-by: Sean Allred <allred.sean@gmail.com>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
---
Documentation/git-sparse-checkout.txt | 24 ++++++++++++++++-------
builtin/sparse-checkout.c | 28 +++++++++++++--------------
sparse-index.c | 10 +++-------
t/t1091-sparse-checkout-builtin.sh | 4 ++--
4 files changed, 35 insertions(+), 31 deletions(-)
diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
index b81dbe06543..c6eae3ec7fd 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -31,12 +31,20 @@ COMMANDS
Describe the patterns in the sparse-checkout file.
'set'::
- Enable the necessary config settings
- (extensions.worktreeConfig, core.sparseCheckout,
- core.sparseCheckoutCone) if they are not already enabled, and
- write a set of patterns to the sparse-checkout file from the
- list of arguments following the 'set' subcommand. Update the
- working directory to match the new patterns.
+ Enable the necessary sparse-checkout config settings
+ (`core.sparseCheckout` and possibly `core.sparseCheckoutCone`) if
+ they are not already enabled, and write a set of patterns to the
+ sparse-checkout file from the list of arguments following the
+ 'set' subcommand. Update the working directory to match the new
+ patterns.
++
+To ensure that adjusting the sparse-checkout settings within a worktree
+does not alter the sparse-checkout settings in other worktrees, the 'set'
+subcommand will upgrade your repository config to use worktree-specific
+config if not already present. The sparsity defined by the arguments to
+the 'set' subcommand are stored in the worktree-specific sparse-checkout
+file. See linkgit:git-worktree[1] and the documentation of
+`extensions.worktreeConfig` in linkgit:git-config[1] for more details.
+
When the `--stdin` option is provided, the patterns are read from
standard in as a newline-delimited list instead of from the arguments.
@@ -73,7 +81,9 @@ interact with your repository until it is disabled.
By default, these patterns are read from the command-line arguments,
but they can be read from stdin using the `--stdin` option. When
`core.sparseCheckoutCone` is enabled, the given patterns are interpreted
- as directory names as in the 'set' subcommand.
+ as directory names as in the 'set' subcommand. The sparsity defined
+ by the arguments to the 'add' subcommand are added to the patterns
+ in the worktree-specific sparse-checkout file.
'reapply'::
Reapply the sparsity pattern rules to paths in the working tree.
diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c
index 679c1070368..314c8d61f80 100644
--- a/builtin/sparse-checkout.c
+++ b/builtin/sparse-checkout.c
@@ -15,6 +15,7 @@
#include "wt-status.h"
#include "quote.h"
#include "sparse-index.h"
+#include "worktree.h"
static const char *empty_base = "";
@@ -359,26 +360,23 @@ enum sparse_checkout_mode {
static int set_config(enum sparse_checkout_mode mode)
{
- const char *config_path;
-
- if (upgrade_repository_format(1) < 0)
- die(_("unable to upgrade repository format to enable worktreeConfig"));
- if (git_config_set_gently("extensions.worktreeConfig", "true")) {
- error(_("failed to set extensions.worktreeConfig setting"));
+ /* Update to use worktree config, if not already. */
+ if (init_worktree_config(the_repository)) {
+ error(_("failed to initialize worktree config"));
return 1;
}
- config_path = git_path("config.worktree");
- git_config_set_in_file_gently(config_path,
- "core.sparseCheckout",
- mode ? "true" : NULL);
-
- git_config_set_in_file_gently(config_path,
- "core.sparseCheckoutCone",
- mode == MODE_CONE_PATTERNS ? "true" : NULL);
+ if (repo_config_set_worktree_gently(the_repository,
+ "core.sparseCheckout",
+ mode ? "true" : "false") ||
+ repo_config_set_worktree_gently(the_repository,
+ "core.sparseCheckoutCone",
+ mode == MODE_CONE_PATTERNS ?
+ "true" : "false"))
+ return 1;
if (mode == MODE_NO_PATTERNS)
- set_sparse_index_config(the_repository, 0);
+ return set_sparse_index_config(the_repository, 0);
return 0;
}
diff --git a/sparse-index.c b/sparse-index.c
index a1d505d50e9..e93609999e0 100644
--- a/sparse-index.c
+++ b/sparse-index.c
@@ -99,13 +99,9 @@ static int convert_to_sparse_rec(struct index_state *istate,
int set_sparse_index_config(struct repository *repo, int enable)
{
- int res;
- char *config_path = repo_git_path(repo, "config.worktree");
- res = git_config_set_in_file_gently(config_path,
- "index.sparse",
- enable ? "true" : NULL);
- free(config_path);
-
+ int res = repo_config_set_worktree_gently(repo,
+ "index.sparse",
+ enable ? "true" : "false");
prepare_repo_settings(repo);
repo->settings.sparse_index = enable;
return res;
diff --git a/t/t1091-sparse-checkout-builtin.sh b/t/t1091-sparse-checkout-builtin.sh
index 42776984fe7..be6ea4ffe33 100755
--- a/t/t1091-sparse-checkout-builtin.sh
+++ b/t/t1091-sparse-checkout-builtin.sh
@@ -117,7 +117,7 @@ test_expect_success 'switching to cone mode with non-cone mode patterns' '
cd bad-patterns &&
git sparse-checkout init &&
git sparse-checkout add dir &&
- git config core.sparseCheckoutCone true &&
+ git config --worktree core.sparseCheckoutCone true &&
test_must_fail git sparse-checkout add dir 2>err &&
grep "existing sparse-checkout patterns do not use cone mode" err
)
@@ -256,7 +256,7 @@ test_expect_success 'sparse-index enabled and disabled' '
test_cmp expect actual &&
git -C repo config --list >config &&
- ! grep index.sparse config
+ test_cmp_config -C repo false index.sparse
)
'
--
gitgitgadget
next prev parent reply other threads:[~2022-01-25 18:43 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
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 ` Derrick Stolee via GitGitGadget [this message]
2022-01-27 7:15 ` [PATCH v4 4/5] sparse-checkout: set worktree-config correctly 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=fbfaa17797c023f4a86eeac200a83c2e1954daf5.1643136134.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=allred.sean@gmail.com \
--cc=derrickstolee@github.com \
--cc=dstolee@microsoft.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=newren@gmail.com \
--cc=stolee@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).