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