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 = 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_include_untracked)
 880                         show_untracked = UNTRACKED_INCLUDE;
 881
 882                 if (!show_stat && !show_patch) {
 883                         free_stash_info(&info);
 884                         return 0;
 885                 }
 886         }
 887
 888         argc = setup_revisions(revision_args.nr, revision_args.v, &rev, NULL);
 889         if (argc > 1) {
 890                 free_stash_info(&info);
 891                 usage_with_options(git_stash_show_usage, options);
 892         }
 893         if (!rev.diffopt.output_format) {
 894                 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
 895                 diff_setup_done(&rev.diffopt);
 896         }
 897
 898         rev.diffopt.flags.recursive = 1;
 899         setup_diff_pager(&rev.diffopt);
 900         switch (show_untracked) {
 901         case UNTRACKED_NONE:
 902                 diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
 903                 break;
 904         case UNTRACKED_ONLY:
 905                 diff_root_tree_oid(&info.u_tree, "", &rev.diffopt);
 906                 break;
 907         case UNTRACKED_INCLUDE:
 908                 diff_include_untracked(&info, &rev.diffopt);
 909                 break;
 910         }
 911         log_tree_diff_flush(&rev);
 912
 913         free_stash_info(&info);
 914         return diff_result_code(&rev.diffopt, 0);
 915 }
 916
 917 static int do_store_stash(const struct object_id *w_commit, const char *stash_msg,
 918                           int quiet)
 919 {
 920         if (!stash_msg)
 921                 stash_msg = "Created via \"git stash store\".";
 922
 923         if (update_ref(stash_msg, ref_stash, w_commit, NULL,
 924                        REF_FORCE_CREATE_REFLOG,
 925                        quiet ? UPDATE_REFS_QUIET_ON_ERR :
 926                        UPDATE_REFS_MSG_ON_ERR)) {
 927                 if (!quiet) {
 928                         fprintf_ln(stderr, _("Cannot update %s with %s"),
 929                                    ref_stash, oid_to_hex(w_commit));
 930                 }
 931                 return -1;
 932         }
 933
 934         return 0;
 935 }
 936
 937 static int store_stash(int argc, const char **argv, const char *prefix)
 938 {
 939         int quiet = 0;
 940         const char *stash_msg = NULL;
 941         struct object_id obj;
 942         struct object_context dummy;
 943         struct option options[] = {
 944                 OPT__QUIET(&quiet, N_("be quiet")),
 945                 OPT_STRING('m', "message", &stash_msg, "message",
 946                            N_("stash message")),
 947                 OPT_END()
 948         };
 949
 950         argc = parse_options(argc, argv, prefix, options,
 951                              git_stash_store_usage,
 952                              PARSE_OPT_KEEP_UNKNOWN);
 953
 954         if (argc != 1) {
 955                 if (!quiet)
 956                         fprintf_ln(stderr, _("\"git stash store\" requires one "
 957                                              "<commit> argument"));
 958                 return -1;
 959         }
 960
 961         if (get_oid_with_context(the_repository,
 962                                  argv[0], quiet ? GET_OID_QUIETLY : 0, &obj,
 963                                  &dummy)) {
 964                 if (!quiet)
 965                         fprintf_ln(stderr, _("Cannot update %s with %s"),
 966                                              ref_stash, argv[0]);
 967                 return -1;
 968         }
 969
 970         return do_store_stash(&obj, stash_msg, quiet);
 971 }
 972
 973 static void add_pathspecs(struct strvec *args,
 974                           const struct pathspec *ps) {
 975         int i;
 976
 977         for (i = 0; i < ps->nr; i++)
 978                 strvec_push(args, ps->items[i].original);
 979 }
 980
 981 /*
 982  * `untracked_files` will be filled with the names of untracked files.
 983  * The return value is:
 984  *
 985  * = 0 if there are not any untracked files
 986  * > 0 if there are untracked files
 987  */
 988 static int get_untracked_files(const struct pathspec *ps, int include_untracked,
 989                                struct strbuf *untracked_files)
 990 {
 991         int i;
 992         int found = 0;
 993         struct dir_struct dir;
 994
 995         dir_init(&dir);
 996         if (include_untracked != INCLUDE_ALL_FILES)
 997                 setup_standard_excludes(&dir);
 998
 999         fill_directory(&dir, the_repository->index, ps);
1000         for (i = 0; i < dir.nr; i++) {
1001                 struct dir_entry *ent = dir.entries[i];
1002                 found++;
1003                 strbuf_addstr(untracked_files, ent->name);
1004                 /* NUL-terminate: will be fed to update-index -z */
1005                 strbuf_addch(untracked_files, '\0');
1006         }
1007
1008         dir_clear(&dir);
1009         return found;
1010 }
1011
1012 /*
1013  * The return value of `check_changes_tracked_files()` can be:
1014  *
1015  * < 0 if there was an error
1016  * = 0 if there are no changes.
1017  * > 0 if there are changes.
1018  */
1019 static int check_changes_tracked_files(const struct pathspec *ps)
1020 {
1021         int result;
1022         struct rev_info rev;
1023         struct object_id dummy;
1024         int ret = 0;
1025
1026         /* No initial commit. */
1027         if (get_oid("HEAD", &dummy))
1028                 return -1;
1029
1030         if (read_cache() < 0)
1031                 return -1;
1032
1033         init_revisions(&rev, NULL);
1034         copy_pathspec(&rev.prune_data, ps);
1035
1036         rev.diffopt.flags.quick = 1;
1037         rev.diffopt.flags.ignore_submodules = 1;
1038         rev.abbrev = 0;
1039
1040         add_head_to_pending(&rev);
1041         diff_setup_done(&rev.diffopt);
1042
1043         result = run_diff_index(&rev, 1);
1044         if (diff_result_code(&rev.diffopt, result)) {
1045                 ret = 1;
1046                 goto done;
1047         }
1048
1049         object_array_clear(&rev.pending);
1050         result = run_diff_files(&rev, 0);
1051         if (diff_result_code(&rev.diffopt, result)) {
1052                 ret = 1;
1053                 goto done;
1054         }
1055
1056 done:
1057         clear_pathspec(&rev.prune_data);
1058         return ret;
1059 }
1060
1061 /*
1062  * The function will fill `untracked_files` with the names of untracked files
1063  * It will return 1 if there were any changes and 0 if there were not.
1064  */
1065 static int check_changes(const struct pathspec *ps, int include_untracked,
1066                          struct strbuf *untracked_files)
1067 {
1068         int ret = 0;
1069         if (check_changes_tracked_files(ps))
1070                 ret = 1;
1071
1072         if (include_untracked && get_untracked_files(ps, include_untracked,
1073                                                      untracked_files))
1074                 ret = 1;
1075
1076         return ret;
1077 }
1078
1079 static int save_untracked_files(struct stash_info *info, struct strbuf *msg,
1080                                 struct strbuf files)
1081 {
1082         int ret = 0;
1083         struct strbuf untracked_msg = STRBUF_INIT;
1084         struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1085         struct index_state istate = { NULL };
1086
1087         cp_upd_index.git_cmd = 1;
1088         strvec_pushl(&cp_upd_index.args, "update-index", "-z", "--add",
1089                      "--remove", "--stdin", NULL);
1090         strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
1091                          stash_index_path.buf);
1092
1093         strbuf_addf(&untracked_msg, "untracked files on %s\n", msg->buf);
1094         if (pipe_command(&cp_upd_index, files.buf, files.len, NULL, 0,
1095                          NULL, 0)) {
1096                 ret = -1;
1097                 goto done;
1098         }
1099
1100         if (write_index_as_tree(&info->u_tree, &istate, stash_index_path.buf, 0,
1101                                 NULL)) {
1102                 ret = -1;
1103                 goto done;
1104         }
1105
1106         if (commit_tree(untracked_msg.buf, untracked_msg.len,
1107                         &info->u_tree, NULL, &info->u_commit, NULL, NULL)) {
1108                 ret = -1;
1109                 goto done;
1110         }
1111
1112 done:
1113         discard_index(&istate);
1114         strbuf_release(&untracked_msg);
1115         remove_path(stash_index_path.buf);
1116         return ret;
1117 }
1118
1119 static int stash_patch(struct stash_info *info, const struct pathspec *ps,
1120                        struct strbuf *out_patch, int quiet)
1121 {
1122         int ret = 0;
1123         struct child_process cp_read_tree = CHILD_PROCESS_INIT;
1124         struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
1125         struct index_state istate = { NULL };
1126         char *old_index_env = NULL, *old_repo_index_file;
1127
1128         remove_path(stash_index_path.buf);
1129
1130         cp_read_tree.git_cmd = 1;
1131         strvec_pushl(&cp_read_tree.args, "read-tree", "HEAD", NULL);
1132         strvec_pushf(&cp_read_tree.env_array, "GIT_INDEX_FILE=%s",
1133                      stash_index_path.buf);
1134         if (run_command(&cp_read_tree)) {
1135                 ret = -1;
1136                 goto done;
1137         }
1138
1139         /* Find out what the user wants. */
1140         old_repo_index_file = the_repository->index_file;
1141         the_repository->index_file = stash_index_path.buf;
1142         old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
1143         setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
1144
1145         ret = run_add_interactive(NULL, "--patch=stash", ps);
1146
1147         the_repository->index_file = old_repo_index_file;
1148         if (old_index_env && *old_index_env)
1149                 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
1150         else
1151                 unsetenv(INDEX_ENVIRONMENT);
1152         FREE_AND_NULL(old_index_env);
1153
1154         /* State of the working tree. */
1155         if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1156                                 NULL)) {
1157                 ret = -1;
1158                 goto done;
1159         }
1160
1161         cp_diff_tree.git_cmd = 1;
1162         strvec_pushl(&cp_diff_tree.args, "diff-tree", "-p", "-U1", "HEAD",
1163                      oid_to_hex(&info->w_tree), "--", NULL);
1164         if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1165                 ret = -1;
1166                 goto done;
1167         }
1168
1169         if (!out_patch->len) {
1170                 if (!quiet)
1171                         fprintf_ln(stderr, _("No changes selected"));
1172                 ret = 1;
1173         }
1174
1175 done:
1176         discard_index(&istate);
1177         remove_path(stash_index_path.buf);
1178         return ret;
1179 }
1180
1181 static int stash_working_tree(struct stash_info *info, const struct pathspec *ps)
1182 {
1183         int ret = 0;
1184         struct rev_info rev;
1185         struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1186         struct strbuf diff_output = STRBUF_INIT;
1187         struct index_state istate = { NULL };
1188
1189         init_revisions(&rev, NULL);
1190         copy_pathspec(&rev.prune_data, ps);
1191
1192         set_alternate_index_output(stash_index_path.buf);
1193         if (reset_tree(&info->i_tree, 0, 0)) {
1194                 ret = -1;
1195                 goto done;
1196         }
1197         set_alternate_index_output(NULL);
1198
1199         rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1200         rev.diffopt.format_callback = add_diff_to_buf;
1201         rev.diffopt.format_callback_data = &diff_output;
1202
1203         if (read_cache_preload(&rev.diffopt.pathspec) < 0) {
1204                 ret = -1;
1205                 goto done;
1206         }
1207
1208         add_pending_object(&rev, parse_object(the_repository, &info->b_commit),
1209                            "");
1210         if (run_diff_index(&rev, 0)) {
1211                 ret = -1;
1212                 goto done;
1213         }
1214
1215         cp_upd_index.git_cmd = 1;
1216         strvec_pushl(&cp_upd_index.args, "update-index",
1217                      "--ignore-skip-worktree-entries",
1218                      "-z", "--add", "--remove", "--stdin", NULL);
1219         strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
1220                      stash_index_path.buf);
1221
1222         if (pipe_command(&cp_upd_index, diff_output.buf, diff_output.len,
1223                          NULL, 0, NULL, 0)) {
1224                 ret = -1;
1225                 goto done;
1226         }
1227
1228         if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1229                                 NULL)) {
1230                 ret = -1;
1231                 goto done;
1232         }
1233
1234 done:
1235         discard_index(&istate);
1236         UNLEAK(rev);
1237         object_array_clear(&rev.pending);
1238         clear_pathspec(&rev.prune_data);
1239         strbuf_release(&diff_output);
1240         remove_path(stash_index_path.buf);
1241         return ret;
1242 }
1243
1244 static int do_create_stash(const struct pathspec *ps, struct strbuf *stash_msg_buf,
1245                            int include_untracked, int patch_mode,
1246                            struct stash_info *info, struct strbuf *patch,
1247                            int quiet)
1248 {
1249         int ret = 0;
1250         int flags = 0;
1251         int untracked_commit_option = 0;
1252         const char *head_short_sha1 = NULL;
1253         const char *branch_ref = NULL;
1254         const char *branch_name = "(no branch)";
1255         struct commit *head_commit = NULL;
1256         struct commit_list *parents = NULL;
1257         struct strbuf msg = STRBUF_INIT;
1258         struct strbuf commit_tree_label = STRBUF_INIT;
1259         struct strbuf untracked_files = STRBUF_INIT;
1260
1261         prepare_fallback_ident("git stash", "git@stash");
1262
1263         read_cache_preload(NULL);
1264         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0) {
1265                 ret = -1;
1266                 goto done;
1267         }
1268
1269         if (get_oid("HEAD", &info->b_commit)) {
1270                 if (!quiet)
1271                         fprintf_ln(stderr, _("You do not have "
1272                                              "the initial commit yet"));
1273                 ret = -1;
1274                 goto done;
1275         } else {
1276                 head_commit = lookup_commit(the_repository, &info->b_commit);
1277         }
1278
1279         if (!check_changes(ps, include_untracked, &untracked_files)) {
1280                 ret = 1;
1281                 goto done;
1282         }
1283
1284         branch_ref = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
1285         if (flags & REF_ISSYMREF)
1286                 branch_name = strrchr(branch_ref, '/') + 1;
1287         head_short_sha1 = find_unique_abbrev(&head_commit->object.oid,
1288                                              DEFAULT_ABBREV);
1289         strbuf_addf(&msg, "%s: %s ", branch_name, head_short_sha1);
1290         pp_commit_easy(CMIT_FMT_ONELINE, head_commit, &msg);
1291
1292         strbuf_addf(&commit_tree_label, "index on %s\n", msg.buf);
1293         commit_list_insert(head_commit, &parents);
1294         if (write_cache_as_tree(&info->i_tree, 0, NULL) ||
1295             commit_tree(commit_tree_label.buf, commit_tree_label.len,
1296                         &info->i_tree, parents, &info->i_commit, NULL, NULL)) {
1297                 if (!quiet)
1298                         fprintf_ln(stderr, _("Cannot save the current "
1299                                              "index state"));
1300                 ret = -1;
1301                 goto done;
1302         }
1303
1304         if (include_untracked) {
1305                 if (save_untracked_files(info, &msg, untracked_files)) {
1306                         if (!quiet)
1307                                 fprintf_ln(stderr, _("Cannot save "
1308                                                      "the untracked files"));
1309                         ret = -1;
1310                         goto done;
1311                 }
1312                 untracked_commit_option = 1;
1313         }
1314         if (patch_mode) {
1315                 ret = stash_patch(info, ps, patch, quiet);
1316                 if (ret < 0) {
1317                         if (!quiet)
1318                                 fprintf_ln(stderr, _("Cannot save the current "
1319                                                      "worktree state"));
1320                         goto done;
1321                 } else if (ret > 0) {
1322                         goto done;
1323                 }
1324         } else {
1325                 if (stash_working_tree(info, ps)) {
1326                         if (!quiet)
1327                                 fprintf_ln(stderr, _("Cannot save the current "
1328                                                      "worktree state"));
1329                         ret = -1;
1330                         goto done;
1331                 }
1332         }
1333
1334         if (!stash_msg_buf->len)
1335                 strbuf_addf(stash_msg_buf, "WIP on %s", msg.buf);
1336         else
1337                 strbuf_insertf(stash_msg_buf, 0, "On %s: ", branch_name);
1338
1339         /*
1340          * `parents` will be empty after calling `commit_tree()`, so there is
1341          * no need to call `free_commit_list()`
1342          */
1343         parents = NULL;
1344         if (untracked_commit_option)
1345                 commit_list_insert(lookup_commit(the_repository,
1346                                                  &info->u_commit),
1347                                    &parents);
1348         commit_list_insert(lookup_commit(the_repository, &info->i_commit),
1349                            &parents);
1350         commit_list_insert(head_commit, &parents);
1351
1352         if (commit_tree(stash_msg_buf->buf, stash_msg_buf->len, &info->w_tree,
1353                         parents, &info->w_commit, NULL, NULL)) {
1354                 if (!quiet)
1355                         fprintf_ln(stderr, _("Cannot record "
1356                                              "working tree state"));
1357                 ret = -1;
1358                 goto done;
1359         }
1360
1361 done:
1362         strbuf_release(&commit_tree_label);
1363         strbuf_release(&msg);
1364         strbuf_release(&untracked_files);
1365         return ret;
1366 }
1367
1368 static int create_stash(int argc, const char **argv, const char *prefix)
1369 {
1370         int ret = 0;
1371         struct strbuf stash_msg_buf = STRBUF_INIT;
1372         struct stash_info info;
1373         struct pathspec ps;
1374
1375         /* Starting with argv[1], since argv[0] is "create" */
1376         strbuf_join_argv(&stash_msg_buf, argc - 1, ++argv, ' ');
1377
1378         memset(&ps, 0, sizeof(ps));
1379         if (!check_changes_tracked_files(&ps))
1380                 return 0;
1381
1382         ret = do_create_stash(&ps, &stash_msg_buf, 0, 0, &info,
1383                               NULL, 0);
1384         if (!ret)
1385                 printf_ln("%s", oid_to_hex(&info.w_commit));
1386
1387         strbuf_release(&stash_msg_buf);
1388         return ret;
1389 }
1390
1391 static int do_push_stash(const struct pathspec *ps, const char *stash_msg, int quiet,
1392                          int keep_index, int patch_mode, int include_untracked)
1393 {
1394         int ret = 0;
1395         struct stash_info info;
1396         struct strbuf patch = STRBUF_INIT;
1397         struct strbuf stash_msg_buf = STRBUF_INIT;
1398         struct strbuf untracked_files = STRBUF_INIT;
1399
1400         if (patch_mode && keep_index == -1)
1401                 keep_index = 1;
1402
1403         if (patch_mode && include_untracked) {
1404                 fprintf_ln(stderr, _("Can't use --patch and --include-untracked"
1405                                      " or --all at the same time"));
1406                 ret = -1;
1407                 goto done;
1408         }
1409
1410         read_cache_preload(NULL);
1411         if (!include_untracked && ps->nr) {
1412                 int i;
1413                 char *ps_matched = xcalloc(ps->nr, 1);
1414
1415                 for (i = 0; i < active_nr; i++)
1416                         ce_path_match(&the_index, active_cache[i], ps,
1417                                       ps_matched);
1418
1419                 if (report_path_error(ps_matched, ps)) {
1420                         fprintf_ln(stderr, _("Did you forget to 'git add'?"));
1421                         ret = -1;
1422                         free(ps_matched);
1423                         goto done;
1424                 }
1425                 free(ps_matched);
1426         }
1427
1428         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0)) {
1429                 ret = -1;
1430                 goto done;
1431         }
1432
1433         if (!check_changes(ps, include_untracked, &untracked_files)) {
1434                 if (!quiet)
1435                         printf_ln(_("No local changes to save"));
1436                 goto done;
1437         }
1438
1439         if (!reflog_exists(ref_stash) && do_clear_stash()) {
1440                 ret = -1;
1441                 if (!quiet)
1442                         fprintf_ln(stderr, _("Cannot initialize stash"));
1443                 goto done;
1444         }
1445
1446         if (stash_msg)
1447                 strbuf_addstr(&stash_msg_buf, stash_msg);
1448         if (do_create_stash(ps, &stash_msg_buf, include_untracked, patch_mode,
1449                             &info, &patch, quiet)) {
1450                 ret = -1;
1451                 goto done;
1452         }
1453
1454         if (do_store_stash(&info.w_commit, stash_msg_buf.buf, 1)) {
1455                 ret = -1;
1456                 if (!quiet)
1457                         fprintf_ln(stderr, _("Cannot save the current status"));
1458                 goto done;
1459         }
1460
1461         if (!quiet)
1462                 printf_ln(_("Saved working directory and index state %s"),
1463                           stash_msg_buf.buf);
1464
1465         if (!patch_mode) {
1466                 if (include_untracked && !ps->nr) {
1467                         struct child_process cp = CHILD_PROCESS_INIT;
1468
1469                         cp.git_cmd = 1;
1470                         strvec_pushl(&cp.args, "clean", "--force",
1471                                      "--quiet", "-d", NULL);
1472                         if (include_untracked == INCLUDE_ALL_FILES)
1473                                 strvec_push(&cp.args, "-x");
1474                         if (run_command(&cp)) {
1475                                 ret = -1;
1476                                 goto done;
1477                         }
1478                 }
1479                 discard_cache();
1480                 if (ps->nr) {
1481                         struct child_process cp_add = CHILD_PROCESS_INIT;
1482                         struct child_process cp_diff = CHILD_PROCESS_INIT;
1483                         struct child_process cp_apply = CHILD_PROCESS_INIT;
1484                         struct strbuf out = STRBUF_INIT;
1485
1486                         cp_add.git_cmd = 1;
1487                         strvec_push(&cp_add.args, "add");
1488                         if (!include_untracked)
1489                                 strvec_push(&cp_add.args, "-u");
1490                         if (include_untracked == INCLUDE_ALL_FILES)
1491                                 strvec_push(&cp_add.args, "--force");
1492                         strvec_push(&cp_add.args, "--");
1493                         add_pathspecs(&cp_add.args, ps);
1494                         if (run_command(&cp_add)) {
1495                                 ret = -1;
1496                                 goto done;
1497                         }
1498
1499                         cp_diff.git_cmd = 1;
1500                         strvec_pushl(&cp_diff.args, "diff-index", "-p",
1501                                      "--cached", "--binary", "HEAD", "--",
1502                                      NULL);
1503                         add_pathspecs(&cp_diff.args, ps);
1504                         if (pipe_command(&cp_diff, NULL, 0, &out, 0, NULL, 0)) {
1505                                 ret = -1;
1506                                 goto done;
1507                         }
1508
1509                         cp_apply.git_cmd = 1;
1510                         strvec_pushl(&cp_apply.args, "apply", "--index",
1511                                      "-R", NULL);
1512                         if (pipe_command(&cp_apply, out.buf, out.len, NULL, 0,
1513                                          NULL, 0)) {
1514                                 ret = -1;
1515                                 goto done;
1516                         }
1517                 } else {
1518                         struct child_process cp = CHILD_PROCESS_INIT;
1519                         cp.git_cmd = 1;
1520                         strvec_pushl(&cp.args, "reset", "--hard", "-q",
1521                                      "--no-recurse-submodules", NULL);
1522                         if (run_command(&cp)) {
1523                                 ret = -1;
1524                                 goto done;
1525                         }
1526                 }
1527
1528                 if (keep_index == 1 && !is_null_oid(&info.i_tree)) {
1529                         struct child_process cp = CHILD_PROCESS_INIT;
1530
1531                         cp.git_cmd = 1;
1532                         strvec_pushl(&cp.args, "checkout", "--no-overlay",
1533                                      oid_to_hex(&info.i_tree), "--", NULL);
1534                         if (!ps->nr)
1535                                 strvec_push(&cp.args, ":/");
1536                         else
1537                                 add_pathspecs(&cp.args, ps);
1538                         if (run_command(&cp)) {
1539                                 ret = -1;
1540                                 goto done;
1541                         }
1542                 }
1543                 goto done;
1544         } else {
1545                 struct child_process cp = CHILD_PROCESS_INIT;
1546
1547                 cp.git_cmd = 1;
1548                 strvec_pushl(&cp.args, "apply", "-R", NULL);
1549
1550                 if (pipe_command(&cp, patch.buf, patch.len, NULL, 0, NULL, 0)) {
1551                         if (!quiet)
1552                                 fprintf_ln(stderr, _("Cannot remove "
1553                                                      "worktree changes"));
1554                         ret = -1;
1555                         goto done;
1556                 }
1557
1558                 if (keep_index < 1) {
1559                         struct child_process cp = CHILD_PROCESS_INIT;
1560
1561                         cp.git_cmd = 1;
1562                         strvec_pushl(&cp.args, "reset", "-q", "--", NULL);
1563                         add_pathspecs(&cp.args, ps);
1564                         if (run_command(&cp)) {
1565                                 ret = -1;
1566                                 goto done;
1567                         }
1568                 }
1569                 goto done;
1570         }
1571
1572 done:
1573         strbuf_release(&stash_msg_buf);
1574         return ret;
1575 }
1576
1577 static int push_stash(int argc, const char **argv, const char *prefix,
1578                       int push_assumed)
1579 {
1580         int force_assume = 0;
1581         int keep_index = -1;
1582         int patch_mode = 0;
1583         int include_untracked = 0;
1584         int quiet = 0;
1585         int pathspec_file_nul = 0;
1586         const char *stash_msg = NULL;
1587         const char *pathspec_from_file = NULL;
1588         struct pathspec ps;
1589         struct option options[] = {
1590                 OPT_BOOL('k', "keep-index", &keep_index,
1591                          N_("keep index")),
1592                 OPT_BOOL('p', "patch", &patch_mode,
1593                          N_("stash in patch mode")),
1594                 OPT__QUIET(&quiet, N_("quiet mode")),
1595                 OPT_BOOL('u', "include-untracked", &include_untracked,
1596                          N_("include untracked files in stash")),
1597                 OPT_SET_INT('a', "all", &include_untracked,
1598                             N_("include ignore files"), 2),
1599                 OPT_STRING('m', "message", &stash_msg, N_("message"),
1600                            N_("stash message")),
1601                 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1602                 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
1603                 OPT_END()
1604         };
1605
1606         if (argc) {
1607                 force_assume = !strcmp(argv[0], "-p");
1608                 argc = parse_options(argc, argv, prefix, options,
1609                                      git_stash_push_usage,
1610                                      PARSE_OPT_KEEP_DASHDASH);
1611         }
1612
1613         if (argc) {
1614                 if (!strcmp(argv[0], "--")) {
1615                         argc--;
1616                         argv++;
1617                 } else if (push_assumed && !force_assume) {
1618                         die("subcommand wasn't specified; 'push' can't be assumed due to unexpected token '%s'",
1619                             argv[0]);
1620                 }
1621         }
1622
1623         parse_pathspec(&ps, 0, PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1624                        prefix, argv);
1625
1626         if (pathspec_from_file) {
1627                 if (patch_mode)
1628                         die(_("--pathspec-from-file is incompatible with --patch"));
1629
1630                 if (ps.nr)
1631                         die(_("--pathspec-from-file is incompatible with pathspec arguments"));
1632
1633                 parse_pathspec_file(&ps, 0,
1634                                     PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1635                                     prefix, pathspec_from_file, pathspec_file_nul);
1636         } else if (pathspec_file_nul) {
1637                 die(_("--pathspec-file-nul requires --pathspec-from-file"));
1638         }
1639
1640         return do_push_stash(&ps, stash_msg, quiet, keep_index, patch_mode,
1641                              include_untracked);
1642 }
1643
1644 static int save_stash(int argc, const char **argv, const char *prefix)
1645 {
1646         int keep_index = -1;
1647         int patch_mode = 0;
1648         int include_untracked = 0;
1649         int quiet = 0;
1650         int ret = 0;
1651         const char *stash_msg = NULL;
1652         struct pathspec ps;
1653         struct strbuf stash_msg_buf = STRBUF_INIT;
1654         struct option options[] = {
1655                 OPT_BOOL('k', "keep-index", &keep_index,
1656                          N_("keep index")),
1657                 OPT_BOOL('p', "patch", &patch_mode,
1658                          N_("stash in patch mode")),
1659                 OPT__QUIET(&quiet, N_("quiet mode")),
1660                 OPT_BOOL('u', "include-untracked", &include_untracked,
1661                          N_("include untracked files in stash")),
1662                 OPT_SET_INT('a', "all", &include_untracked,
1663                             N_("include ignore files"), 2),
1664                 OPT_STRING('m', "message", &stash_msg, "message",
1665                            N_("stash message")),
1666                 OPT_END()
1667         };
1668
1669         argc = parse_options(argc, argv, prefix, options,
1670                              git_stash_save_usage,
1671                              PARSE_OPT_KEEP_DASHDASH);
1672
1673         if (argc)
1674                 stash_msg = strbuf_join_argv(&stash_msg_buf, argc, argv, ' ');
1675
1676         memset(&ps, 0, sizeof(ps));
1677         ret = do_push_stash(&ps, stash_msg, quiet, keep_index,
1678                             patch_mode, include_untracked);
1679
1680         strbuf_release(&stash_msg_buf);
1681         return ret;
1682 }
1683
1684 int cmd_stash(int argc, const char **argv, const char *prefix)
1685 {
1686         pid_t pid = getpid();
1687         const char *index_file;
1688         struct strvec args = STRVEC_INIT;
1689
1690         struct option options[] = {
1691                 OPT_END()
1692         };
1693
1694         git_config(git_stash_config, NULL);
1695
1696         if (use_legacy_stash ||
1697             !git_env_bool("GIT_TEST_STASH_USE_BUILTIN", -1))
1698                 warning(_("the stash.useBuiltin support has been removed!\n"
1699                           "See its entry in 'git help config' for details."));
1700
1701         argc = parse_options(argc, argv, prefix, options, git_stash_usage,
1702                              PARSE_OPT_KEEP_UNKNOWN | PARSE_OPT_KEEP_DASHDASH);
1703
1704         index_file = get_index_file();
1705         strbuf_addf(&stash_index_path, "%s.stash.%" PRIuMAX, index_file,
1706                     (uintmax_t)pid);
1707
1708         if (!argc)
1709                 return !!push_stash(0, NULL, prefix, 0);
1710         else if (!strcmp(argv[0], "apply"))
1711                 return !!apply_stash(argc, argv, prefix);
1712         else if (!strcmp(argv[0], "clear"))
1713                 return !!clear_stash(argc, argv, prefix);
1714         else if (!strcmp(argv[0], "drop"))
1715                 return !!drop_stash(argc, argv, prefix);
1716         else if (!strcmp(argv[0], "pop"))
1717                 return !!pop_stash(argc, argv, prefix);
1718         else if (!strcmp(argv[0], "branch"))
1719                 return !!branch_stash(argc, argv, prefix);
1720         else if (!strcmp(argv[0], "list"))
1721                 return !!list_stash(argc, argv, prefix);
1722         else if (!strcmp(argv[0], "show"))
1723                 return !!show_stash(argc, argv, prefix);
1724         else if (!strcmp(argv[0], "store"))
1725                 return !!store_stash(argc, argv, prefix);
1726         else if (!strcmp(argv[0], "create"))
1727                 return !!create_stash(argc, argv, prefix);
1728         else if (!strcmp(argv[0], "push"))
1729                 return !!push_stash(argc, argv, prefix, 0);
1730         else if (!strcmp(argv[0], "save"))
1731                 return !!save_stash(argc, argv, prefix);
1732         else if (*argv[0] != '-')
1733                 usage_msg_opt(xstrfmt(_("unknown subcommand: %s"), argv[0]),
1734                               git_stash_usage, options);
1735
1736         /* Assume 'stash push' */
1737         strvec_push(&args, "push");
1738         strvec_pushv(&args, argv);
1739         return !!push_stash(args.nr, args.v, prefix, 1);
1740 }