[PATCH v4 06/17] sparse-checkout: create 'disable' subcommand

[Derrick Stolee via GitGitGadget]

From: Derrick Stolee <dsto...@microsoft.com>

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 <dsto...@microsoft.com>
---
 Documentation/git-sparse-checkout.txt | 27 ++++++++++++---------------
 builtin/sparse-checkout.c             | 26 +++++++++++++++++++++++++-
 t/t1091-sparse-checkout-builtin.sh    | 15 +++++++++++++++
 3 files changed, 52 insertions(+), 16 deletions(-)

diff --git a/Documentation/git-sparse-checkout.txt 
b/Documentation/git-sparse-checkout.txt
index 163f6c8db0..b0c141b582 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -45,6 +45,10 @@ To avoid interfering with other worktrees, it first enables 
the
        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
 ----------------
 
@@ -62,6 +66,14 @@ directory, it updates the skip-worktree bits in the index 
based
 on this file. The files matching the patterns in the file will
 appear in the working directory, and the rest will not.
 
+To enable the sparse-checkout feature, run `git sparse-checkout init` to
+initialize a simple sparse-checkout file and enable the `core.sparseCheckout`
+config setting. Then, run `git sparse-checkout set` to modify the patterns in
+the sparse-checkout file.
+
+To repopulate the working directory with all files, use the
+`git sparse-checkout disable` command.
+
 ## FULL PATTERN SET
 
 By default, the sparse-checkout file uses the same syntax as `.gitignore`
@@ -76,21 +88,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
-checkout' 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 b747b78d34..78a80ce119 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
 };
 
@@ -207,6 +207,28 @@ static int sparse_checkout_set(int argc, const char 
**argv, const char *prefix)
        return result;
 }
 
+static int sparse_checkout_disable(int argc, const char **argv)
+{
+       char *sparse_filename;
+       FILE *fp;
+
+       if (sc_set_config(MODE_ALL_PATTERNS))
+               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(MODE_NO_PATTERNS);
+}
+
 int cmd_sparse_checkout(int argc, const char **argv, const char *prefix)
 {
        static struct option builtin_sparse_checkout_options[] = {
@@ -231,6 +253,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 2a0137fde3..52d24c66ba 100755
--- a/t/t1091-sparse-checkout-builtin.sh
+++ b/t/t1091-sparse-checkout-builtin.sh
@@ -147,4 +147,19 @@ 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