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