From: Derrick Stolee <dstolee@xxxxxxxxxxxxx>
The instructions for disabling a sparse-checkout to a full
working directory are complicated and non-intuitive. Add a
subcommand, 'git sparse-checkout disable', to perform those
steps for the user.
Signed-off-by: Derrick Stolee <dstolee@xxxxxxxxxxxxx>
---
Documentation/git-sparse-checkout.txt | 26 ++++++++-----------
builtin/sparse-checkout.c | 37 ++++++++++++++++++++++++---
t/t1091-sparse-checkout-builtin.sh | 15 +++++++++++
3 files changed, 59 insertions(+), 19 deletions(-)
diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
index 87813e5797..da95b28b1c 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -39,6 +39,10 @@ COMMANDS
a list of arguments following the 'set' subcommand. Update the
working directory to match the new patterns.
+'disable'::
+ Remove the sparse-checkout file, set `core.sparseCheckout` to
+ `false`, and restore the working directory to include all files.
+
SPARSE CHECKOUT
----------------
@@ -61,6 +65,13 @@ Then it compares the new skip-worktree value with the previous one. If
skip-worktree turns from set to unset, it will add the corresponding
file back. If it turns from unset to set, that file will be removed.
+To repopulate the working directory with all files, use the
+`git sparse-checkout disable` command.
+
+Sparse checkout support in 'git checkout' and similar commands is
+disabled by default. You need to set `core.sparseCheckout` to `true`
+in order to have sparse checkout support.
+
## FULL PATTERN SET
By default, the sparse-checkout file uses the same syntax as `.gitignore`
@@ -75,21 +86,6 @@ using negative patterns. For example, to remove the file `unwanted`:
!unwanted
----------------
-Another tricky thing is fully repopulating the working directory when you
-no longer want sparse checkout. You cannot just disable "sparse
-checkout" because skip-worktree bits are still in the index and your working
-directory is still sparsely populated. You should re-populate the working
-directory with the `$GIT_DIR/info/sparse-checkout` file content as
-follows:
-
-----------------
-/*
-----------------
-
-Then you can disable sparse checkout. Sparse checkout support in 'git
-read-tree' and similar commands is disabled by default. You need to
-set `core.sparseCheckout` to `true` in order to have sparse checkout
-support.
SEE ALSO
--------
diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c
index f726fcd6b8..f858f0b1b5 100644
--- a/builtin/sparse-checkout.c
+++ b/builtin/sparse-checkout.c
@@ -8,7 +8,7 @@
#include "strbuf.h"
static char const * const builtin_sparse_checkout_usage[] = {
- N_("git sparse-checkout [init|list|set] <options>"),
+ N_("git sparse-checkout [init|list|set|disable] <options>"),
NULL
};
@@ -74,7 +74,7 @@ static int update_working_directory(void)
return result;
}
-static int sc_enable_config(void)
+static int sc_set_config(int mode)
{
struct argv_array argv = ARGV_ARRAY_INIT;
@@ -83,7 +83,12 @@ static int sc_enable_config(void)
return 1;
}
- argv_array_pushl(&argv, "config", "--worktree", "core.sparseCheckout", "true", NULL);
+ argv_array_pushl(&argv, "config", "--worktree", "core.sparseCheckout", NULL);
+
+ if (mode)
+ argv_array_pushl(&argv, "true", NULL);
+ else
+ argv_array_pushl(&argv, "false", NULL);
if (run_command_v_opt(argv.argv, RUN_GIT_CMD)) {
error(_("failed to enable core.sparseCheckout"));
@@ -101,7 +106,7 @@ static int sparse_checkout_init(int argc, const char **argv)
int res;
struct object_id oid;
- if (sc_enable_config())
+ if (sc_set_config(1))
return 1;
memset(&pl, 0, sizeof(pl));
@@ -188,6 +193,28 @@ static int sparse_checkout_set(int argc, const char **argv, const char *prefix)
return write_patterns_and_update(&pl);
}
+static int sparse_checkout_disable(int argc, const char **argv)
+{
+ char *sparse_filename;
+ FILE *fp;
+
+ if (sc_set_config(1))
+ die(_("failed to change config"));
+
+ sparse_filename = get_sparse_checkout_filename();
+ fp = fopen(sparse_filename, "w");
+ fprintf(fp, "/*\n");
+ fclose(fp);
+
+ if (update_working_directory())
+ die(_("error while refreshing working directory"));
+
+ unlink(sparse_filename);
+ free(sparse_filename);
+
+ return sc_set_config(0);
+}
+
int cmd_sparse_checkout(int argc, const char **argv, const char *prefix)
{
static struct option builtin_sparse_checkout_options[] = {
@@ -212,6 +239,8 @@ int cmd_sparse_checkout(int argc, const char **argv, const char *prefix)
return sparse_checkout_init(argc, argv);
if (!strcmp(argv[0], "set"))
return sparse_checkout_set(argc, argv, prefix);
+ if (!strcmp(argv[0], "disable"))
+ return sparse_checkout_disable(argc, argv);
}
usage_with_options(builtin_sparse_checkout_usage,
diff --git a/t/t1091-sparse-checkout-builtin.sh b/t/t1091-sparse-checkout-builtin.sh
index 02ba9ec314..22fa032d6d 100755
--- a/t/t1091-sparse-checkout-builtin.sh
+++ b/t/t1091-sparse-checkout-builtin.sh
@@ -140,5 +140,20 @@ test_expect_success 'set sparse-checkout using --stdin' '
test_cmp expect dir
'
+test_expect_success 'sparse-checkout disable' '
+ git -C repo sparse-checkout disable &&
+ test_path_is_missing repo/.git/info/sparse-checkout &&
+ git -C repo config --list >config &&
+ test_i18ngrep "core.sparsecheckout=false" config &&
+ ls repo >dir &&
+ cat >expect <<-EOF &&
+ a
+ deep
+ folder1
+ folder2
+ EOF
+ test_cmp expect dir
+'
+
test_done
--
gitgitgadget
