builtin/sparse-checkout.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "config.h"
   4 #include "dir.h"
   5 #include "parse-options.h"
   6 #include "pathspec.h"
   7 #include "repository.h"
   8 #include "run-command.h"
   9 #include "strbuf.h"
  10 #include "string-list.h"
  11 #include "cache-tree.h"
  12 #include "lockfile.h"
  13 #include "resolve-undo.h"
  14 #include "unpack-trees.h"
  15 #include "wt-status.h"
  16 #include "quote.h"
  17 #include "sparse-index.h"
  18 #include "worktree.h"
  19
  20 static const char *empty_base = "";
  21
  22 static char const * const builtin_sparse_checkout_usage[] = {
  23         N_("git sparse-checkout (init|list|set|add|reapply|disable) <options>"),
  24         NULL
  25 };
  26
  27 static void write_patterns_to_file(FILE *fp, struct pattern_list *pl)
  28 {
  29         int i;
  30
  31         for (i = 0; i < pl->nr; i++) {
  32                 struct path_pattern *p = pl->patterns[i];
  33
  34                 if (p->flags & PATTERN_FLAG_NEGATIVE)
  35                         fprintf(fp, "!");
  36
  37                 fprintf(fp, "%s", p->pattern);
  38
  39                 if (p->flags & PATTERN_FLAG_MUSTBEDIR)
  40                         fprintf(fp, "/");
  41
  42                 fprintf(fp, "\n");
  43         }
  44 }
  45
  46 static char const * const builtin_sparse_checkout_list_usage[] = {
  47         "git sparse-checkout list",
  48         NULL
  49 };
  50
  51 static int sparse_checkout_list(int argc, const char **argv)
  52 {
  53         static struct option builtin_sparse_checkout_list_options[] = {
  54                 OPT_END(),
  55         };
  56         struct pattern_list pl;
  57         char *sparse_filename;
  58         int res;
  59
  60         if (!core_apply_sparse_checkout)
  61                 die(_("this worktree is not sparse"));
  62
  63         argc = parse_options(argc, argv, NULL,
  64                              builtin_sparse_checkout_list_options,
  65                              builtin_sparse_checkout_list_usage, 0);
  66
  67         memset(&pl, 0, sizeof(pl));
  68
  69         pl.use_cone_patterns = core_sparse_checkout_cone;
  70
  71         sparse_filename = get_sparse_checkout_filename();
  72         res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL, 0);
  73         free(sparse_filename);
  74
  75         if (res < 0) {
  76                 warning(_("this worktree is not sparse (sparse-checkout file may not exist)"));
  77                 return 0;
  78         }
  79
  80         if (pl.use_cone_patterns) {
  81                 int i;
  82                 struct pattern_entry *pe;
  83                 struct hashmap_iter iter;
  84                 struct string_list sl = STRING_LIST_INIT_DUP;
  85
  86                 hashmap_for_each_entry(&pl.recursive_hashmap, &iter, pe, ent) {
  87                         /* pe->pattern starts with "/", skip it */
  88                         string_list_insert(&sl, pe->pattern + 1);
  89                 }
  90
  91                 string_list_sort(&sl);
  92
  93                 for (i = 0; i < sl.nr; i++) {
  94                         quote_c_style(sl.items[i].string, NULL, stdout, 0);
  95                         printf("\n");
  96                 }
  97
  98                 return 0;
  99         }
 100
 101         write_patterns_to_file(stdout, &pl);
 102         clear_pattern_list(&pl);
 103
 104         return 0;
 105 }
 106
 107 static void clean_tracked_sparse_directories(struct repository *r)
 108 {
 109         int i, was_full = 0;
 110         struct strbuf path = STRBUF_INIT;
 111         size_t pathlen;
 112         struct string_list_item *item;
 113         struct string_list sparse_dirs = STRING_LIST_INIT_DUP;
 114
 115         /*
 116          * If we are not using cone mode patterns, then we cannot
 117          * delete directories outside of the sparse cone.
 118          */
 119         if (!r || !r->index || !r->worktree)
 120                 return;
 121         if (init_sparse_checkout_patterns(r->index) ||
 122             !r->index->sparse_checkout_patterns->use_cone_patterns)
 123                 return;
 124
 125         /*
 126          * Use the sparse index as a data structure to assist finding
 127          * directories that are safe to delete. This conversion to a
 128          * sparse index will not delete directories that contain
 129          * conflicted entries or submodules.
 130          */
 131         if (!r->index->sparse_index) {
 132                 /*
 133                  * If something, such as a merge conflict or other concern,
 134                  * prevents us from converting to a sparse index, then do
 135                  * not try deleting files.
 136                  */
 137                 if (convert_to_sparse(r->index, SPARSE_INDEX_MEMORY_ONLY))
 138                         return;
 139                 was_full = 1;
 140         }
 141
 142         strbuf_addstr(&path, r->worktree);
 143         strbuf_complete(&path, '/');
 144         pathlen = path.len;
 145
 146         /*
 147          * Collect directories that have gone out of scope but also
 148          * exist on disk, so there is some work to be done. We need to
 149          * store the entries in a list before exploring, since that might
 150          * expand the sparse-index again.
 151          */
 152         for (i = 0; i < r->index->cache_nr; i++) {
 153                 struct cache_entry *ce = r->index->cache[i];
 154
 155                 if (S_ISSPARSEDIR(ce->ce_mode) &&
 156                     repo_file_exists(r, ce->name))
 157                         string_list_append(&sparse_dirs, ce->name);
 158         }
 159
 160         for_each_string_list_item(item, &sparse_dirs) {
 161                 struct dir_struct dir = DIR_INIT;
 162                 struct pathspec p = { 0 };
 163                 struct strvec s = STRVEC_INIT;
 164
 165                 strbuf_setlen(&path, pathlen);
 166                 strbuf_addstr(&path, item->string);
 167
 168                 dir.flags |= DIR_SHOW_IGNORED_TOO;
 169
 170                 setup_standard_excludes(&dir);
 171                 strvec_push(&s, path.buf);
 172
 173                 parse_pathspec(&p, PATHSPEC_GLOB, 0, NULL, s.v);
 174                 fill_directory(&dir, r->index, &p);
 175
 176                 if (dir.nr) {
 177                         warning(_("directory '%s' contains untracked files,"
 178                                   " but is not in the sparse-checkout cone"),
 179                                 item->string);
 180                 } else if (remove_dir_recursively(&path, 0)) {
 181                         /*
 182                          * Removal is "best effort". If something blocks
 183                          * the deletion, then continue with a warning.
 184                          */
 185                         warning(_("failed to remove directory '%s'"),
 186                                 item->string);
 187                 }
 188
 189                 strvec_clear(&s);
 190                 clear_pathspec(&p);
 191                 dir_clear(&dir);
 192         }
 193
 194         string_list_clear(&sparse_dirs, 0);
 195         strbuf_release(&path);
 196
 197         if (was_full)
 198                 ensure_full_index(r->index);
 199 }
 200
 201 static int update_working_directory(struct pattern_list *pl)
 202 {
 203         enum update_sparsity_result result;
 204         struct unpack_trees_options o;
 205         struct lock_file lock_file = LOCK_INIT;
 206         struct repository *r = the_repository;
 207
 208         /* If no branch has been checked out, there are no updates to make. */
 209         if (is_index_unborn(r->index))
 210                 return UPDATE_SPARSITY_SUCCESS;
 211
 212         r->index->sparse_checkout_patterns = pl;
 213
 214         memset(&o, 0, sizeof(o));
 215         o.verbose_update = isatty(2);
 216         o.update = 1;
 217         o.head_idx = -1;
 218         o.src_index = r->index;
 219         o.dst_index = r->index;
 220         o.skip_sparse_checkout = 0;
 221         o.pl = pl;
 222
 223         setup_work_tree();
 224
 225         repo_hold_locked_index(r, &lock_file, LOCK_DIE_ON_ERROR);
 226
 227         setup_unpack_trees_porcelain(&o, "sparse-checkout");
 228         result = update_sparsity(&o);
 229         clear_unpack_trees_porcelain(&o);
 230
 231         if (result == UPDATE_SPARSITY_WARNINGS)
 232                 /*
 233                  * We don't do any special handling of warnings from untracked
 234                  * files in the way or dirty entries that can't be removed.
 235                  */
 236                 result = UPDATE_SPARSITY_SUCCESS;
 237         if (result == UPDATE_SPARSITY_SUCCESS)
 238                 write_locked_index(r->index, &lock_file, COMMIT_LOCK);
 239         else
 240                 rollback_lock_file(&lock_file);
 241
 242         clean_tracked_sparse_directories(r);
 243
 244         r->index->sparse_checkout_patterns = NULL;
 245         return result;
 246 }
 247
 248 static char *escaped_pattern(char *pattern)
 249 {
 250         char *p = pattern;
 251         struct strbuf final = STRBUF_INIT;
 252
 253         while (*p) {
 254                 if (is_glob_special(*p))
 255                         strbuf_addch(&final, '\\');
 256
 257                 strbuf_addch(&final, *p);
 258                 p++;
 259         }
 260
 261         return strbuf_detach(&final, NULL);
 262 }
 263
 264 static void write_cone_to_file(FILE *fp, struct pattern_list *pl)
 265 {
 266         int i;
 267         struct pattern_entry *pe;
 268         struct hashmap_iter iter;
 269         struct string_list sl = STRING_LIST_INIT_DUP;
 270         struct strbuf parent_pattern = STRBUF_INIT;
 271
 272         hashmap_for_each_entry(&pl->parent_hashmap, &iter, pe, ent) {
 273                 if (hashmap_get_entry(&pl->recursive_hashmap, pe, ent, NULL))
 274                         continue;
 275
 276                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 277                                              pe->pattern,
 278                                              &parent_pattern))
 279                         string_list_insert(&sl, pe->pattern);
 280         }
 281
 282         string_list_sort(&sl);
 283         string_list_remove_duplicates(&sl, 0);
 284
 285         fprintf(fp, "/*\n!/*/\n");
 286
 287         for (i = 0; i < sl.nr; i++) {
 288                 char *pattern = escaped_pattern(sl.items[i].string);
 289
 290                 if (strlen(pattern))
 291                         fprintf(fp, "%s/\n!%s/*/\n", pattern, pattern);
 292                 free(pattern);
 293         }
 294
 295         string_list_clear(&sl, 0);
 296
 297         hashmap_for_each_entry(&pl->recursive_hashmap, &iter, pe, ent) {
 298                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 299                                              pe->pattern,
 300                                              &parent_pattern))
 301                         string_list_insert(&sl, pe->pattern);
 302         }
 303
 304         strbuf_release(&parent_pattern);
 305
 306         string_list_sort(&sl);
 307         string_list_remove_duplicates(&sl, 0);
 308
 309         for (i = 0; i < sl.nr; i++) {
 310                 char *pattern = escaped_pattern(sl.items[i].string);
 311                 fprintf(fp, "%s/\n", pattern);
 312                 free(pattern);
 313         }
 314 }
 315
 316 static int write_patterns_and_update(struct pattern_list *pl)
 317 {
 318         char *sparse_filename;
 319         FILE *fp;
 320         int fd;
 321         struct lock_file lk = LOCK_INIT;
 322         int result;
 323
 324         sparse_filename = get_sparse_checkout_filename();
 325
 326         if (safe_create_leading_directories(sparse_filename))
 327                 die(_("failed to create directory for sparse-checkout file"));
 328
 329         fd = hold_lock_file_for_update(&lk, sparse_filename,
 330                                       LOCK_DIE_ON_ERROR);
 331         free(sparse_filename);
 332
 333         result = update_working_directory(pl);
 334         if (result) {
 335                 rollback_lock_file(&lk);
 336                 clear_pattern_list(pl);
 337                 update_working_directory(NULL);
 338                 return result;
 339         }
 340
 341         fp = xfdopen(fd, "w");
 342
 343         if (core_sparse_checkout_cone)
 344                 write_cone_to_file(fp, pl);
 345         else
 346                 write_patterns_to_file(fp, pl);
 347
 348         fflush(fp);
 349         commit_lock_file(&lk);
 350
 351         clear_pattern_list(pl);
 352
 353         return 0;
 354 }
 355
 356 enum sparse_checkout_mode {
 357         MODE_NO_PATTERNS = 0,
 358         MODE_ALL_PATTERNS = 1,
 359         MODE_CONE_PATTERNS = 2,
 360 };
 361
 362 static int set_config(enum sparse_checkout_mode mode)
 363 {
 364         /* Update to use worktree config, if not already. */
 365         if (init_worktree_config(the_repository)) {
 366                 error(_("failed to initialize worktree config"));
 367                 return 1;
 368         }
 369
 370         if (repo_config_set_worktree_gently(the_repository,
 371                                             "core.sparseCheckout",
 372                                             mode ? "true" : "false") ||
 373             repo_config_set_worktree_gently(the_repository,
 374                                             "core.sparseCheckoutCone",
 375                                             mode == MODE_CONE_PATTERNS ?
 376                                                 "true" : "false"))
 377                 return 1;
 378
 379         if (mode == MODE_NO_PATTERNS)
 380                 return set_sparse_index_config(the_repository, 0);
 381
 382         return 0;
 383 }
 384
 385 static int update_modes(int *cone_mode, int *sparse_index)
 386 {
 387         int mode, record_mode;
 388
 389         /* Determine if we need to record the mode; ensure sparse checkout on */
 390         record_mode = (*cone_mode != -1) || !core_apply_sparse_checkout;
 391
 392         /* If not specified, use previous definition of cone mode */
 393         if (*cone_mode == -1 && core_apply_sparse_checkout)
 394                 *cone_mode = core_sparse_checkout_cone;
 395
 396         /* Set cone/non-cone mode appropriately */
 397         core_apply_sparse_checkout = 1;
 398         if (*cone_mode == 1) {
 399                 mode = MODE_CONE_PATTERNS;
 400                 core_sparse_checkout_cone = 1;
 401         } else {
 402                 mode = MODE_ALL_PATTERNS;
 403                 core_sparse_checkout_cone = 0;
 404         }
 405         if (record_mode && set_config(mode))
 406                 return 1;
 407
 408         /* Set sparse-index/non-sparse-index mode if specified */
 409         if (*sparse_index >= 0) {
 410                 if (set_sparse_index_config(the_repository, *sparse_index) < 0)
 411                         die(_("failed to modify sparse-index config"));
 412
 413                 /* force an index rewrite */
 414                 repo_read_index(the_repository);
 415                 the_repository->index->updated_workdir = 1;
 416         }
 417
 418         return 0;
 419 }
 420
 421 static char const * const builtin_sparse_checkout_init_usage[] = {
 422         "git sparse-checkout init [--cone] [--[no-]sparse-index]",
 423         NULL
 424 };
 425
 426 static struct sparse_checkout_init_opts {
 427         int cone_mode;
 428         int sparse_index;
 429 } init_opts;
 430
 431 static int sparse_checkout_init(int argc, const char **argv)
 432 {
 433         struct pattern_list pl;
 434         char *sparse_filename;
 435         int res;
 436         struct object_id oid;
 437         struct strbuf pattern = STRBUF_INIT;
 438
 439         static struct option builtin_sparse_checkout_init_options[] = {
 440                 OPT_BOOL(0, "cone", &init_opts.cone_mode,
 441                          N_("initialize the sparse-checkout in cone mode")),
 442                 OPT_BOOL(0, "sparse-index", &init_opts.sparse_index,
 443                          N_("toggle the use of a sparse index")),
 444                 OPT_END(),
 445         };
 446
 447         repo_read_index(the_repository);
 448
 449         init_opts.cone_mode = -1;
 450         init_opts.sparse_index = -1;
 451
 452         argc = parse_options(argc, argv, NULL,
 453                              builtin_sparse_checkout_init_options,
 454                              builtin_sparse_checkout_init_usage, 0);
 455
 456         if (update_modes(&init_opts.cone_mode, &init_opts.sparse_index))
 457                 return 1;
 458
 459         memset(&pl, 0, sizeof(pl));
 460
 461         sparse_filename = get_sparse_checkout_filename();
 462         res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL, 0);
 463
 464         /* If we already have a sparse-checkout file, use it. */
 465         if (res >= 0) {
 466                 free(sparse_filename);
 467                 return update_working_directory(NULL);
 468         }
 469
 470         if (get_oid("HEAD", &oid)) {
 471                 FILE *fp;
 472
 473                 /* assume we are in a fresh repo, but update the sparse-checkout file */
 474                 if (safe_create_leading_directories(sparse_filename))
 475                         die(_("unable to create leading directories of %s"),
 476                             sparse_filename);
 477                 fp = xfopen(sparse_filename, "w");
 478                 if (!fp)
 479                         die(_("failed to open '%s'"), sparse_filename);
 480
 481                 free(sparse_filename);
 482                 fprintf(fp, "/*\n!/*/\n");
 483                 fclose(fp);
 484                 return 0;
 485         }
 486
 487         strbuf_addstr(&pattern, "/*");
 488         add_pattern(strbuf_detach(&pattern, NULL), empty_base, 0, &pl, 0);
 489         strbuf_addstr(&pattern, "!/*/");
 490         add_pattern(strbuf_detach(&pattern, NULL), empty_base, 0, &pl, 0);
 491         pl.use_cone_patterns = init_opts.cone_mode;
 492
 493         return write_patterns_and_update(&pl);
 494 }
 495
 496 static void insert_recursive_pattern(struct pattern_list *pl, struct strbuf *path)
 497 {
 498         struct pattern_entry *e = xmalloc(sizeof(*e));
 499         e->patternlen = path->len;
 500         e->pattern = strbuf_detach(path, NULL);
 501         hashmap_entry_init(&e->ent, fspathhash(e->pattern));
 502
 503         hashmap_add(&pl->recursive_hashmap, &e->ent);
 504
 505         while (e->patternlen) {
 506                 char *slash = strrchr(e->pattern, '/');
 507                 char *oldpattern = e->pattern;
 508                 size_t newlen;
 509
 510                 if (!slash || slash == e->pattern)
 511                         break;
 512
 513                 newlen = slash - e->pattern;
 514                 e = xmalloc(sizeof(struct pattern_entry));
 515                 e->patternlen = newlen;
 516                 e->pattern = xstrndup(oldpattern, newlen);
 517                 hashmap_entry_init(&e->ent, fspathhash(e->pattern));
 518
 519                 if (!hashmap_get_entry(&pl->parent_hashmap, e, ent, NULL))
 520                         hashmap_add(&pl->parent_hashmap, &e->ent);
 521         }
 522 }
 523
 524 static void strbuf_to_cone_pattern(struct strbuf *line, struct pattern_list *pl)
 525 {
 526         strbuf_trim(line);
 527
 528         strbuf_trim_trailing_dir_sep(line);
 529
 530         if (strbuf_normalize_path(line))
 531                 die(_("could not normalize path %s"), line->buf);
 532
 533         if (!line->len)
 534                 return;
 535
 536         if (line->buf[0] != '/')
 537                 strbuf_insertstr(line, 0, "/");
 538
 539         insert_recursive_pattern(pl, line);
 540 }
 541
 542 static void add_patterns_from_input(struct pattern_list *pl,
 543                                     int argc, const char **argv,
 544                                     int use_stdin)
 545 {
 546         int i;
 547         if (core_sparse_checkout_cone) {
 548                 struct strbuf line = STRBUF_INIT;
 549
 550                 hashmap_init(&pl->recursive_hashmap, pl_hashmap_cmp, NULL, 0);
 551                 hashmap_init(&pl->parent_hashmap, pl_hashmap_cmp, NULL, 0);
 552                 pl->use_cone_patterns = 1;
 553
 554                 if (use_stdin) {
 555                         struct strbuf unquoted = STRBUF_INIT;
 556                         while (!strbuf_getline(&line, stdin)) {
 557                                 if (line.buf[0] == '"') {
 558                                         strbuf_reset(&unquoted);
 559                                         if (unquote_c_style(&unquoted, line.buf, NULL))
 560                                                 die(_("unable to unquote C-style string '%s'"),
 561                                                 line.buf);
 562
 563                                         strbuf_swap(&unquoted, &line);
 564                                 }
 565
 566                                 strbuf_to_cone_pattern(&line, pl);
 567                         }
 568
 569                         strbuf_release(&unquoted);
 570                 } else {
 571                         for (i = 0; i < argc; i++) {
 572                                 strbuf_setlen(&line, 0);
 573                                 strbuf_addstr(&line, argv[i]);
 574                                 strbuf_to_cone_pattern(&line, pl);
 575                         }
 576                 }
 577         } else {
 578                 if (use_stdin) {
 579                         struct strbuf line = STRBUF_INIT;
 580
 581                         while (!strbuf_getline(&line, stdin)) {
 582                                 size_t len;
 583                                 char *buf = strbuf_detach(&line, &len);
 584                                 add_pattern(buf, empty_base, 0, pl, 0);
 585                         }
 586                 } else {
 587                         for (i = 0; i < argc; i++)
 588                                 add_pattern(argv[i], empty_base, 0, pl, 0);
 589                 }
 590         }
 591 }
 592
 593 enum modify_type {
 594         REPLACE,
 595         ADD,
 596 };
 597
 598 static void add_patterns_cone_mode(int argc, const char **argv,
 599                                    struct pattern_list *pl,
 600                                    int use_stdin)
 601 {
 602         struct strbuf buffer = STRBUF_INIT;
 603         struct pattern_entry *pe;
 604         struct hashmap_iter iter;
 605         struct pattern_list existing;
 606         char *sparse_filename = get_sparse_checkout_filename();
 607
 608         add_patterns_from_input(pl, argc, argv, use_stdin);
 609
 610         memset(&existing, 0, sizeof(existing));
 611         existing.use_cone_patterns = core_sparse_checkout_cone;
 612
 613         if (add_patterns_from_file_to_list(sparse_filename, "", 0,
 614                                            &existing, NULL, 0))
 615                 die(_("unable to load existing sparse-checkout patterns"));
 616         free(sparse_filename);
 617
 618         if (!existing.use_cone_patterns)
 619                 die(_("existing sparse-checkout patterns do not use cone mode"));
 620
 621         hashmap_for_each_entry(&existing.recursive_hashmap, &iter, pe, ent) {
 622                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 623                                         pe->pattern, &buffer) ||
 624                     !hashmap_contains_parent(&pl->parent_hashmap,
 625                                         pe->pattern, &buffer)) {
 626                         strbuf_reset(&buffer);
 627                         strbuf_addstr(&buffer, pe->pattern);
 628                         insert_recursive_pattern(pl, &buffer);
 629                 }
 630         }
 631
 632         clear_pattern_list(&existing);
 633         strbuf_release(&buffer);
 634 }
 635
 636 static void add_patterns_literal(int argc, const char **argv,
 637                                  struct pattern_list *pl,
 638                                  int use_stdin)
 639 {
 640         char *sparse_filename = get_sparse_checkout_filename();
 641         if (add_patterns_from_file_to_list(sparse_filename, "", 0,
 642                                            pl, NULL, 0))
 643                 die(_("unable to load existing sparse-checkout patterns"));
 644         free(sparse_filename);
 645         add_patterns_from_input(pl, argc, argv, use_stdin);
 646 }
 647
 648 static int modify_pattern_list(int argc, const char **argv, int use_stdin,
 649                                enum modify_type m)
 650 {
 651         int result;
 652         int changed_config = 0;
 653         struct pattern_list *pl = xcalloc(1, sizeof(*pl));
 654
 655         switch (m) {
 656         case ADD:
 657                 if (core_sparse_checkout_cone)
 658                         add_patterns_cone_mode(argc, argv, pl, use_stdin);
 659                 else
 660                         add_patterns_literal(argc, argv, pl, use_stdin);
 661                 break;
 662
 663         case REPLACE:
 664                 add_patterns_from_input(pl, argc, argv, use_stdin);
 665                 break;
 666         }
 667
 668         if (!core_apply_sparse_checkout) {
 669                 set_config(MODE_ALL_PATTERNS);
 670                 core_apply_sparse_checkout = 1;
 671                 changed_config = 1;
 672         }
 673
 674         result = write_patterns_and_update(pl);
 675
 676         if (result && changed_config)
 677                 set_config(MODE_NO_PATTERNS);
 678
 679         clear_pattern_list(pl);
 680         free(pl);
 681         return result;
 682 }
 683
 684 static void sanitize_paths(int argc, const char **argv,
 685                            const char *prefix, int skip_checks)
 686 {
 687         int i;
 688
 689         if (!argc)
 690                 return;
 691
 692         if (prefix && *prefix && core_sparse_checkout_cone) {
 693                 /*
 694                  * The args are not pathspecs, so unfortunately we
 695                  * cannot imitate how cmd_add() uses parse_pathspec().
 696                  */
 697                 int prefix_len = strlen(prefix);
 698
 699                 for (i = 0; i < argc; i++)
 700                         argv[i] = prefix_path(prefix, prefix_len, argv[i]);
 701         }
 702
 703         if (skip_checks)
 704                 return;
 705
 706         if (prefix && *prefix && !core_sparse_checkout_cone)
 707                 die(_("please run from the toplevel directory in non-cone mode"));
 708
 709         if (core_sparse_checkout_cone) {
 710                 for (i = 0; i < argc; i++) {
 711                         if (argv[i][0] == '/')
 712                                 die(_("specify directories rather than patterns (no leading slash)"));
 713                         if (argv[i][0] == '!')
 714                                 die(_("specify directories rather than patterns.  If your directory starts with a '!', pass --skip-checks"));
 715                         if (strpbrk(argv[i], "*?[]"))
 716                                 die(_("specify directories rather than patterns.  If your directory really has any of '*?[]\\' in it, pass --skip-checks"));
 717                 }
 718         }
 719
 720         for (i = 0; i < argc; i++) {
 721                 struct cache_entry *ce;
 722                 struct index_state *index = the_repository->index;
 723                 int pos = index_name_pos(index, argv[i], strlen(argv[i]));
 724
 725                 if (pos < 0)
 726                         continue;
 727                 ce = index->cache[pos];
 728                 if (S_ISSPARSEDIR(ce->ce_mode))
 729                         continue;
 730
 731                 if (core_sparse_checkout_cone)
 732                         die(_("'%s' is not a directory; to treat it as a directory anyway, rerun with --skip-checks"), argv[i]);
 733                 else
 734                         warning(_("pass a leading slash before paths such as '%s' if you want a single file (see NON-CONE PROBLEMS in the git-sparse-checkout manual)."), argv[i]);
 735         }
 736 }
 737
 738 static char const * const builtin_sparse_checkout_add_usage[] = {
 739         N_("git sparse-checkout add [--skip-checks] (--stdin | <patterns>)"),
 740         NULL
 741 };
 742
 743 static struct sparse_checkout_add_opts {
 744         int skip_checks;
 745         int use_stdin;
 746 } add_opts;
 747
 748 static int sparse_checkout_add(int argc, const char **argv, const char *prefix)
 749 {
 750         static struct option builtin_sparse_checkout_add_options[] = {
 751                 OPT_BOOL_F(0, "skip-checks", &add_opts.skip_checks,
 752                            N_("skip some sanity checks on the given paths that might give false positives"),
 753                            PARSE_OPT_NONEG),
 754                 OPT_BOOL(0, "stdin", &add_opts.use_stdin,
 755                          N_("read patterns from standard in")),
 756                 OPT_END(),
 757         };
 758
 759         if (!core_apply_sparse_checkout)
 760                 die(_("no sparse-checkout to add to"));
 761
 762         repo_read_index(the_repository);
 763
 764         argc = parse_options(argc, argv, prefix,
 765                              builtin_sparse_checkout_add_options,
 766                              builtin_sparse_checkout_add_usage,
 767                              PARSE_OPT_KEEP_UNKNOWN);
 768
 769         sanitize_paths(argc, argv, prefix, add_opts.skip_checks);
 770
 771         return modify_pattern_list(argc, argv, add_opts.use_stdin, ADD);
 772 }
 773
 774 static char const * const builtin_sparse_checkout_set_usage[] = {
 775         N_("git sparse-checkout set [--[no-]cone] [--[no-]sparse-index] [--skip-checks] (--stdin | <patterns>)"),
 776         NULL
 777 };
 778
 779 static struct sparse_checkout_set_opts {
 780         int cone_mode;
 781         int sparse_index;
 782         int skip_checks;
 783         int use_stdin;
 784 } set_opts;
 785
 786 static int sparse_checkout_set(int argc, const char **argv, const char *prefix)
 787 {
 788         int default_patterns_nr = 2;
 789         const char *default_patterns[] = {"/*", "!/*/", NULL};
 790
 791         static struct option builtin_sparse_checkout_set_options[] = {
 792                 OPT_BOOL(0, "cone", &set_opts.cone_mode,
 793                          N_("initialize the sparse-checkout in cone mode")),
 794                 OPT_BOOL(0, "sparse-index", &set_opts.sparse_index,
 795                          N_("toggle the use of a sparse index")),
 796                 OPT_BOOL_F(0, "skip-checks", &set_opts.skip_checks,
 797                            N_("skip some sanity checks on the given paths that might give false positives"),
 798                            PARSE_OPT_NONEG),
 799                 OPT_BOOL_F(0, "stdin", &set_opts.use_stdin,
 800                            N_("read patterns from standard in"),
 801                            PARSE_OPT_NONEG),
 802                 OPT_END(),
 803         };
 804
 805         repo_read_index(the_repository);
 806
 807         set_opts.cone_mode = -1;
 808         set_opts.sparse_index = -1;
 809
 810         argc = parse_options(argc, argv, prefix,
 811                              builtin_sparse_checkout_set_options,
 812                              builtin_sparse_checkout_set_usage,
 813                              PARSE_OPT_KEEP_UNKNOWN);
 814
 815         if (update_modes(&set_opts.cone_mode, &set_opts.sparse_index))
 816                 return 1;
 817
 818         /*
 819          * Cone mode automatically specifies the toplevel directory.  For
 820          * non-cone mode, if nothing is specified, manually select just the
 821          * top-level directory (much as 'init' would do).
 822          */
 823         if (!core_sparse_checkout_cone && argc == 0) {
 824                 argv = default_patterns;
 825                 argc = default_patterns_nr;
 826         } else {
 827                 sanitize_paths(argc, argv, prefix, set_opts.skip_checks);
 828         }
 829
 830         return modify_pattern_list(argc, argv, set_opts.use_stdin, REPLACE);
 831 }
 832
 833 static char const * const builtin_sparse_checkout_reapply_usage[] = {
 834         "git sparse-checkout reapply [--[no-]cone] [--[no-]sparse-index]",
 835         NULL
 836 };
 837
 838 static struct sparse_checkout_reapply_opts {
 839         int cone_mode;
 840         int sparse_index;
 841 } reapply_opts;
 842
 843 static int sparse_checkout_reapply(int argc, const char **argv)
 844 {
 845         static struct option builtin_sparse_checkout_reapply_options[] = {
 846                 OPT_BOOL(0, "cone", &reapply_opts.cone_mode,
 847                          N_("initialize the sparse-checkout in cone mode")),
 848                 OPT_BOOL(0, "sparse-index", &reapply_opts.sparse_index,
 849                          N_("toggle the use of a sparse index")),
 850                 OPT_END(),
 851         };
 852
 853         if (!core_apply_sparse_checkout)
 854                 die(_("must be in a sparse-checkout to reapply sparsity patterns"));
 855
 856         reapply_opts.cone_mode = -1;
 857         reapply_opts.sparse_index = -1;
 858
 859         argc = parse_options(argc, argv, NULL,
 860                              builtin_sparse_checkout_reapply_options,
 861                              builtin_sparse_checkout_reapply_usage, 0);
 862
 863         repo_read_index(the_repository);
 864
 865         if (update_modes(&reapply_opts.cone_mode, &reapply_opts.sparse_index))
 866                 return 1;
 867
 868         return update_working_directory(NULL);
 869 }
 870
 871 static char const * const builtin_sparse_checkout_disable_usage[] = {
 872         "git sparse-checkout disable",
 873         NULL
 874 };
 875
 876 static int sparse_checkout_disable(int argc, const char **argv)
 877 {
 878         static struct option builtin_sparse_checkout_disable_options[] = {
 879                 OPT_END(),
 880         };
 881         struct pattern_list pl;
 882         struct strbuf match_all = STRBUF_INIT;
 883
 884         /*
 885          * We do not exit early if !core_apply_sparse_checkout; due to the
 886          * ability for users to manually muck things up between
 887          *   direct editing of .git/info/sparse-checkout
 888          *   running read-tree -m u HEAD or update-index --skip-worktree
 889          *   direct toggling of config options
 890          * users might end up with an index with SKIP_WORKTREE bit set on
 891          * some files and not know how to undo it.  So, here we just
 892          * forcibly return to a dense checkout regardless of initial state.
 893          */
 894
 895         argc = parse_options(argc, argv, NULL,
 896                              builtin_sparse_checkout_disable_options,
 897                              builtin_sparse_checkout_disable_usage, 0);
 898
 899         repo_read_index(the_repository);
 900
 901         memset(&pl, 0, sizeof(pl));
 902         hashmap_init(&pl.recursive_hashmap, pl_hashmap_cmp, NULL, 0);
 903         hashmap_init(&pl.parent_hashmap, pl_hashmap_cmp, NULL, 0);
 904         pl.use_cone_patterns = 0;
 905         core_apply_sparse_checkout = 1;
 906
 907         strbuf_addstr(&match_all, "/*");
 908         add_pattern(strbuf_detach(&match_all, NULL), empty_base, 0, &pl, 0);
 909
 910         prepare_repo_settings(the_repository);
 911         the_repository->settings.sparse_index = 0;
 912
 913         if (update_working_directory(&pl))
 914                 die(_("error while refreshing working directory"));
 915
 916         clear_pattern_list(&pl);
 917         return set_config(MODE_NO_PATTERNS);
 918 }
 919
 920 int cmd_sparse_checkout(int argc, const char **argv, const char *prefix)
 921 {
 922         static struct option builtin_sparse_checkout_options[] = {
 923                 OPT_END(),
 924         };
 925
 926         if (argc == 2 && !strcmp(argv[1], "-h"))
 927                 usage_with_options(builtin_sparse_checkout_usage,
 928                                    builtin_sparse_checkout_options);
 929
 930         argc = parse_options(argc, argv, prefix,
 931                              builtin_sparse_checkout_options,
 932                              builtin_sparse_checkout_usage,
 933                              PARSE_OPT_STOP_AT_NON_OPTION);
 934
 935         git_config(git_default_config, NULL);
 936
 937         if (argc > 0) {
 938                 if (!strcmp(argv[0], "list"))
 939                         return sparse_checkout_list(argc, argv);
 940                 if (!strcmp(argv[0], "init"))
 941                         return sparse_checkout_init(argc, argv);
 942                 if (!strcmp(argv[0], "set"))
 943                         return sparse_checkout_set(argc, argv, prefix);
 944                 if (!strcmp(argv[0], "add"))
 945                         return sparse_checkout_add(argc, argv, prefix);
 946                 if (!strcmp(argv[0], "reapply"))
 947                         return sparse_checkout_reapply(argc, argv);
 948                 if (!strcmp(argv[0], "disable"))
 949                         return sparse_checkout_disable(argc, argv);
 950         }
 951
 952         usage_with_options(builtin_sparse_checkout_usage,
 953                            builtin_sparse_checkout_options);
 954 }