builtin/stash.c

   1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   2 #include "builtin.h"
   3 #include "config.h"
   4 #include "parse-options.h"
   5 #include "refs.h"
   6 #include "lockfile.h"
   7 #include "cache-tree.h"
   8 #include "unpack-trees.h"
   9 #include "merge-recursive.h"
  10 #include "strvec.h"
  11 #include "run-command.h"
  12 #include "dir.h"
  13 #include "entry.h"
  14 #include "rerere.h"
  15 #include "revision.h"
  16 #include "log-tree.h"
  17 #include "diffcore.h"
  18 #include "exec-cmd.h"
  19 #include "entry.h"
  20
  21 #define INCLUDE_ALL_FILES 2
  22
  23 static const char * const git_stash_usage[] = {
  24         N_("git stash list [<options>]"),
  25         N_("git stash show [<options>] [<stash>]"),
  26         N_("git stash drop [-q|--quiet] [<stash>]"),
  27         N_("git stash ( pop | apply ) [--index] [-q|--quiet] [<stash>]"),
  28         N_("git stash branch <branchname> [<stash>]"),
  29         N_("git stash clear"),
  30         N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
  31            "          [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n"
  32            "          [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
  33            "          [--] [<pathspec>...]]"),
  34         N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
  35            "          [-u|--include-untracked] [-a|--all] [<message>]"),
  36         NULL
  37 };
  38
  39 static const char * const git_stash_list_usage[] = {
  40         N_("git stash list [<options>]"),
  41         NULL
  42 };
  43
  44 static const char * const git_stash_show_usage[] = {
  45         N_("git stash show [<options>] [<stash>]"),
  46         NULL
  47 };
  48
  49 static const char * const git_stash_drop_usage[] = {
  50         N_("git stash drop [-q|--quiet] [<stash>]"),
  51         NULL
  52 };
  53
  54 static const char * const git_stash_pop_usage[] = {
  55         N_("git stash pop [--index] [-q|--quiet] [<stash>]"),
  56         NULL
  57 };
  58
  59 static const char * const git_stash_apply_usage[] = {
  60         N_("git stash apply [--index] [-q|--quiet] [<stash>]"),
  61         NULL
  62 };
  63
  64 static const char * const git_stash_branch_usage[] = {
  65         N_("git stash branch <branchname> [<stash>]"),
  66         NULL
  67 };
  68
  69 static const char * const git_stash_clear_usage[] = {
  70         N_("git stash clear"),
  71         NULL
  72 };
  73
  74 static const char * const git_stash_store_usage[] = {
  75         N_("git stash store [-m|--message <message>] [-q|--quiet] <commit>"),
  76         NULL
  77 };
  78
  79 static const char * const git_stash_push_usage[] = {
  80         N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
  81            "          [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n"
  82            "          [--] [<pathspec>...]]"),
  83         NULL
  84 };
  85
  86 static const char * const git_stash_save_usage[] = {
  87         N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
  88            "          [-u|--include-untracked] [-a|--all] [<message>]"),
  89         NULL
  90 };
  91
  92 static const char ref_stash[] = "refs/stash";
  93 static struct strbuf stash_index_path = STRBUF_INIT;
  94
  95 /*
  96  * w_commit is set to the commit containing the working tree
  97  * b_commit is set to the base commit
  98  * i_commit is set to the commit containing the index tree
  99  * u_commit is set to the commit containing the untracked files tree
 100  * w_tree is set to the working tree
 101  * b_tree is set to the base tree
 102  * i_tree is set to the index tree
 103  * u_tree is set to the untracked files tree
 104  */
 105 struct stash_info {
 106         struct object_id w_commit;
 107         struct object_id b_commit;
 108         struct object_id i_commit;
 109         struct object_id u_commit;
 110         struct object_id w_tree;
 111         struct object_id b_tree;
 112         struct object_id i_tree;
 113         struct object_id u_tree;
 114         struct strbuf revision;
 115         int is_stash_ref;
 116         int has_u;
 117 };
 118
 119 static void free_stash_info(struct stash_info *info)
 120 {
 121         strbuf_release(&info->revision);
 122 }
 123
 124 static void assert_stash_like(struct stash_info *info, const char *revision)
 125 {
 126         if (get_oidf(&info->b_commit, "%s^1", revision) ||
 127             get_oidf(&info->w_tree, "%s:", revision) ||
 128             get_oidf(&info->b_tree, "%s^1:", revision) ||
 129             get_oidf(&info->i_tree, "%s^2:", revision))
 130                 die(_("'%s' is not a stash-like commit"), revision);
 131 }
 132
 133 static int get_stash_info(struct stash_info *info, int argc, const char **argv)
 134 {
 135         int ret;
 136         char *end_of_rev;
 137         char *expanded_ref;
 138         const char *revision;
 139         const char *commit = NULL;
 140         struct object_id dummy;
 141         struct strbuf symbolic = STRBUF_INIT;
 142
 143         if (argc > 1) {
 144                 int i;
 145                 struct strbuf refs_msg = STRBUF_INIT;
 146
 147                 for (i = 0; i < argc; i++)
 148                         strbuf_addf(&refs_msg, " '%s'", argv[i]);
 149
 150                 fprintf_ln(stderr, _("Too many revisions specified:%s"),
 151                            refs_msg.buf);
 152                 strbuf_release(&refs_msg);
 153
 154                 return -1;
 155         }
 156
 157         if (argc == 1)
 158                 commit = argv[0];
 159
 160         strbuf_init(&info->revision, 0);
 161         if (!commit) {
 162                 if (!ref_exists(ref_stash)) {
 163                         free_stash_info(info);
 164                         fprintf_ln(stderr, _("No stash entries found."));
 165                         return -1;
 166                 }
 167
 168                 strbuf_addf(&info->revision, "%s@{0}", ref_stash);
 169         } else if (strspn(commit, "0123456789") == strlen(commit)) {
 170                 strbuf_addf(&info->revision, "%s@{%s}", ref_stash, commit);
 171         } else {
 172                 strbuf_addstr(&info->revision, commit);
 173         }
 174
 175         revision = info->revision.buf;
 176
 177         if (get_oid(revision, &info->w_commit)) {
 178                 error(_("%s is not a valid reference"), revision);
 179                 free_stash_info(info);
 180                 return -1;
 181         }
 182
 183         assert_stash_like(info, revision);
 184
 185         info->has_u = !get_oidf(&info->u_tree, "%s^3:", revision);
 186
 187         end_of_rev = strchrnul(revision, '@');
 188         strbuf_add(&symbolic, revision, end_of_rev - revision);
 189
 190         ret = dwim_ref(symbolic.buf, symbolic.len, &dummy, &expanded_ref, 0);
 191         strbuf_release(&symbolic);
 192         switch (ret) {
 193         case 0: /* Not found, but valid ref */
 194                 info->is_stash_ref = 0;
 195                 break;
 196         case 1:
 197                 info->is_stash_ref = !strcmp(expanded_ref, ref_stash);
 198                 break;
 199         default: /* Invalid or ambiguous */
 200                 free_stash_info(info);
 201         }
 202
 203         free(expanded_ref);
 204         return !(ret == 0 || ret == 1);
 205 }
 206
 207 static int do_clear_stash(void)
 208 {
 209         struct object_id obj;
 210         if (get_oid(ref_stash, &obj))
 211                 return 0;
 212
 213         return delete_ref(NULL, ref_stash, &obj, 0);
 214 }
 215
 216 static int clear_stash(int argc, const char **argv, const char *prefix)
 217 {
 218         struct option options[] = {
 219                 OPT_END()
 220         };
 221
 222         argc = parse_options(argc, argv, prefix, options,
 223                              git_stash_clear_usage,
 224                              PARSE_OPT_STOP_AT_NON_OPTION);
 225
 226         if (argc)
 227                 return error(_("git stash clear with arguments is "
 228                                "unimplemented"));
 229
 230         return do_clear_stash();
 231 }
 232
 233 static int reset_tree(struct object_id *i_tree, int update, int reset)
 234 {
 235         int nr_trees = 1;
 236         struct unpack_trees_options opts;
 237         struct tree_desc t[MAX_UNPACK_TREES];
 238         struct tree *tree;
 239         struct lock_file lock_file = LOCK_INIT;
 240
 241         read_cache_preload(NULL);
 242         if (refresh_cache(REFRESH_QUIET))
 243                 return -1;
 244
 245         hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
 246
 247         memset(&opts, 0, sizeof(opts));
 248
 249         tree = parse_tree_indirect(i_tree);
 250         if (parse_tree(tree))
 251                 return -1;
 252
 253         init_tree_desc(t, tree->buffer, tree->size);
 254
 255         opts.head_idx = 1;
 256         opts.src_index = &the_index;
 257         opts.dst_index = &the_index;
 258         opts.merge = 1;
 259         opts.reset = reset;
 260         opts.update = update;
 261         opts.fn = oneway_merge;
 262
 263         if (unpack_trees(nr_trees, t, &opts))
 264                 return -1;
 265
 266         if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
 267                 return error(_("unable to write new index file"));
 268
 269         return 0;
 270 }
 271
 272 static int diff_tree_binary(struct strbuf *out, struct object_id *w_commit)
 273 {
 274         struct child_process cp = CHILD_PROCESS_INIT;
 275         const char *w_commit_hex = oid_to_hex(w_commit);
 276
 277         /*
 278          * Diff-tree would not be very hard to replace with a native function,
 279          * however it should be done together with apply_cached.
 280          */
 281         cp.git_cmd = 1;
 282         strvec_pushl(&cp.args, "diff-tree", "--binary", NULL);
 283         strvec_pushf(&cp.args, "%s^2^..%s^2", w_commit_hex, w_commit_hex);
 284
 285         return pipe_command(&cp, NULL, 0, out, 0, NULL, 0);
 286 }
 287
 288 static int apply_cached(struct strbuf *out)
 289 {
 290         struct child_process cp = CHILD_PROCESS_INIT;
 291
 292         /*
 293          * Apply currently only reads either from stdin or a file, thus
 294          * apply_all_patches would have to be updated to optionally take a
 295          * buffer.
 296          */
 297         cp.git_cmd = 1;
 298         strvec_pushl(&cp.args, "apply", "--cached", NULL);
 299         return pipe_command(&cp, out->buf, out->len, NULL, 0, NULL, 0);
 300 }
 301
 302 static int reset_head(void)
 303 {
 304         struct child_process cp = CHILD_PROCESS_INIT;
 305
 306         /*
 307          * Reset is overall quite simple, however there is no current public
 308          * API for resetting.
 309          */
 310         cp.git_cmd = 1;
 311         strvec_push(&cp.args, "reset");
 312
 313         return run_command(&cp);
 314 }
 315
 316 static void add_diff_to_buf(struct diff_queue_struct *q,
 317                             struct diff_options *options,
 318                             void *data)
 319 {
 320         int i;
 321
 322         for (i = 0; i < q->nr; i++) {
 323                 strbuf_addstr(data, q->queue[i]->one->path);
 324
 325                 /* NUL-terminate: will be fed to update-index -z */
 326                 strbuf_addch(data, '\0');
 327         }
 328 }
 329
 330 static int restore_untracked(struct object_id *u_tree)
 331 {
 332         int res;
 333         struct child_process cp = CHILD_PROCESS_INIT;
 334
 335         /*
 336          * We need to run restore files from a given index, but without
 337          * affecting the current index, so we use GIT_INDEX_FILE with
 338          * run_command to fork processes that will not interfere.
 339          */
 340         cp.git_cmd = 1;
 341         strvec_push(&cp.args, "read-tree");
 342         strvec_push(&cp.args, oid_to_hex(u_tree));
 343         strvec_pushf(&cp.env_array, "GIT_INDEX_FILE=%s",
 344                      stash_index_path.buf);
 345         if (run_command(&cp)) {
 346                 remove_path(stash_index_path.buf);
 347                 return -1;
 348         }
 349
 350         child_process_init(&cp);
 351         cp.git_cmd = 1;
 352         strvec_pushl(&cp.args, "checkout-index", "--all", NULL);
 353         strvec_pushf(&cp.env_array, "GIT_INDEX_FILE=%s",
 354                      stash_index_path.buf);
 355
 356         res = run_command(&cp);
 357         remove_path(stash_index_path.buf);
 358         return res;
 359 }
 360
 361 static void unstage_changes_unless_new(struct object_id *orig_tree)
 362 {
 363         /*
 364          * When we enter this function, there has been a clean merge of
 365          * relevant trees, and the merge logic always stages whatever merges
 366          * cleanly.  We want to unstage those changes, unless it corresponds
 367          * to a file that didn't exist as of orig_tree.
 368          *
 369          * However, if any SKIP_WORKTREE path is modified relative to
 370          * orig_tree, then we want to clear the SKIP_WORKTREE bit and write
 371          * it to the worktree before unstaging.
 372          */
 373
 374         struct checkout state = CHECKOUT_INIT;
 375         struct diff_options diff_opts;
 376         struct lock_file lock = LOCK_INIT;
 377         int i;
 378
 379         /* If any entries have skip_worktree set, we'll have to check 'em out */
 380         state.force = 1;
 381         state.quiet = 1;
 382         state.refresh_cache = 1;
 383         state.istate = &the_index;
 384
 385         /*
 386          * Step 1: get a difference between orig_tree (which corresponding
 387          * to the index before a merge was run) and the current index
 388          * (reflecting the changes brought in by the merge).
 389          */
 390         diff_setup(&diff_opts);
 391         diff_opts.flags.recursive = 1;
 392         diff_opts.detect_rename = 0;
 393         diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
 394         diff_setup_done(&diff_opts);
 395
 396         do_diff_cache(orig_tree, &diff_opts);
 397         diffcore_std(&diff_opts);
 398
 399         /* Iterate over the paths that changed due to the merge... */
 400         for (i = 0; i < diff_queued_diff.nr; i++) {
 401                 struct diff_filepair *p;
 402                 struct cache_entry *ce;
 403                 int pos;
 404
 405                 /* Look up the path's position in the current index. */
 406                 p = diff_queued_diff.queue[i];
 407                 pos = index_name_pos(&the_index, p->two->path,
 408                                      strlen(p->two->path));
 409
 410                 /*
 411                  * Step 2: Place changes in the working tree
 412                  *
 413                  * Stash is about restoring changes *to the working tree*.
 414                  * So if the merge successfully got a new version of some
 415                  * path, but left it out of the working tree, then clear the
 416                  * SKIP_WORKTREE bit and write it to the working tree.
 417                  */
 418                 if (pos >= 0 && ce_skip_worktree(active_cache[pos])) {
 419                         struct stat st;
 420
 421                         ce = active_cache[pos];
 422                         if (!lstat(ce->name, &st)) {
 423                                 /* Conflicting path present; relocate it */
 424                                 struct strbuf new_path = STRBUF_INIT;
 425                                 int fd;
 426
 427                                 strbuf_addf(&new_path,
 428                                             "%s.stash.XXXXXX", ce->name);
 429                                 fd = xmkstemp(new_path.buf);
 430                                 close(fd);
 431                                 printf(_("WARNING: Untracked file in way of "
 432                                          "tracked file!  Renaming\n "
 433                                          "           %s -> %s\n"
 434                                          "         to make room.\n"),
 435                                        ce->name, new_path.buf);
 436                                 if (rename(ce->name, new_path.buf))
 437                                         die("Failed to move %s to %s\n",
 438                                             ce->name, new_path.buf);
 439                                 strbuf_release(&new_path);
 440                         }
 441                         checkout_entry(ce, &state, NULL, NULL);
 442                         ce->ce_flags &= ~CE_SKIP_WORKTREE;
 443                 }
 444
 445                 /*
 446                  * Step 3: "unstage" changes, as long as they are still tracked
 447                  */
 448                 if (p->one->oid_valid) {
 449                         /*
 450                          * Path existed in orig_tree; restore index entry
 451                          * from that tree in order to "unstage" the changes.
 452                          */
 453                         int option = ADD_CACHE_OK_TO_REPLACE;
 454                         if (pos < 0)
 455                                 option = ADD_CACHE_OK_TO_ADD;
 456
 457                         ce = make_cache_entry(&the_index,
 458                                               p->one->mode,
 459                                               &p->one->oid,
 460                                               p->one->path,
 461                                               0, 0);
 462                         add_index_entry(&the_index, ce, option);
 463                 }
 464         }
 465         diff_flush(&diff_opts);
 466
 467         /*
 468          * Step 4: write the new index to disk
 469          */
 470         repo_hold_locked_index(the_repository, &lock, LOCK_DIE_ON_ERROR);
 471         if (write_locked_index(&the_index, &lock,
 472                                COMMIT_LOCK | SKIP_IF_UNCHANGED))
 473                 die(_("Unable to write index."));
 474 }
 475
 476 static int do_apply_stash(const char *prefix, struct stash_info *info,
 477                           int index, int quiet)
 478 {
 479         int ret;
 480         int has_index = index;
 481         struct merge_options o;
 482         struct object_id c_tree;
 483         struct object_id index_tree;
 484         struct commit *result;
 485         const struct object_id *bases[1];
 486
 487         read_cache_preload(NULL);
 488         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0))
 489                 return -1;
 490
 491         if (write_cache_as_tree(&c_tree, 0, NULL))
 492                 return error(_("cannot apply a stash in the middle of a merge"));
 493
 494         if (index) {
 495                 if (oideq(&info->b_tree, &info->i_tree) ||
 496                     oideq(&c_tree, &info->i_tree)) {
 497                         has_index = 0;
 498                 } else {
 499                         struct strbuf out = STRBUF_INIT;
 500
 501                         if (diff_tree_binary(&out, &info->w_commit)) {
 502                                 strbuf_release(&out);
 503                                 return error(_("could not generate diff %s^!."),
 504                                              oid_to_hex(&info->w_commit));
 505                         }
 506
 507                         ret = apply_cached(&out);
 508                         strbuf_release(&out);
 509                         if (ret)
 510                                 return error(_("conflicts in index. "
 511                                                "Try without --index."));
 512
 513                         discard_cache();
 514                         read_cache();
 515                         if (write_cache_as_tree(&index_tree, 0, NULL))
 516                                 return error(_("could not save index tree"));
 517
 518                         reset_head();
 519                         discard_cache();
 520                         read_cache();
 521                 }
 522         }
 523
 524         if (info->has_u && restore_untracked(&info->u_tree))
 525                 return error(_("could not restore untracked files from stash"));
 526
 527         init_merge_options(&o, the_repository);
 528
 529         o.branch1 = "Updated upstream";
 530         o.branch2 = "Stashed changes";
 531
 532         if (oideq(&info->b_tree, &c_tree))
 533                 o.branch1 = "Version stash was based on";
 534
 535         if (quiet)
 536                 o.verbosity = 0;
 537
 538         if (o.verbosity >= 3)
 539                 printf_ln(_("Merging %s with %s"), o.branch1, o.branch2);
 540
 541         bases[0] = &info->b_tree;
 542
 543         ret = merge_recursive_generic(&o, &c_tree, &info->w_tree, 1, bases,
 544                                       &result);
 545         if (ret) {
 546                 rerere(0);
 547
 548                 if (index)
 549                         fprintf_ln(stderr, _("Index was not unstashed."));
 550
 551                 return ret;
 552         }
 553
 554         if (has_index) {
 555                 if (reset_tree(&index_tree, 0, 0))
 556                         return -1;
 557         } else {
 558                 unstage_changes_unless_new(&c_tree);
 559         }
 560
 561         if (!quiet) {
 562                 struct child_process cp = CHILD_PROCESS_INIT;
 563
 564                 /*
 565                  * Status is quite simple and could be replaced with calls to
 566                  * wt_status in the future, but it adds complexities which may
 567                  * require more tests.
 568                  */
 569                 cp.git_cmd = 1;
 570                 cp.dir = prefix;
 571                 strvec_pushf(&cp.env_array, GIT_WORK_TREE_ENVIRONMENT"=%s",
 572                              absolute_path(get_git_work_tree()));
 573                 strvec_pushf(&cp.env_array, GIT_DIR_ENVIRONMENT"=%s",
 574                              absolute_path(get_git_dir()));
 575                 strvec_push(&cp.args, "status");
 576                 run_command(&cp);
 577         }
 578
 579         return 0;
 580 }
 581
 582 static int apply_stash(int argc, const char **argv, const char *prefix)
 583 {
 584         int ret;
 585         int quiet = 0;
 586         int index = 0;
 587         struct stash_info info;
 588         struct option options[] = {
 589                 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 590                 OPT_BOOL(0, "index", &index,
 591                          N_("attempt to recreate the index")),
 592                 OPT_END()
 593         };
 594
 595         argc = parse_options(argc, argv, prefix, options,
 596                              git_stash_apply_usage, 0);
 597
 598         if (get_stash_info(&info, argc, argv))
 599                 return -1;
 600
 601         ret = do_apply_stash(prefix, &info, index, quiet);
 602         free_stash_info(&info);
 603         return ret;
 604 }
 605
 606 static int reject_reflog_ent(struct object_id *ooid, struct object_id *noid,
 607                              const char *email, timestamp_t timestamp, int tz,
 608                              const char *message, void *cb_data)
 609 {
 610         return 1;
 611 }
 612
 613 static int reflog_is_empty(const char *refname)
 614 {
 615         return !for_each_reflog_ent(refname, reject_reflog_ent, NULL);
 616 }
 617
 618 static int do_drop_stash(struct stash_info *info, int quiet)
 619 {
 620         int ret;
 621         struct child_process cp_reflog = CHILD_PROCESS_INIT;
 622
 623         /*
 624          * reflog does not provide a simple function for deleting refs. One will
 625          * need to be added to avoid implementing too much reflog code here
 626          */
 627
 628         cp_reflog.git_cmd = 1;
 629         strvec_pushl(&cp_reflog.args, "reflog", "delete", "--updateref",
 630                      "--rewrite", NULL);
 631         strvec_push(&cp_reflog.args, info->revision.buf);
 632         ret = run_command(&cp_reflog);
 633         if (!ret) {
 634                 if (!quiet)
 635                         printf_ln(_("Dropped %s (%s)"), info->revision.buf,
 636                                   oid_to_hex(&info->w_commit));
 637         } else {
 638                 return error(_("%s: Could not drop stash entry"),
 639                              info->revision.buf);
 640         }
 641
 642         if (reflog_is_empty(ref_stash))
 643                 do_clear_stash();
 644
 645         return 0;
 646 }
 647
 648 static void assert_stash_ref(struct stash_info *info)
 649 {
 650         if (!info->is_stash_ref) {
 651                 error(_("'%s' is not a stash reference"), info->revision.buf);
 652                 free_stash_info(info);
 653                 exit(1);
 654         }
 655 }
 656
 657 static int drop_stash(int argc, const char **argv, const char *prefix)
 658 {
 659         int ret;
 660         int quiet = 0;
 661         struct stash_info info;
 662         struct option options[] = {
 663                 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 664                 OPT_END()
 665         };
 666
 667         argc = parse_options(argc, argv, prefix, options,
 668                              git_stash_drop_usage, 0);
 669
 670         if (get_stash_info(&info, argc, argv))
 671                 return -1;
 672
 673         assert_stash_ref(&info);
 674
 675         ret = do_drop_stash(&info, quiet);
 676         free_stash_info(&info);
 677         return ret;
 678 }
 679
 680 static int pop_stash(int argc, const char **argv, const char *prefix)
 681 {
 682         int ret;
 683         int index = 0;
 684         int quiet = 0;
 685         struct stash_info info;
 686         struct option options[] = {
 687                 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 688                 OPT_BOOL(0, "index", &index,
 689                          N_("attempt to recreate the index")),
 690                 OPT_END()
 691         };
 692
 693         argc = parse_options(argc, argv, prefix, options,
 694                              git_stash_pop_usage, 0);
 695
 696         if (get_stash_info(&info, argc, argv))
 697                 return -1;
 698
 699         assert_stash_ref(&info);
 700         if ((ret = do_apply_stash(prefix, &info, index, quiet)))
 701                 printf_ln(_("The stash entry is kept in case "
 702                             "you need it again."));
 703         else
 704                 ret = do_drop_stash(&info, quiet);
 705
 706         free_stash_info(&info);
 707         return ret;
 708 }
 709
 710 static int branch_stash(int argc, const char **argv, const char *prefix)
 711 {
 712         int ret;
 713         const char *branch = NULL;
 714         struct stash_info info;
 715         struct child_process cp = CHILD_PROCESS_INIT;
 716         struct option options[] = {
 717                 OPT_END()
 718         };
 719
 720         argc = parse_options(argc, argv, prefix, options,
 721                              git_stash_branch_usage, 0);
 722
 723         if (!argc) {
 724                 fprintf_ln(stderr, _("No branch name specified"));
 725                 return -1;
 726         }
 727
 728         branch = argv[0];
 729
 730         if (get_stash_info(&info, argc - 1, argv + 1))
 731                 return -1;
 732
 733         cp.git_cmd = 1;
 734         strvec_pushl(&cp.args, "checkout", "-b", NULL);
 735         strvec_push(&cp.args, branch);
 736         strvec_push(&cp.args, oid_to_hex(&info.b_commit));
 737         ret = run_command(&cp);
 738         if (!ret)
 739                 ret = do_apply_stash(prefix, &info, 1, 0);
 740         if (!ret && info.is_stash_ref)
 741                 ret = do_drop_stash(&info, 0);
 742
 743         free_stash_info(&info);
 744
 745         return ret;
 746 }
 747
 748 static int list_stash(int argc, const char **argv, const char *prefix)
 749 {
 750         struct child_process cp = CHILD_PROCESS_INIT;
 751         struct option options[] = {
 752                 OPT_END()
 753         };
 754
 755         argc = parse_options(argc, argv, prefix, options,
 756                              git_stash_list_usage,
 757                              PARSE_OPT_KEEP_UNKNOWN);
 758
 759         if (!ref_exists(ref_stash))
 760                 return 0;
 761
 762         cp.git_cmd = 1;
 763         strvec_pushl(&cp.args, "log", "--format=%gd: %gs", "-g",
 764                      "--first-parent", "-m", NULL);
 765         strvec_pushv(&cp.args, argv);
 766         strvec_push(&cp.args, ref_stash);
 767         strvec_push(&cp.args, "--");
 768         return run_command(&cp);
 769 }
 770
 771 static int show_stat = 1;
 772 static int show_patch;
 773 static int show_include_untracked;
 774 static int use_legacy_stash;
 775
 776 static int git_stash_config(const char *var, const char *value, void *cb)
 777 {
 778         if (!strcmp(var, "stash.showstat")) {
 779                 show_stat = git_config_bool(var, value);
 780                 return 0;
 781         }
 782         if (!strcmp(var, "stash.showpatch")) {
 783                 show_patch = git_config_bool(var, value);
 784                 return 0;
 785         }
 786         if (!strcmp(var, "stash.showincludeuntracked")) {
 787                 show_include_untracked = git_config_bool(var, value);
 788                 return 0;
 789         }
 790         if (!strcmp(var, "stash.usebuiltin")) {
 791                 use_legacy_stash = !git_config_bool(var, value);
 792                 return 0;
 793         }
 794         return git_diff_basic_config(var, value, cb);
 795 }
 796
 797 static void diff_include_untracked(const struct stash_info *info, struct diff_options *diff_opt)
 798 {
 799         const struct object_id *oid[] = { &info->w_commit, &info->u_tree };
 800         struct tree *tree[ARRAY_SIZE(oid)];
 801         struct tree_desc tree_desc[ARRAY_SIZE(oid)];
 802         struct unpack_trees_options unpack_tree_opt = { 0 };
 803         int i;
 804
 805         for (i = 0; i < ARRAY_SIZE(oid); i++) {
 806                 tree[i] = parse_tree_indirect(oid[i]);
 807                 if (parse_tree(tree[i]) < 0)
 808                         die(_("failed to parse tree"));
 809                 init_tree_desc(&tree_desc[i], tree[i]->buffer, tree[i]->size);
 810         }
 811
 812         unpack_tree_opt.head_idx = -1;
 813         unpack_tree_opt.src_index = &the_index;
 814         unpack_tree_opt.dst_index = &the_index;
 815         unpack_tree_opt.merge = 1;
 816         unpack_tree_opt.fn = stash_worktree_untracked_merge;
 817
 818         if (unpack_trees(ARRAY_SIZE(tree_desc), tree_desc, &unpack_tree_opt))
 819                 die(_("failed to unpack trees"));
 820
 821         do_diff_cache(&info->b_commit, diff_opt);
 822 }
 823
 824 static int show_stash(int argc, const char **argv, const char *prefix)
 825 {
 826         int i;
 827         int ret = 0;
 828         struct stash_info info;
 829         struct rev_info rev;
 830         struct strvec stash_args = STRVEC_INIT;
 831         struct strvec revision_args = STRVEC_INIT;
 832         enum {
 833                 UNTRACKED_NONE,
 834                 UNTRACKED_INCLUDE,
 835                 UNTRACKED_ONLY
 836         } show_untracked = show_include_untracked ? UNTRACKED_INCLUDE : UNTRACKED_NONE;
 837         struct option options[] = {
 838                 OPT_SET_INT('u', "include-untracked", &show_untracked,
 839                             N_("include untracked files in the stash"),
 840                             UNTRACKED_INCLUDE),
 841                 OPT_SET_INT_F(0, "only-untracked", &show_untracked,
 842                               N_("only show untracked files in the stash"),
 843                               UNTRACKED_ONLY, PARSE_OPT_NONEG),
 844                 OPT_END()
 845         };
 846
 847         init_diff_ui_defaults();
 848         git_config(git_diff_ui_config, NULL);
 849         init_revisions(&rev, prefix);
 850
 851         argc = parse_options(argc, argv, prefix, options, git_stash_show_usage,
 852                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
 853                              PARSE_OPT_KEEP_DASHDASH);
 854
 855         strvec_push(&revision_args, argv[0]);
 856         for (i = 1; i < argc; i++) {
 857                 if (argv[i][0] != '-')
 858                         strvec_push(&stash_args, argv[i]);
 859                 else
 860                         strvec_push(&revision_args, argv[i]);
 861         }
 862
 863         ret = get_stash_info(&info, stash_args.nr, stash_args.v);
 864         strvec_clear(&stash_args);
 865         if (ret)
 866                 return -1;
 867
 868         /*
 869          * The config settings are applied only if there are not passed
 870          * any options.
 871          */
 872         if (revision_args.nr == 1) {
 873                 if (show_stat)
 874                         rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT;
 875
 876                 if (show_patch)
 877                         rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
 878
 879                 if (!show_stat && !show_patch) {
 880                         free_stash_info(&info);
 881                         return 0;
 882                 }
 883         }
 884
 885         argc = setup_revisions(revision_args.nr, revision_args.v, &rev, NULL);
 886         if (argc > 1) {
 887                 free_stash_info(&info);
 888                 usage_with_options(git_stash_show_usage, options);
 889         }
 890         if (!rev.diffopt.output_format) {
 891                 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
 892                 diff_setup_done(&rev.diffopt);
 893         }
 894
 895         rev.diffopt.flags.recursive = 1;
 896         setup_diff_pager(&rev.diffopt);
 897         switch (show_untracked) {
 898         case UNTRACKED_NONE:
 899                 diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
 900                 break;
 901         case UNTRACKED_ONLY:
 902                 if (info.has_u)
 903                         diff_root_tree_oid(&info.u_tree, "", &rev.diffopt);
 904                 break;
 905         case UNTRACKED_INCLUDE:
 906                 if (info.has_u)
 907                         diff_include_untracked(&info, &rev.diffopt);
 908                 else
 909                         diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
 910                 break;
 911         }
 912         log_tree_diff_flush(&rev);
 913
 914         free_stash_info(&info);
 915         return diff_result_code(&rev.diffopt, 0);
 916 }
 917
 918 static int do_store_stash(const struct object_id *w_commit, const char *stash_msg,
 919                           int quiet)
 920 {
 921         if (!stash_msg)
 922                 stash_msg = "Created via \"git stash store\".";
 923
 924         if (update_ref(stash_msg, ref_stash, w_commit, NULL,
 925                        REF_FORCE_CREATE_REFLOG,
 926                        quiet ? UPDATE_REFS_QUIET_ON_ERR :
 927                        UPDATE_REFS_MSG_ON_ERR)) {
 928                 if (!quiet) {
 929                         fprintf_ln(stderr, _("Cannot update %s with %s"),
 930                                    ref_stash, oid_to_hex(w_commit));
 931                 }
 932                 return -1;
 933         }
 934
 935         return 0;
 936 }
 937
 938 static int store_stash(int argc, const char **argv, const char *prefix)
 939 {
 940         int quiet = 0;
 941         const char *stash_msg = NULL;
 942         struct object_id obj;
 943         struct object_context dummy;
 944         struct option options[] = {
 945                 OPT__QUIET(&quiet, N_("be quiet")),
 946                 OPT_STRING('m', "message", &stash_msg, "message",
 947                            N_("stash message")),
 948                 OPT_END()
 949         };
 950
 951         argc = parse_options(argc, argv, prefix, options,
 952                              git_stash_store_usage,
 953                              PARSE_OPT_KEEP_UNKNOWN);
 954
 955         if (argc != 1) {
 956                 if (!quiet)
 957                         fprintf_ln(stderr, _("\"git stash store\" requires one "
 958                                              "<commit> argument"));
 959                 return -1;
 960         }
 961
 962         if (get_oid_with_context(the_repository,
 963                                  argv[0], quiet ? GET_OID_QUIETLY : 0, &obj,
 964                                  &dummy)) {
 965                 if (!quiet)
 966                         fprintf_ln(stderr, _("Cannot update %s with %s"),
 967                                              ref_stash, argv[0]);
 968                 return -1;
 969         }
 970
 971         return do_store_stash(&obj, stash_msg, quiet);
 972 }
 973
 974 static void add_pathspecs(struct strvec *args,
 975                           const struct pathspec *ps) {
 976         int i;
 977
 978         for (i = 0; i < ps->nr; i++)
 979                 strvec_push(args, ps->items[i].original);
 980 }
 981
 982 /*
 983  * `untracked_files` will be filled with the names of untracked files.
 984  * The return value is:
 985  *
 986  * = 0 if there are not any untracked files
 987  * > 0 if there are untracked files
 988  */
 989 static int get_untracked_files(const struct pathspec *ps, int include_untracked,
 990                                struct strbuf *untracked_files)
 991 {
 992         int i;
 993         int found = 0;
 994         struct dir_struct dir;
 995
 996         dir_init(&dir);
 997         if (include_untracked != INCLUDE_ALL_FILES)
 998                 setup_standard_excludes(&dir);
 999
1000         fill_directory(&dir, the_repository->index, ps);
1001         for (i = 0; i < dir.nr; i++) {
1002                 struct dir_entry *ent = dir.entries[i];
1003                 found++;
1004                 strbuf_addstr(untracked_files, ent->name);
1005                 /* NUL-terminate: will be fed to update-index -z */
1006                 strbuf_addch(untracked_files, '\0');
1007         }
1008
1009         dir_clear(&dir);
1010         return found;
1011 }
1012
1013 /*
1014  * The return value of `check_changes_tracked_files()` can be:
1015  *
1016  * < 0 if there was an error
1017  * = 0 if there are no changes.
1018  * > 0 if there are changes.
1019  */
1020 static int check_changes_tracked_files(const struct pathspec *ps)
1021 {
1022         int result;
1023         struct rev_info rev;
1024         struct object_id dummy;
1025         int ret = 0;
1026
1027         /* No initial commit. */
1028         if (get_oid("HEAD", &dummy))
1029                 return -1;
1030
1031         if (read_cache() < 0)
1032                 return -1;
1033
1034         init_revisions(&rev, NULL);
1035         copy_pathspec(&rev.prune_data, ps);
1036
1037         rev.diffopt.flags.quick = 1;
1038         rev.diffopt.flags.ignore_submodules = 1;
1039         rev.abbrev = 0;
1040
1041         add_head_to_pending(&rev);
1042         diff_setup_done(&rev.diffopt);
1043
1044         result = run_diff_index(&rev, 1);
1045         if (diff_result_code(&rev.diffopt, result)) {
1046                 ret = 1;
1047                 goto done;
1048         }
1049
1050         object_array_clear(&rev.pending);
1051         result = run_diff_files(&rev, 0);
1052         if (diff_result_code(&rev.diffopt, result)) {
1053                 ret = 1;
1054                 goto done;
1055         }
1056
1057 done:
1058         clear_pathspec(&rev.prune_data);
1059         return ret;
1060 }
1061
1062 /*
1063  * The function will fill `untracked_files` with the names of untracked files
1064  * It will return 1 if there were any changes and 0 if there were not.
1065  */
1066 static int check_changes(const struct pathspec *ps, int include_untracked,
1067                          struct strbuf *untracked_files)
1068 {
1069         int ret = 0;
1070         if (check_changes_tracked_files(ps))
1071                 ret = 1;
1072
1073         if (include_untracked && get_untracked_files(ps, include_untracked,
1074                                                      untracked_files))
1075                 ret = 1;
1076
1077         return ret;
1078 }
1079
1080 static int save_untracked_files(struct stash_info *info, struct strbuf *msg,
1081                                 struct strbuf files)
1082 {
1083         int ret = 0;
1084         struct strbuf untracked_msg = STRBUF_INIT;
1085         struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1086         struct index_state istate = { NULL };
1087
1088         cp_upd_index.git_cmd = 1;
1089         strvec_pushl(&cp_upd_index.args, "update-index", "-z", "--add",
1090                      "--remove", "--stdin", NULL);
1091         strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
1092                          stash_index_path.buf);
1093
1094         strbuf_addf(&untracked_msg, "untracked files on %s\n", msg->buf);
1095         if (pipe_command(&cp_upd_index, files.buf, files.len, NULL, 0,
1096                          NULL, 0)) {
1097                 ret = -1;
1098                 goto done;
1099         }
1100
1101         if (write_index_as_tree(&info->u_tree, &istate, stash_index_path.buf, 0,
1102                                 NULL)) {
1103                 ret = -1;
1104                 goto done;
1105         }
1106
1107         if (commit_tree(untracked_msg.buf, untracked_msg.len,
1108                         &info->u_tree, NULL, &info->u_commit, NULL, NULL)) {
1109                 ret = -1;
1110                 goto done;
1111         }
1112
1113 done:
1114         discard_index(&istate);
1115         strbuf_release(&untracked_msg);
1116         remove_path(stash_index_path.buf);
1117         return ret;
1118 }
1119
1120 static int stash_patch(struct stash_info *info, const struct pathspec *ps,
1121                        struct strbuf *out_patch, int quiet)
1122 {
1123         int ret = 0;
1124         struct child_process cp_read_tree = CHILD_PROCESS_INIT;
1125         struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
1126         struct index_state istate = { NULL };
1127         char *old_index_env = NULL, *old_repo_index_file;
1128
1129         remove_path(stash_index_path.buf);
1130
1131         cp_read_tree.git_cmd = 1;
1132         strvec_pushl(&cp_read_tree.args, "read-tree", "HEAD", NULL);
1133         strvec_pushf(&cp_read_tree.env_array, "GIT_INDEX_FILE=%s",
1134                      stash_index_path.buf);
1135         if (run_command(&cp_read_tree)) {
1136                 ret = -1;
1137                 goto done;
1138         }
1139
1140         /* Find out what the user wants. */
1141         old_repo_index_file = the_repository->index_file;
1142         the_repository->index_file = stash_index_path.buf;
1143         old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
1144         setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
1145
1146         ret = run_add_interactive(NULL, "--patch=stash", ps);
1147
1148         the_repository->index_file = old_repo_index_file;
1149         if (old_index_env && *old_index_env)
1150                 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
1151         else
1152                 unsetenv(INDEX_ENVIRONMENT);
1153         FREE_AND_NULL(old_index_env);
1154
1155         /* State of the working tree. */
1156         if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1157                                 NULL)) {
1158                 ret = -1;
1159                 goto done;
1160         }
1161
1162         cp_diff_tree.git_cmd = 1;
1163         strvec_pushl(&cp_diff_tree.args, "diff-tree", "-p", "-U1", "HEAD",
1164                      oid_to_hex(&info->w_tree), "--", NULL);
1165         if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1166                 ret = -1;
1167                 goto done;
1168         }
1169
1170         if (!out_patch->len) {
1171                 if (!quiet)
1172                         fprintf_ln(stderr, _("No changes selected"));
1173                 ret = 1;
1174         }
1175
1176 done:
1177         discard_index(&istate);
1178         remove_path(stash_index_path.buf);
1179         return ret;
1180 }
1181
1182 static int stash_working_tree(struct stash_info *info, const struct pathspec *ps)
1183 {
1184         int ret = 0;
1185         struct rev_info rev;
1186         struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1187         struct strbuf diff_output = STRBUF_INIT;
1188         struct index_state istate = { NULL };
1189
1190         init_revisions(&rev, NULL);
1191         copy_pathspec(&rev.prune_data, ps);
1192
1193         set_alternate_index_output(stash_index_path.buf);
1194         if (reset_tree(&info->i_tree, 0, 0)) {
1195                 ret = -1;
1196                 goto done;
1197         }
1198         set_alternate_index_output(NULL);
1199
1200         rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1201         rev.diffopt.format_callback = add_diff_to_buf;
1202         rev.diffopt.format_callback_data = &diff_output;
1203
1204         if (read_cache_preload(&rev.diffopt.pathspec) < 0) {
1205                 ret = -1;
1206                 goto done;
1207         }
1208
1209         add_pending_object(&rev, parse_object(the_repository, &info->b_commit),
1210                            "");
1211         if (run_diff_index(&rev, 0)) {
1212                 ret = -1;
1213                 goto done;
1214         }
1215
1216         cp_upd_index.git_cmd = 1;
1217         strvec_pushl(&cp_upd_index.args, "update-index",
1218                      "--ignore-skip-worktree-entries",
1219                      "-z", "--add", "--remove", "--stdin", NULL);
1220         strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
1221                      stash_index_path.buf);
1222
1223         if (pipe_command(&cp_upd_index, diff_output.buf, diff_output.len,
1224                          NULL, 0, NULL, 0)) {
1225                 ret = -1;
1226                 goto done;
1227         }
1228
1229         if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1230                                 NULL)) {
1231                 ret = -1;
1232                 goto done;
1233         }
1234
1235 done:
1236         discard_index(&istate);
1237         UNLEAK(rev);
1238         object_array_clear(&rev.pending);
1239         clear_pathspec(&rev.prune_data);
1240         strbuf_release(&diff_output);
1241         remove_path(stash_index_path.buf);
1242         return ret;
1243 }
1244
1245 static int do_create_stash(const struct pathspec *ps, struct strbuf *stash_msg_buf,
1246                            int include_untracked, int patch_mode,
1247                            struct stash_info *info, struct strbuf *patch,
1248                            int quiet)
1249 {
1250         int ret = 0;
1251         int flags = 0;
1252         int untracked_commit_option = 0;
1253         const char *head_short_sha1 = NULL;
1254         const char *branch_ref = NULL;
1255         const char *branch_name = "(no branch)";
1256         struct commit *head_commit = NULL;
1257         struct commit_list *parents = NULL;
1258         struct strbuf msg = STRBUF_INIT;
1259         struct strbuf commit_tree_label = STRBUF_INIT;
1260         struct strbuf untracked_files = STRBUF_INIT;
1261
1262         prepare_fallback_ident("git stash", "git@stash");
1263
1264         read_cache_preload(NULL);
1265         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0) {
1266                 ret = -1;
1267                 goto done;
1268         }
1269
1270         if (get_oid("HEAD", &info->b_commit)) {
1271                 if (!quiet)
1272                         fprintf_ln(stderr, _("You do not have "
1273                                              "the initial commit yet"));
1274                 ret = -1;
1275                 goto done;
1276         } else {
1277                 head_commit = lookup_commit(the_repository, &info->b_commit);
1278         }
1279
1280         if (!check_changes(ps, include_untracked, &untracked_files)) {
1281                 ret = 1;
1282                 goto done;
1283         }
1284
1285         branch_ref = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
1286         if (flags & REF_ISSYMREF)
1287                 branch_name = strrchr(branch_ref, '/') + 1;
1288         head_short_sha1 = find_unique_abbrev(&head_commit->object.oid,
1289                                              DEFAULT_ABBREV);
1290         strbuf_addf(&msg, "%s: %s ", branch_name, head_short_sha1);
1291         pp_commit_easy(CMIT_FMT_ONELINE, head_commit, &msg);
1292
1293         strbuf_addf(&commit_tree_label, "index on %s\n", msg.buf);
1294         commit_list_insert(head_commit, &parents);
1295         if (write_cache_as_tree(&info->i_tree, 0, NULL) ||
1296             commit_tree(commit_tree_label.buf, commit_tree_label.len,
1297                         &info->i_tree, parents, &info->i_commit, NULL, NULL)) {
1298                 if (!quiet)
1299                         fprintf_ln(stderr, _("Cannot save the current "
1300                                              "index state"));
1301                 ret = -1;
1302                 goto done;
1303         }
1304
1305         if (include_untracked) {
1306                 if (save_untracked_files(info, &msg, untracked_files)) {
1307                         if (!quiet)
1308                                 fprintf_ln(stderr, _("Cannot save "
1309                                                      "the untracked files"));
1310                         ret = -1;
1311                         goto done;
1312                 }
1313                 untracked_commit_option = 1;
1314         }
1315         if (patch_mode) {
1316                 ret = stash_patch(info, ps, patch, quiet);
1317                 if (ret < 0) {
1318                         if (!quiet)
1319                                 fprintf_ln(stderr, _("Cannot save the current "
1320                                                      "worktree state"));
1321                         goto done;
1322                 } else if (ret > 0) {
1323                         goto done;
1324                 }
1325         } else {
1326                 if (stash_working_tree(info, ps)) {
1327                         if (!quiet)
1328                                 fprintf_ln(stderr, _("Cannot save the current "
1329                                                      "worktree state"));
1330                         ret = -1;
1331                         goto done;
1332                 }
1333         }
1334
1335         if (!stash_msg_buf->len)
1336                 strbuf_addf(stash_msg_buf, "WIP on %s", msg.buf);
1337         else
1338                 strbuf_insertf(stash_msg_buf, 0, "On %s: ", branch_name);
1339
1340         /*
1341          * `parents` will be empty after calling `commit_tree()`, so there is
1342          * no need to call `free_commit_list()`
1343          */
1344         parents = NULL;
1345         if (untracked_commit_option)
1346                 commit_list_insert(lookup_commit(the_repository,
1347                                                  &info->u_commit),
1348                                    &parents);
1349         commit_list_insert(lookup_commit(the_repository, &info->i_commit),
1350                            &parents);
1351         commit_list_insert(head_commit, &parents);
1352
1353         if (commit_tree(stash_msg_buf->buf, stash_msg_buf->len, &info->w_tree,
1354                         parents, &info->w_commit, NULL, NULL)) {
1355                 if (!quiet)
1356                         fprintf_ln(stderr, _("Cannot record "
1357                                              "working tree state"));
1358                 ret = -1;
1359                 goto done;
1360         }
1361
1362 done:
1363         strbuf_release(&commit_tree_label);
1364         strbuf_release(&msg);
1365         strbuf_release(&untracked_files);
1366         return ret;
1367 }
1368
1369 static int create_stash(int argc, const char **argv, const char *prefix)
1370 {
1371         int ret = 0;
1372         struct strbuf stash_msg_buf = STRBUF_INIT;
1373         struct stash_info info;
1374         struct pathspec ps;
1375
1376         /* Starting with argv[1], since argv[0] is "create" */
1377         strbuf_join_argv(&stash_msg_buf, argc - 1, ++argv, ' ');
1378
1379         memset(&ps, 0, sizeof(ps));
1380         if (!check_changes_tracked_files(&ps))
1381                 return 0;
1382
1383         ret = do_create_stash(&ps, &stash_msg_buf, 0, 0, &info,
1384                               NULL, 0);
1385         if (!ret)
1386                 printf_ln("%s", oid_to_hex(&info.w_commit));
1387
1388         strbuf_release(&stash_msg_buf);
1389         return ret;
1390 }
1391
1392 static int do_push_stash(const struct pathspec *ps, const char *stash_msg, int quiet,
1393                          int keep_index, int patch_mode, int include_untracked)
1394 {
1395         int ret = 0;
1396         struct stash_info info;
1397         struct strbuf patch = STRBUF_INIT;
1398         struct strbuf stash_msg_buf = STRBUF_INIT;
1399         struct strbuf untracked_files = STRBUF_INIT;
1400
1401         if (patch_mode && keep_index == -1)
1402                 keep_index = 1;
1403
1404         if (patch_mode && include_untracked) {
1405                 fprintf_ln(stderr, _("Can't use --patch and --include-untracked"
1406                                      " or --all at the same time"));
1407                 ret = -1;
1408                 goto done;
1409         }
1410
1411         read_cache_preload(NULL);
1412         if (!include_untracked && ps->nr) {
1413                 int i;
1414                 char *ps_matched = xcalloc(ps->nr, 1);
1415
1416                 /* TODO: audit for interaction with sparse-index. */
1417                 ensure_full_index(&the_index);
1418                 for (i = 0; i < active_nr; i++)
1419                         ce_path_match(&the_index, active_cache[i], ps,
1420                                       ps_matched);
1421
1422                 if (report_path_error(ps_matched, ps)) {
1423                         fprintf_ln(stderr, _("Did you forget to 'git add'?"));
1424                         ret = -1;
1425                         free(ps_matched);
1426                         goto done;
1427                 }
1428                 free(ps_matched);
1429         }
1430
1431         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0)) {
1432                 ret = -1;
1433                 goto done;
1434         }
1435
1436         if (!check_changes(ps, include_untracked, &untracked_files)) {
1437                 if (!quiet)
1438                         printf_ln(_("No local changes to save"));
1439                 goto done;
1440         }
1441
1442         if (!reflog_exists(ref_stash) && do_clear_stash()) {
1443                 ret = -1;
1444                 if (!quiet)
1445                         fprintf_ln(stderr, _("Cannot initialize stash"));
1446                 goto done;
1447         }
1448
1449         if (stash_msg)
1450                 strbuf_addstr(&stash_msg_buf, stash_msg);
1451         if (do_create_stash(ps, &stash_msg_buf, include_untracked, patch_mode,
1452                             &info, &patch, quiet)) {
1453                 ret = -1;
1454                 goto done;
1455         }
1456
1457         if (do_store_stash(&info.w_commit, stash_msg_buf.buf, 1)) {
1458                 ret = -1;
1459                 if (!quiet)
1460                         fprintf_ln(stderr, _("Cannot save the current status"));
1461                 goto done;
1462         }
1463
1464         if (!quiet)
1465                 printf_ln(_("Saved working directory and index state %s"),
1466                           stash_msg_buf.buf);
1467
1468         if (!patch_mode) {
1469                 if (include_untracked && !ps->nr) {
1470                         struct child_process cp = CHILD_PROCESS_INIT;
1471
1472                         cp.git_cmd = 1;
1473                         strvec_pushl(&cp.args, "clean", "--force",
1474                                      "--quiet", "-d", NULL);
1475                         if (include_untracked == INCLUDE_ALL_FILES)
1476                                 strvec_push(&cp.args, "-x");
1477                         if (run_command(&cp)) {
1478                                 ret = -1;
1479                                 goto done;
1480                         }
1481                 }
1482                 discard_cache();
1483                 if (ps->nr) {
1484                         struct child_process cp_add = CHILD_PROCESS_INIT;
1485                         struct child_process cp_diff = CHILD_PROCESS_INIT;
1486                         struct child_process cp_apply = CHILD_PROCESS_INIT;
1487                         struct strbuf out = STRBUF_INIT;
1488
1489                         cp_add.git_cmd = 1;
1490                         strvec_push(&cp_add.args, "add");
1491                         if (!include_untracked)
1492                                 strvec_push(&cp_add.args, "-u");
1493                         if (include_untracked == INCLUDE_ALL_FILES)
1494                                 strvec_push(&cp_add.args, "--force");
1495                         strvec_push(&cp_add.args, "--");
1496                         add_pathspecs(&cp_add.args, ps);
1497                         if (run_command(&cp_add)) {
1498                                 ret = -1;
1499                                 goto done;
1500                         }
1501
1502                         cp_diff.git_cmd = 1;
1503                         strvec_pushl(&cp_diff.args, "diff-index", "-p",
1504                                      "--cached", "--binary", "HEAD", "--",
1505                                      NULL);
1506                         add_pathspecs(&cp_diff.args, ps);
1507                         if (pipe_command(&cp_diff, NULL, 0, &out, 0, NULL, 0)) {
1508                                 ret = -1;
1509                                 goto done;
1510                         }
1511
1512                         cp_apply.git_cmd = 1;
1513                         strvec_pushl(&cp_apply.args, "apply", "--index",
1514                                      "-R", NULL);
1515                         if (pipe_command(&cp_apply, out.buf, out.len, NULL, 0,
1516                                          NULL, 0)) {
1517                                 ret = -1;
1518                                 goto done;
1519                         }
1520                 } else {
1521                         struct child_process cp = CHILD_PROCESS_INIT;
1522                         cp.git_cmd = 1;
1523                         strvec_pushl(&cp.args, "reset", "--hard", "-q",
1524                                      "--no-recurse-submodules", NULL);
1525                         if (run_command(&cp)) {
1526                                 ret = -1;
1527                                 goto done;
1528                         }
1529                 }
1530
1531                 if (keep_index == 1 && !is_null_oid(&info.i_tree)) {
1532                         struct child_process cp = CHILD_PROCESS_INIT;
1533
1534                         cp.git_cmd = 1;
1535                         strvec_pushl(&cp.args, "checkout", "--no-overlay",
1536                                      oid_to_hex(&info.i_tree), "--", NULL);
1537                         if (!ps->nr)
1538                                 strvec_push(&cp.args, ":/");
1539                         else
1540                                 add_pathspecs(&cp.args, ps);
1541                         if (run_command(&cp)) {
1542                                 ret = -1;
1543                                 goto done;
1544                         }
1545                 }
1546                 goto done;
1547         } else {
1548                 struct child_process cp = CHILD_PROCESS_INIT;
1549
1550                 cp.git_cmd = 1;
1551                 strvec_pushl(&cp.args, "apply", "-R", NULL);
1552
1553                 if (pipe_command(&cp, patch.buf, patch.len, NULL, 0, NULL, 0)) {
1554                         if (!quiet)
1555                                 fprintf_ln(stderr, _("Cannot remove "
1556                                                      "worktree changes"));
1557                         ret = -1;
1558                         goto done;
1559                 }
1560
1561                 if (keep_index < 1) {
1562                         struct child_process cp = CHILD_PROCESS_INIT;
1563
1564                         cp.git_cmd = 1;
1565                         strvec_pushl(&cp.args, "reset", "-q", "--", NULL);
1566                         add_pathspecs(&cp.args, ps);
1567                         if (run_command(&cp)) {
1568                                 ret = -1;
1569                                 goto done;
1570                         }
1571                 }
1572                 goto done;
1573         }
1574
1575 done:
1576         strbuf_release(&stash_msg_buf);
1577         return ret;
1578 }
1579
1580 static int push_stash(int argc, const char **argv, const char *prefix,
1581                       int push_assumed)
1582 {
1583         int force_assume = 0;
1584         int keep_index = -1;
1585         int patch_mode = 0;
1586         int include_untracked = 0;
1587         int quiet = 0;
1588         int pathspec_file_nul = 0;
1589         const char *stash_msg = NULL;
1590         const char *pathspec_from_file = NULL;
1591         struct pathspec ps;
1592         struct option options[] = {
1593                 OPT_BOOL('k', "keep-index", &keep_index,
1594                          N_("keep index")),
1595                 OPT_BOOL('p', "patch", &patch_mode,
1596                          N_("stash in patch mode")),
1597                 OPT__QUIET(&quiet, N_("quiet mode")),
1598                 OPT_BOOL('u', "include-untracked", &include_untracked,
1599                          N_("include untracked files in stash")),
1600                 OPT_SET_INT('a', "all", &include_untracked,
1601                             N_("include ignore files"), 2),
1602                 OPT_STRING('m', "message", &stash_msg, N_("message"),
1603                            N_("stash message")),
1604                 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1605                 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
1606                 OPT_END()
1607         };
1608
1609         if (argc) {
1610                 force_assume = !strcmp(argv[0], "-p");
1611                 argc = parse_options(argc, argv, prefix, options,
1612                                      git_stash_push_usage,
1613                                      PARSE_OPT_KEEP_DASHDASH);
1614         }
1615
1616         if (argc) {
1617                 if (!strcmp(argv[0], "--")) {
1618                         argc--;
1619                         argv++;
1620                 } else if (push_assumed && !force_assume) {
1621                         die("subcommand wasn't specified; 'push' can't be assumed due to unexpected token '%s'",
1622                             argv[0]);
1623                 }
1624         }
1625
1626         parse_pathspec(&ps, 0, PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1627                        prefix, argv);
1628
1629         if (pathspec_from_file) {
1630                 if (patch_mode)
1631                         die(_("--pathspec-from-file is incompatible with --patch"));
1632
1633                 if (ps.nr)
1634                         die(_("--pathspec-from-file is incompatible with pathspec arguments"));
1635
1636                 parse_pathspec_file(&ps, 0,
1637                                     PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1638                                     prefix, pathspec_from_file, pathspec_file_nul);
1639         } else if (pathspec_file_nul) {
1640                 die(_("--pathspec-file-nul requires --pathspec-from-file"));
1641         }
1642
1643         return do_push_stash(&ps, stash_msg, quiet, keep_index, patch_mode,
1644                              include_untracked);
1645 }
1646
1647 static int save_stash(int argc, const char **argv, const char *prefix)
1648 {
1649         int keep_index = -1;
1650         int patch_mode = 0;
1651         int include_untracked = 0;
1652         int quiet = 0;
1653         int ret = 0;
1654         const char *stash_msg = NULL;
1655         struct pathspec ps;
1656         struct strbuf stash_msg_buf = STRBUF_INIT;
1657         struct option options[] = {
1658                 OPT_BOOL('k', "keep-index", &keep_index,
1659                          N_("keep index")),
1660                 OPT_BOOL('p', "patch", &patch_mode,
1661                          N_("stash in patch mode")),
1662                 OPT__QUIET(&quiet, N_("quiet mode")),
1663                 OPT_BOOL('u', "include-untracked", &include_untracked,
1664                          N_("include untracked files in stash")),
1665                 OPT_SET_INT('a', "all", &include_untracked,
1666                             N_("include ignore files"), 2),
1667                 OPT_STRING('m', "message", &stash_msg, "message",
1668                            N_("stash message")),
1669                 OPT_END()
1670         };
1671
1672         argc = parse_options(argc, argv, prefix, options,
1673                              git_stash_save_usage,
1674                              PARSE_OPT_KEEP_DASHDASH);
1675
1676         if (argc)
1677                 stash_msg = strbuf_join_argv(&stash_msg_buf, argc, argv, ' ');
1678
1679         memset(&ps, 0, sizeof(ps));
1680         ret = do_push_stash(&ps, stash_msg, quiet, keep_index,
1681                             patch_mode, include_untracked);
1682
1683         strbuf_release(&stash_msg_buf);
1684         return ret;
1685 }
1686
1687 int cmd_stash(int argc, const char **argv, const char *prefix)
1688 {
1689         pid_t pid = getpid();
1690         const char *index_file;
1691         struct strvec args = STRVEC_INIT;
1692
1693         struct option options[] = {
1694                 OPT_END()
1695         };
1696
1697         git_config(git_stash_config, NULL);
1698
1699         if (use_legacy_stash ||
1700             !git_env_bool("GIT_TEST_STASH_USE_BUILTIN", -1))
1701                 warning(_("the stash.useBuiltin support has been removed!\n"
1702                           "See its entry in 'git help config' for details."));
1703
1704         argc = parse_options(argc, argv, prefix, options, git_stash_usage,
1705                              PARSE_OPT_KEEP_UNKNOWN | PARSE_OPT_KEEP_DASHDASH);
1706
1707         index_file = get_index_file();
1708         strbuf_addf(&stash_index_path, "%s.stash.%" PRIuMAX, index_file,
1709                     (uintmax_t)pid);
1710
1711         if (!argc)
1712                 return !!push_stash(0, NULL, prefix, 0);
1713         else if (!strcmp(argv[0], "apply"))
1714                 return !!apply_stash(argc, argv, prefix);
1715         else if (!strcmp(argv[0], "clear"))
1716                 return !!clear_stash(argc, argv, prefix);
1717         else if (!strcmp(argv[0], "drop"))
1718                 return !!drop_stash(argc, argv, prefix);
1719         else if (!strcmp(argv[0], "pop"))
1720                 return !!pop_stash(argc, argv, prefix);
1721         else if (!strcmp(argv[0], "branch"))
1722                 return !!branch_stash(argc, argv, prefix);
1723         else if (!strcmp(argv[0], "list"))
1724                 return !!list_stash(argc, argv, prefix);
1725         else if (!strcmp(argv[0], "show"))
1726                 return !!show_stash(argc, argv, prefix);
1727         else if (!strcmp(argv[0], "store"))
1728                 return !!store_stash(argc, argv, prefix);
1729         else if (!strcmp(argv[0], "create"))
1730                 return !!create_stash(argc, argv, prefix);
1731         else if (!strcmp(argv[0], "push"))
1732                 return !!push_stash(argc, argv, prefix, 0);
1733         else if (!strcmp(argv[0], "save"))
1734                 return !!save_stash(argc, argv, prefix);
1735         else if (*argv[0] != '-')
1736                 usage_msg_opt(xstrfmt(_("unknown subcommand: %s"), argv[0]),
1737                               git_stash_usage, options);
1738
1739         /* Assume 'stash push' */
1740         strvec_push(&args, "push");
1741         strvec_pushv(&args, argv);
1742         return !!push_stash(args.nr, args.v, prefix, 1);
1743 }