cocci: apply the "cache.h" part of "the_repository.pending"
[alt-git.git] / builtin / stash.c
blobed1275829e7e4adb0136969c3b13cde2a40074f0
1 #define USE_THE_INDEX_VARIABLE
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 "merge-ort-wrappers.h"
11 #include "strvec.h"
12 #include "run-command.h"
13 #include "dir.h"
14 #include "entry.h"
15 #include "rerere.h"
16 #include "revision.h"
17 #include "log-tree.h"
18 #include "diffcore.h"
19 #include "exec-cmd.h"
20 #include "reflog.h"
21 #include "add-interactive.h"
23 #define INCLUDE_ALL_FILES 2
25 #define BUILTIN_STASH_LIST_USAGE \
26 N_("git stash list [<log-options>]")
27 #define BUILTIN_STASH_SHOW_USAGE \
28 N_("git stash show [-u | --include-untracked | --only-untracked] [<diff-options>] [<stash>]")
29 #define BUILTIN_STASH_DROP_USAGE \
30 N_("git stash drop [-q | --quiet] [<stash>]")
31 #define BUILTIN_STASH_POP_USAGE \
32 N_("git stash pop [--index] [-q | --quiet] [<stash>]")
33 #define BUILTIN_STASH_APPLY_USAGE \
34 N_("git stash apply [--index] [-q | --quiet] [<stash>]")
35 #define BUILTIN_STASH_BRANCH_USAGE \
36 N_("git stash branch <branchname> [<stash>]")
37 #define BUILTIN_STASH_STORE_USAGE \
38 N_("git stash store [(-m | --message) <message>] [-q | --quiet] <commit>")
39 #define BUILTIN_STASH_PUSH_USAGE \
40 N_("git stash [push [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]\n" \
41 " [-u | --include-untracked] [-a | --all] [(-m | --message) <message>]\n" \
42 " [--pathspec-from-file=<file> [--pathspec-file-nul]]\n" \
43 " [--] [<pathspec>...]]")
44 #define BUILTIN_STASH_SAVE_USAGE \
45 N_("git stash save [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]\n" \
46 " [-u | --include-untracked] [-a | --all] [<message>]")
47 #define BUILTIN_STASH_CREATE_USAGE \
48 N_("git stash create [<message>]")
49 #define BUILTIN_STASH_CLEAR_USAGE \
50 "git stash clear"
52 static const char * const git_stash_usage[] = {
53 BUILTIN_STASH_LIST_USAGE,
54 BUILTIN_STASH_SHOW_USAGE,
55 BUILTIN_STASH_DROP_USAGE,
56 BUILTIN_STASH_POP_USAGE,
57 BUILTIN_STASH_APPLY_USAGE,
58 BUILTIN_STASH_BRANCH_USAGE,
59 BUILTIN_STASH_PUSH_USAGE,
60 BUILTIN_STASH_SAVE_USAGE,
61 BUILTIN_STASH_CLEAR_USAGE,
62 BUILTIN_STASH_CREATE_USAGE,
63 BUILTIN_STASH_STORE_USAGE,
64 NULL
67 static const char * const git_stash_list_usage[] = {
68 BUILTIN_STASH_LIST_USAGE,
69 NULL
72 static const char * const git_stash_show_usage[] = {
73 BUILTIN_STASH_SHOW_USAGE,
74 NULL
77 static const char * const git_stash_drop_usage[] = {
78 BUILTIN_STASH_DROP_USAGE,
79 NULL
82 static const char * const git_stash_pop_usage[] = {
83 BUILTIN_STASH_POP_USAGE,
84 NULL
87 static const char * const git_stash_apply_usage[] = {
88 BUILTIN_STASH_APPLY_USAGE,
89 NULL
92 static const char * const git_stash_branch_usage[] = {
93 BUILTIN_STASH_BRANCH_USAGE,
94 NULL
97 static const char * const git_stash_clear_usage[] = {
98 BUILTIN_STASH_CLEAR_USAGE,
99 NULL
102 static const char * const git_stash_store_usage[] = {
103 BUILTIN_STASH_STORE_USAGE,
104 NULL
107 static const char * const git_stash_push_usage[] = {
108 BUILTIN_STASH_PUSH_USAGE,
109 NULL
112 static const char * const git_stash_save_usage[] = {
113 BUILTIN_STASH_SAVE_USAGE,
114 NULL
117 static const char ref_stash[] = "refs/stash";
118 static struct strbuf stash_index_path = STRBUF_INIT;
121 * w_commit is set to the commit containing the working tree
122 * b_commit is set to the base commit
123 * i_commit is set to the commit containing the index tree
124 * u_commit is set to the commit containing the untracked files tree
125 * w_tree is set to the working tree
126 * b_tree is set to the base tree
127 * i_tree is set to the index tree
128 * u_tree is set to the untracked files tree
130 struct stash_info {
131 struct object_id w_commit;
132 struct object_id b_commit;
133 struct object_id i_commit;
134 struct object_id u_commit;
135 struct object_id w_tree;
136 struct object_id b_tree;
137 struct object_id i_tree;
138 struct object_id u_tree;
139 struct strbuf revision;
140 int is_stash_ref;
141 int has_u;
144 #define STASH_INFO_INIT { \
145 .revision = STRBUF_INIT, \
148 static void free_stash_info(struct stash_info *info)
150 strbuf_release(&info->revision);
153 static void assert_stash_like(struct stash_info *info, const char *revision)
155 if (get_oidf(&info->b_commit, "%s^1", revision) ||
156 get_oidf(&info->w_tree, "%s:", revision) ||
157 get_oidf(&info->b_tree, "%s^1:", revision) ||
158 get_oidf(&info->i_tree, "%s^2:", revision))
159 die(_("'%s' is not a stash-like commit"), revision);
162 static int get_stash_info(struct stash_info *info, int argc, const char **argv)
164 int ret;
165 char *end_of_rev;
166 char *expanded_ref;
167 const char *revision;
168 const char *commit = NULL;
169 struct object_id dummy;
170 struct strbuf symbolic = STRBUF_INIT;
172 if (argc > 1) {
173 int i;
174 struct strbuf refs_msg = STRBUF_INIT;
176 for (i = 0; i < argc; i++)
177 strbuf_addf(&refs_msg, " '%s'", argv[i]);
179 fprintf_ln(stderr, _("Too many revisions specified:%s"),
180 refs_msg.buf);
181 strbuf_release(&refs_msg);
183 return -1;
186 if (argc == 1)
187 commit = argv[0];
189 if (!commit) {
190 if (!ref_exists(ref_stash)) {
191 fprintf_ln(stderr, _("No stash entries found."));
192 return -1;
195 strbuf_addf(&info->revision, "%s@{0}", ref_stash);
196 } else if (strspn(commit, "0123456789") == strlen(commit)) {
197 strbuf_addf(&info->revision, "%s@{%s}", ref_stash, commit);
198 } else {
199 strbuf_addstr(&info->revision, commit);
202 revision = info->revision.buf;
204 if (repo_get_oid(the_repository, revision, &info->w_commit))
205 return error(_("%s is not a valid reference"), revision);
207 assert_stash_like(info, revision);
209 info->has_u = !get_oidf(&info->u_tree, "%s^3:", revision);
211 end_of_rev = strchrnul(revision, '@');
212 strbuf_add(&symbolic, revision, end_of_rev - revision);
214 ret = dwim_ref(symbolic.buf, symbolic.len, &dummy, &expanded_ref, 0);
215 strbuf_release(&symbolic);
216 switch (ret) {
217 case 0: /* Not found, but valid ref */
218 info->is_stash_ref = 0;
219 break;
220 case 1:
221 info->is_stash_ref = !strcmp(expanded_ref, ref_stash);
222 break;
223 default: /* Invalid or ambiguous */
224 break;
227 free(expanded_ref);
228 return !(ret == 0 || ret == 1);
231 static int do_clear_stash(void)
233 struct object_id obj;
234 if (repo_get_oid(the_repository, ref_stash, &obj))
235 return 0;
237 return delete_ref(NULL, ref_stash, &obj, 0);
240 static int clear_stash(int argc, const char **argv, const char *prefix)
242 struct option options[] = {
243 OPT_END()
246 argc = parse_options(argc, argv, prefix, options,
247 git_stash_clear_usage,
248 PARSE_OPT_STOP_AT_NON_OPTION);
250 if (argc)
251 return error(_("git stash clear with arguments is "
252 "unimplemented"));
254 return do_clear_stash();
257 static int reset_tree(struct object_id *i_tree, int update, int reset)
259 int nr_trees = 1;
260 struct unpack_trees_options opts;
261 struct tree_desc t[MAX_UNPACK_TREES];
262 struct tree *tree;
263 struct lock_file lock_file = LOCK_INIT;
265 repo_read_index_preload(the_repository, NULL, 0);
266 if (refresh_index(&the_index, REFRESH_QUIET, NULL, NULL, NULL))
267 return -1;
269 repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
271 memset(&opts, 0, sizeof(opts));
273 tree = parse_tree_indirect(i_tree);
274 if (parse_tree(tree))
275 return -1;
277 init_tree_desc(t, tree->buffer, tree->size);
279 opts.head_idx = 1;
280 opts.src_index = &the_index;
281 opts.dst_index = &the_index;
282 opts.merge = 1;
283 opts.reset = reset ? UNPACK_RESET_PROTECT_UNTRACKED : 0;
284 opts.update = update;
285 if (update)
286 opts.preserve_ignored = 0; /* FIXME: !overwrite_ignore */
287 opts.fn = oneway_merge;
289 if (unpack_trees(nr_trees, t, &opts))
290 return -1;
292 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
293 return error(_("unable to write new index file"));
295 return 0;
298 static int diff_tree_binary(struct strbuf *out, struct object_id *w_commit)
300 struct child_process cp = CHILD_PROCESS_INIT;
301 const char *w_commit_hex = oid_to_hex(w_commit);
304 * Diff-tree would not be very hard to replace with a native function,
305 * however it should be done together with apply_cached.
307 cp.git_cmd = 1;
308 strvec_pushl(&cp.args, "diff-tree", "--binary", NULL);
309 strvec_pushf(&cp.args, "%s^2^..%s^2", w_commit_hex, w_commit_hex);
311 return pipe_command(&cp, NULL, 0, out, 0, NULL, 0);
314 static int apply_cached(struct strbuf *out)
316 struct child_process cp = CHILD_PROCESS_INIT;
319 * Apply currently only reads either from stdin or a file, thus
320 * apply_all_patches would have to be updated to optionally take a
321 * buffer.
323 cp.git_cmd = 1;
324 strvec_pushl(&cp.args, "apply", "--cached", NULL);
325 return pipe_command(&cp, out->buf, out->len, NULL, 0, NULL, 0);
328 static int reset_head(void)
330 struct child_process cp = CHILD_PROCESS_INIT;
333 * Reset is overall quite simple, however there is no current public
334 * API for resetting.
336 cp.git_cmd = 1;
337 strvec_pushl(&cp.args, "reset", "--quiet", "--refresh", NULL);
339 return run_command(&cp);
342 static int is_path_a_directory(const char *path)
345 * This function differs from abspath.c:is_directory() in that
346 * here we use lstat() instead of stat(); we do not want to
347 * follow symbolic links here.
349 struct stat st;
350 return (!lstat(path, &st) && S_ISDIR(st.st_mode));
353 static void add_diff_to_buf(struct diff_queue_struct *q,
354 struct diff_options *options,
355 void *data)
357 int i;
359 for (i = 0; i < q->nr; i++) {
360 if (is_path_a_directory(q->queue[i]->one->path))
361 continue;
363 strbuf_addstr(data, q->queue[i]->one->path);
365 /* NUL-terminate: will be fed to update-index -z */
366 strbuf_addch(data, '\0');
370 static int restore_untracked(struct object_id *u_tree)
372 int res;
373 struct child_process cp = CHILD_PROCESS_INIT;
376 * We need to run restore files from a given index, but without
377 * affecting the current index, so we use GIT_INDEX_FILE with
378 * run_command to fork processes that will not interfere.
380 cp.git_cmd = 1;
381 strvec_push(&cp.args, "read-tree");
382 strvec_push(&cp.args, oid_to_hex(u_tree));
383 strvec_pushf(&cp.env, "GIT_INDEX_FILE=%s",
384 stash_index_path.buf);
385 if (run_command(&cp)) {
386 remove_path(stash_index_path.buf);
387 return -1;
390 child_process_init(&cp);
391 cp.git_cmd = 1;
392 strvec_pushl(&cp.args, "checkout-index", "--all", NULL);
393 strvec_pushf(&cp.env, "GIT_INDEX_FILE=%s",
394 stash_index_path.buf);
396 res = run_command(&cp);
397 remove_path(stash_index_path.buf);
398 return res;
401 static void unstage_changes_unless_new(struct object_id *orig_tree)
404 * When we enter this function, there has been a clean merge of
405 * relevant trees, and the merge logic always stages whatever merges
406 * cleanly. We want to unstage those changes, unless it corresponds
407 * to a file that didn't exist as of orig_tree.
409 * However, if any SKIP_WORKTREE path is modified relative to
410 * orig_tree, then we want to clear the SKIP_WORKTREE bit and write
411 * it to the worktree before unstaging.
414 struct checkout state = CHECKOUT_INIT;
415 struct diff_options diff_opts;
416 struct lock_file lock = LOCK_INIT;
417 int i;
419 /* If any entries have skip_worktree set, we'll have to check 'em out */
420 state.force = 1;
421 state.quiet = 1;
422 state.refresh_cache = 1;
423 state.istate = &the_index;
426 * Step 1: get a difference between orig_tree (which corresponding
427 * to the index before a merge was run) and the current index
428 * (reflecting the changes brought in by the merge).
430 diff_setup(&diff_opts);
431 diff_opts.flags.recursive = 1;
432 diff_opts.detect_rename = 0;
433 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
434 diff_setup_done(&diff_opts);
436 do_diff_cache(orig_tree, &diff_opts);
437 diffcore_std(&diff_opts);
439 /* Iterate over the paths that changed due to the merge... */
440 for (i = 0; i < diff_queued_diff.nr; i++) {
441 struct diff_filepair *p;
442 struct cache_entry *ce;
443 int pos;
445 /* Look up the path's position in the current index. */
446 p = diff_queued_diff.queue[i];
447 pos = index_name_pos(&the_index, p->two->path,
448 strlen(p->two->path));
451 * Step 2: Place changes in the working tree
453 * Stash is about restoring changes *to the working tree*.
454 * So if the merge successfully got a new version of some
455 * path, but left it out of the working tree, then clear the
456 * SKIP_WORKTREE bit and write it to the working tree.
458 if (pos >= 0 && ce_skip_worktree(the_index.cache[pos])) {
459 struct stat st;
461 ce = the_index.cache[pos];
462 if (!lstat(ce->name, &st)) {
463 /* Conflicting path present; relocate it */
464 struct strbuf new_path = STRBUF_INIT;
465 int fd;
467 strbuf_addf(&new_path,
468 "%s.stash.XXXXXX", ce->name);
469 fd = xmkstemp(new_path.buf);
470 close(fd);
471 printf(_("WARNING: Untracked file in way of "
472 "tracked file! Renaming\n "
473 " %s -> %s\n"
474 " to make room.\n"),
475 ce->name, new_path.buf);
476 if (rename(ce->name, new_path.buf))
477 die("Failed to move %s to %s\n",
478 ce->name, new_path.buf);
479 strbuf_release(&new_path);
481 checkout_entry(ce, &state, NULL, NULL);
482 ce->ce_flags &= ~CE_SKIP_WORKTREE;
486 * Step 3: "unstage" changes, as long as they are still tracked
488 if (p->one->oid_valid) {
490 * Path existed in orig_tree; restore index entry
491 * from that tree in order to "unstage" the changes.
493 int option = ADD_CACHE_OK_TO_REPLACE;
494 if (pos < 0)
495 option = ADD_CACHE_OK_TO_ADD;
497 ce = make_cache_entry(&the_index,
498 p->one->mode,
499 &p->one->oid,
500 p->one->path,
501 0, 0);
502 add_index_entry(&the_index, ce, option);
505 diff_flush(&diff_opts);
508 * Step 4: write the new index to disk
510 repo_hold_locked_index(the_repository, &lock, LOCK_DIE_ON_ERROR);
511 if (write_locked_index(&the_index, &lock,
512 COMMIT_LOCK | SKIP_IF_UNCHANGED))
513 die(_("Unable to write index."));
516 static int do_apply_stash(const char *prefix, struct stash_info *info,
517 int index, int quiet)
519 int clean, ret;
520 int has_index = index;
521 struct merge_options o;
522 struct object_id c_tree;
523 struct object_id index_tree;
524 struct tree *head, *merge, *merge_base;
525 struct lock_file lock = LOCK_INIT;
527 repo_read_index_preload(the_repository, NULL, 0);
528 if (repo_refresh_and_write_index(the_repository, REFRESH_QUIET, 0, 0,
529 NULL, NULL, NULL))
530 return -1;
532 if (write_index_as_tree(&c_tree, &the_index, get_index_file(), 0,
533 NULL))
534 return error(_("cannot apply a stash in the middle of a merge"));
536 if (index) {
537 if (oideq(&info->b_tree, &info->i_tree) ||
538 oideq(&c_tree, &info->i_tree)) {
539 has_index = 0;
540 } else {
541 struct strbuf out = STRBUF_INIT;
543 if (diff_tree_binary(&out, &info->w_commit)) {
544 strbuf_release(&out);
545 return error(_("could not generate diff %s^!."),
546 oid_to_hex(&info->w_commit));
549 ret = apply_cached(&out);
550 strbuf_release(&out);
551 if (ret)
552 return error(_("conflicts in index. "
553 "Try without --index."));
555 discard_index(&the_index);
556 repo_read_index(the_repository);
557 if (write_index_as_tree(&index_tree, &the_index,
558 get_index_file(), 0, NULL))
559 return error(_("could not save index tree"));
561 reset_head();
562 discard_index(&the_index);
563 repo_read_index(the_repository);
567 init_merge_options(&o, the_repository);
569 o.branch1 = "Updated upstream";
570 o.branch2 = "Stashed changes";
571 o.ancestor = "Stash base";
573 if (oideq(&info->b_tree, &c_tree))
574 o.branch1 = "Version stash was based on";
576 if (quiet)
577 o.verbosity = 0;
579 if (o.verbosity >= 3)
580 printf_ln(_("Merging %s with %s"), o.branch1, o.branch2);
582 head = lookup_tree(o.repo, &c_tree);
583 merge = lookup_tree(o.repo, &info->w_tree);
584 merge_base = lookup_tree(o.repo, &info->b_tree);
586 repo_hold_locked_index(o.repo, &lock, LOCK_DIE_ON_ERROR);
587 clean = merge_ort_nonrecursive(&o, head, merge, merge_base);
590 * If 'clean' >= 0, reverse the value for 'ret' so 'ret' is 0 when the
591 * merge was clean, and nonzero if the merge was unclean or encountered
592 * an error.
594 ret = clean >= 0 ? !clean : clean;
596 if (ret < 0)
597 rollback_lock_file(&lock);
598 else if (write_locked_index(o.repo->index, &lock,
599 COMMIT_LOCK | SKIP_IF_UNCHANGED))
600 ret = error(_("could not write index"));
602 if (ret) {
603 rerere(0);
605 if (index)
606 fprintf_ln(stderr, _("Index was not unstashed."));
608 goto restore_untracked;
611 if (has_index) {
612 if (reset_tree(&index_tree, 0, 0))
613 ret = -1;
614 } else {
615 unstage_changes_unless_new(&c_tree);
618 restore_untracked:
619 if (info->has_u && restore_untracked(&info->u_tree))
620 ret = error(_("could not restore untracked files from stash"));
622 if (!quiet) {
623 struct child_process cp = CHILD_PROCESS_INIT;
626 * Status is quite simple and could be replaced with calls to
627 * wt_status in the future, but it adds complexities which may
628 * require more tests.
630 cp.git_cmd = 1;
631 cp.dir = prefix;
632 strvec_pushf(&cp.env, GIT_WORK_TREE_ENVIRONMENT"=%s",
633 absolute_path(get_git_work_tree()));
634 strvec_pushf(&cp.env, GIT_DIR_ENVIRONMENT"=%s",
635 absolute_path(get_git_dir()));
636 strvec_push(&cp.args, "status");
637 run_command(&cp);
640 return ret;
643 static int apply_stash(int argc, const char **argv, const char *prefix)
645 int ret = -1;
646 int quiet = 0;
647 int index = 0;
648 struct stash_info info = STASH_INFO_INIT;
649 struct option options[] = {
650 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
651 OPT_BOOL(0, "index", &index,
652 N_("attempt to recreate the index")),
653 OPT_END()
656 argc = parse_options(argc, argv, prefix, options,
657 git_stash_apply_usage, 0);
659 if (get_stash_info(&info, argc, argv))
660 goto cleanup;
662 ret = do_apply_stash(prefix, &info, index, quiet);
663 cleanup:
664 free_stash_info(&info);
665 return ret;
668 static int reject_reflog_ent(struct object_id *ooid UNUSED,
669 struct object_id *noid UNUSED,
670 const char *email UNUSED,
671 timestamp_t timestamp UNUSED,
672 int tz UNUSED, const char *message UNUSED,
673 void *cb_data UNUSED)
675 return 1;
678 static int reflog_is_empty(const char *refname)
680 return !for_each_reflog_ent(refname, reject_reflog_ent, NULL);
683 static int do_drop_stash(struct stash_info *info, int quiet)
685 if (!reflog_delete(info->revision.buf,
686 EXPIRE_REFLOGS_REWRITE | EXPIRE_REFLOGS_UPDATE_REF,
687 0)) {
688 if (!quiet)
689 printf_ln(_("Dropped %s (%s)"), info->revision.buf,
690 oid_to_hex(&info->w_commit));
691 } else {
692 return error(_("%s: Could not drop stash entry"),
693 info->revision.buf);
696 if (reflog_is_empty(ref_stash))
697 do_clear_stash();
699 return 0;
702 static int get_stash_info_assert(struct stash_info *info, int argc,
703 const char **argv)
705 int ret = get_stash_info(info, argc, argv);
707 if (ret < 0)
708 return ret;
710 if (!info->is_stash_ref)
711 return error(_("'%s' is not a stash reference"), info->revision.buf);
713 return 0;
716 static int drop_stash(int argc, const char **argv, const char *prefix)
718 int ret = -1;
719 int quiet = 0;
720 struct stash_info info = STASH_INFO_INIT;
721 struct option options[] = {
722 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
723 OPT_END()
726 argc = parse_options(argc, argv, prefix, options,
727 git_stash_drop_usage, 0);
729 if (get_stash_info_assert(&info, argc, argv))
730 goto cleanup;
732 ret = do_drop_stash(&info, quiet);
733 cleanup:
734 free_stash_info(&info);
735 return ret;
738 static int pop_stash(int argc, const char **argv, const char *prefix)
740 int ret = -1;
741 int index = 0;
742 int quiet = 0;
743 struct stash_info info = STASH_INFO_INIT;
744 struct option options[] = {
745 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
746 OPT_BOOL(0, "index", &index,
747 N_("attempt to recreate the index")),
748 OPT_END()
751 argc = parse_options(argc, argv, prefix, options,
752 git_stash_pop_usage, 0);
754 if (get_stash_info_assert(&info, argc, argv))
755 goto cleanup;
757 if ((ret = do_apply_stash(prefix, &info, index, quiet)))
758 printf_ln(_("The stash entry is kept in case "
759 "you need it again."));
760 else
761 ret = do_drop_stash(&info, quiet);
763 cleanup:
764 free_stash_info(&info);
765 return ret;
768 static int branch_stash(int argc, const char **argv, const char *prefix)
770 int ret = -1;
771 const char *branch = NULL;
772 struct stash_info info = STASH_INFO_INIT;
773 struct child_process cp = CHILD_PROCESS_INIT;
774 struct option options[] = {
775 OPT_END()
778 argc = parse_options(argc, argv, prefix, options,
779 git_stash_branch_usage, 0);
781 if (!argc) {
782 fprintf_ln(stderr, _("No branch name specified"));
783 return -1;
786 branch = argv[0];
788 if (get_stash_info(&info, argc - 1, argv + 1))
789 goto cleanup;
791 cp.git_cmd = 1;
792 strvec_pushl(&cp.args, "checkout", "-b", NULL);
793 strvec_push(&cp.args, branch);
794 strvec_push(&cp.args, oid_to_hex(&info.b_commit));
795 ret = run_command(&cp);
796 if (!ret)
797 ret = do_apply_stash(prefix, &info, 1, 0);
798 if (!ret && info.is_stash_ref)
799 ret = do_drop_stash(&info, 0);
801 cleanup:
802 free_stash_info(&info);
803 return ret;
806 static int list_stash(int argc, const char **argv, const char *prefix)
808 struct child_process cp = CHILD_PROCESS_INIT;
809 struct option options[] = {
810 OPT_END()
813 argc = parse_options(argc, argv, prefix, options,
814 git_stash_list_usage,
815 PARSE_OPT_KEEP_UNKNOWN_OPT);
817 if (!ref_exists(ref_stash))
818 return 0;
820 cp.git_cmd = 1;
821 strvec_pushl(&cp.args, "log", "--format=%gd: %gs", "-g",
822 "--first-parent", NULL);
823 strvec_pushv(&cp.args, argv);
824 strvec_push(&cp.args, ref_stash);
825 strvec_push(&cp.args, "--");
826 return run_command(&cp);
829 static int show_stat = 1;
830 static int show_patch;
831 static int show_include_untracked;
833 static int git_stash_config(const char *var, const char *value, void *cb)
835 if (!strcmp(var, "stash.showstat")) {
836 show_stat = git_config_bool(var, value);
837 return 0;
839 if (!strcmp(var, "stash.showpatch")) {
840 show_patch = git_config_bool(var, value);
841 return 0;
843 if (!strcmp(var, "stash.showincludeuntracked")) {
844 show_include_untracked = git_config_bool(var, value);
845 return 0;
847 return git_diff_basic_config(var, value, cb);
850 static void diff_include_untracked(const struct stash_info *info, struct diff_options *diff_opt)
852 const struct object_id *oid[] = { &info->w_commit, &info->u_tree };
853 struct tree *tree[ARRAY_SIZE(oid)];
854 struct tree_desc tree_desc[ARRAY_SIZE(oid)];
855 struct unpack_trees_options unpack_tree_opt = { 0 };
856 int i;
858 for (i = 0; i < ARRAY_SIZE(oid); i++) {
859 tree[i] = parse_tree_indirect(oid[i]);
860 if (parse_tree(tree[i]) < 0)
861 die(_("failed to parse tree"));
862 init_tree_desc(&tree_desc[i], tree[i]->buffer, tree[i]->size);
865 unpack_tree_opt.head_idx = -1;
866 unpack_tree_opt.src_index = &the_index;
867 unpack_tree_opt.dst_index = &the_index;
868 unpack_tree_opt.merge = 1;
869 unpack_tree_opt.fn = stash_worktree_untracked_merge;
871 if (unpack_trees(ARRAY_SIZE(tree_desc), tree_desc, &unpack_tree_opt))
872 die(_("failed to unpack trees"));
874 do_diff_cache(&info->b_commit, diff_opt);
877 static int show_stash(int argc, const char **argv, const char *prefix)
879 int i;
880 int ret = -1;
881 struct stash_info info = STASH_INFO_INIT;
882 struct rev_info rev;
883 struct strvec stash_args = STRVEC_INIT;
884 struct strvec revision_args = STRVEC_INIT;
885 enum {
886 UNTRACKED_NONE,
887 UNTRACKED_INCLUDE,
888 UNTRACKED_ONLY
889 } show_untracked = show_include_untracked ? UNTRACKED_INCLUDE : UNTRACKED_NONE;
890 struct option options[] = {
891 OPT_SET_INT('u', "include-untracked", &show_untracked,
892 N_("include untracked files in the stash"),
893 UNTRACKED_INCLUDE),
894 OPT_SET_INT_F(0, "only-untracked", &show_untracked,
895 N_("only show untracked files in the stash"),
896 UNTRACKED_ONLY, PARSE_OPT_NONEG),
897 OPT_END()
899 int do_usage = 0;
901 init_diff_ui_defaults();
902 git_config(git_diff_ui_config, NULL);
903 init_revisions(&rev, prefix);
905 argc = parse_options(argc, argv, prefix, options, git_stash_show_usage,
906 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN_OPT |
907 PARSE_OPT_KEEP_DASHDASH);
909 strvec_push(&revision_args, argv[0]);
910 for (i = 1; i < argc; i++) {
911 if (argv[i][0] != '-')
912 strvec_push(&stash_args, argv[i]);
913 else
914 strvec_push(&revision_args, argv[i]);
917 if (get_stash_info(&info, stash_args.nr, stash_args.v))
918 goto cleanup;
921 * The config settings are applied only if there are not passed
922 * any options.
924 if (revision_args.nr == 1) {
925 if (show_stat)
926 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT;
928 if (show_patch)
929 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
931 if (!show_stat && !show_patch) {
932 ret = 0;
933 goto cleanup;
937 argc = setup_revisions(revision_args.nr, revision_args.v, &rev, NULL);
938 if (argc > 1)
939 goto usage;
940 if (!rev.diffopt.output_format) {
941 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
942 diff_setup_done(&rev.diffopt);
945 rev.diffopt.flags.recursive = 1;
946 setup_diff_pager(&rev.diffopt);
947 switch (show_untracked) {
948 case UNTRACKED_NONE:
949 diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
950 break;
951 case UNTRACKED_ONLY:
952 if (info.has_u)
953 diff_root_tree_oid(&info.u_tree, "", &rev.diffopt);
954 break;
955 case UNTRACKED_INCLUDE:
956 if (info.has_u)
957 diff_include_untracked(&info, &rev.diffopt);
958 else
959 diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
960 break;
962 log_tree_diff_flush(&rev);
964 ret = diff_result_code(&rev.diffopt, 0);
965 cleanup:
966 strvec_clear(&stash_args);
967 free_stash_info(&info);
968 release_revisions(&rev);
969 if (do_usage)
970 usage_with_options(git_stash_show_usage, options);
971 return ret;
972 usage:
973 do_usage = 1;
974 goto cleanup;
977 static int do_store_stash(const struct object_id *w_commit, const char *stash_msg,
978 int quiet)
980 if (!stash_msg)
981 stash_msg = "Created via \"git stash store\".";
983 if (update_ref(stash_msg, ref_stash, w_commit, NULL,
984 REF_FORCE_CREATE_REFLOG,
985 quiet ? UPDATE_REFS_QUIET_ON_ERR :
986 UPDATE_REFS_MSG_ON_ERR)) {
987 if (!quiet) {
988 fprintf_ln(stderr, _("Cannot update %s with %s"),
989 ref_stash, oid_to_hex(w_commit));
991 return -1;
994 return 0;
997 static int store_stash(int argc, const char **argv, const char *prefix)
999 int quiet = 0;
1000 const char *stash_msg = NULL;
1001 struct object_id obj;
1002 struct object_context dummy;
1003 struct option options[] = {
1004 OPT__QUIET(&quiet, N_("be quiet")),
1005 OPT_STRING('m', "message", &stash_msg, "message",
1006 N_("stash message")),
1007 OPT_END()
1010 argc = parse_options(argc, argv, prefix, options,
1011 git_stash_store_usage,
1012 PARSE_OPT_KEEP_UNKNOWN_OPT);
1014 if (argc != 1) {
1015 if (!quiet)
1016 fprintf_ln(stderr, _("\"git stash store\" requires one "
1017 "<commit> argument"));
1018 return -1;
1021 if (get_oid_with_context(the_repository,
1022 argv[0], quiet ? GET_OID_QUIETLY : 0, &obj,
1023 &dummy)) {
1024 if (!quiet)
1025 fprintf_ln(stderr, _("Cannot update %s with %s"),
1026 ref_stash, argv[0]);
1027 return -1;
1030 return do_store_stash(&obj, stash_msg, quiet);
1033 static void add_pathspecs(struct strvec *args,
1034 const struct pathspec *ps) {
1035 int i;
1037 for (i = 0; i < ps->nr; i++)
1038 strvec_push(args, ps->items[i].original);
1042 * `untracked_files` will be filled with the names of untracked files.
1043 * The return value is:
1045 * = 0 if there are not any untracked files
1046 * > 0 if there are untracked files
1048 static int get_untracked_files(const struct pathspec *ps, int include_untracked,
1049 struct strbuf *untracked_files)
1051 int i;
1052 int found = 0;
1053 struct dir_struct dir = DIR_INIT;
1055 if (include_untracked != INCLUDE_ALL_FILES)
1056 setup_standard_excludes(&dir);
1058 fill_directory(&dir, the_repository->index, ps);
1059 for (i = 0; i < dir.nr; i++) {
1060 struct dir_entry *ent = dir.entries[i];
1061 found++;
1062 strbuf_addstr(untracked_files, ent->name);
1063 /* NUL-terminate: will be fed to update-index -z */
1064 strbuf_addch(untracked_files, '\0');
1067 dir_clear(&dir);
1068 return found;
1072 * The return value of `check_changes_tracked_files()` can be:
1074 * < 0 if there was an error
1075 * = 0 if there are no changes.
1076 * > 0 if there are changes.
1078 static int check_changes_tracked_files(const struct pathspec *ps)
1080 int result;
1081 struct rev_info rev;
1082 struct object_id dummy;
1083 int ret = 0;
1085 /* No initial commit. */
1086 if (repo_get_oid(the_repository, "HEAD", &dummy))
1087 return -1;
1089 if (repo_read_index(the_repository) < 0)
1090 return -1;
1092 init_revisions(&rev, NULL);
1093 copy_pathspec(&rev.prune_data, ps);
1095 rev.diffopt.flags.quick = 1;
1096 rev.diffopt.flags.ignore_submodules = 1;
1097 rev.abbrev = 0;
1099 add_head_to_pending(&rev);
1100 diff_setup_done(&rev.diffopt);
1102 result = run_diff_index(&rev, 1);
1103 if (diff_result_code(&rev.diffopt, result)) {
1104 ret = 1;
1105 goto done;
1108 result = run_diff_files(&rev, 0);
1109 if (diff_result_code(&rev.diffopt, result)) {
1110 ret = 1;
1111 goto done;
1114 done:
1115 release_revisions(&rev);
1116 return ret;
1120 * The function will fill `untracked_files` with the names of untracked files
1121 * It will return 1 if there were any changes and 0 if there were not.
1123 static int check_changes(const struct pathspec *ps, int include_untracked,
1124 struct strbuf *untracked_files)
1126 int ret = 0;
1127 if (check_changes_tracked_files(ps))
1128 ret = 1;
1130 if (include_untracked && get_untracked_files(ps, include_untracked,
1131 untracked_files))
1132 ret = 1;
1134 return ret;
1137 static int save_untracked_files(struct stash_info *info, struct strbuf *msg,
1138 struct strbuf files)
1140 int ret = 0;
1141 struct strbuf untracked_msg = STRBUF_INIT;
1142 struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1143 struct index_state istate = INDEX_STATE_INIT(the_repository);
1145 cp_upd_index.git_cmd = 1;
1146 strvec_pushl(&cp_upd_index.args, "update-index", "-z", "--add",
1147 "--remove", "--stdin", NULL);
1148 strvec_pushf(&cp_upd_index.env, "GIT_INDEX_FILE=%s",
1149 stash_index_path.buf);
1151 strbuf_addf(&untracked_msg, "untracked files on %s\n", msg->buf);
1152 if (pipe_command(&cp_upd_index, files.buf, files.len, NULL, 0,
1153 NULL, 0)) {
1154 ret = -1;
1155 goto done;
1158 if (write_index_as_tree(&info->u_tree, &istate, stash_index_path.buf, 0,
1159 NULL)) {
1160 ret = -1;
1161 goto done;
1164 if (commit_tree(untracked_msg.buf, untracked_msg.len,
1165 &info->u_tree, NULL, &info->u_commit, NULL, NULL)) {
1166 ret = -1;
1167 goto done;
1170 done:
1171 release_index(&istate);
1172 strbuf_release(&untracked_msg);
1173 remove_path(stash_index_path.buf);
1174 return ret;
1177 static int stash_staged(struct stash_info *info, struct strbuf *out_patch,
1178 int quiet)
1180 int ret = 0;
1181 struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
1182 struct index_state istate = INDEX_STATE_INIT(the_repository);
1184 if (write_index_as_tree(&info->w_tree, &istate, the_repository->index_file,
1185 0, NULL)) {
1186 ret = -1;
1187 goto done;
1190 cp_diff_tree.git_cmd = 1;
1191 strvec_pushl(&cp_diff_tree.args, "diff-tree", "-p", "-U1", "HEAD",
1192 oid_to_hex(&info->w_tree), "--", NULL);
1193 if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1194 ret = -1;
1195 goto done;
1198 if (!out_patch->len) {
1199 if (!quiet)
1200 fprintf_ln(stderr, _("No staged changes"));
1201 ret = 1;
1204 done:
1205 release_index(&istate);
1206 return ret;
1209 static int stash_patch(struct stash_info *info, const struct pathspec *ps,
1210 struct strbuf *out_patch, int quiet)
1212 int ret = 0;
1213 struct child_process cp_read_tree = CHILD_PROCESS_INIT;
1214 struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
1215 struct index_state istate = INDEX_STATE_INIT(the_repository);
1216 char *old_index_env = NULL, *old_repo_index_file;
1218 remove_path(stash_index_path.buf);
1220 cp_read_tree.git_cmd = 1;
1221 strvec_pushl(&cp_read_tree.args, "read-tree", "HEAD", NULL);
1222 strvec_pushf(&cp_read_tree.env, "GIT_INDEX_FILE=%s",
1223 stash_index_path.buf);
1224 if (run_command(&cp_read_tree)) {
1225 ret = -1;
1226 goto done;
1229 /* Find out what the user wants. */
1230 old_repo_index_file = the_repository->index_file;
1231 the_repository->index_file = stash_index_path.buf;
1232 old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
1233 setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
1235 ret = !!run_add_p(the_repository, ADD_P_STASH, NULL, ps);
1237 the_repository->index_file = old_repo_index_file;
1238 if (old_index_env && *old_index_env)
1239 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
1240 else
1241 unsetenv(INDEX_ENVIRONMENT);
1242 FREE_AND_NULL(old_index_env);
1244 /* State of the working tree. */
1245 if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1246 NULL)) {
1247 ret = -1;
1248 goto done;
1251 cp_diff_tree.git_cmd = 1;
1252 strvec_pushl(&cp_diff_tree.args, "diff-tree", "-p", "-U1", "HEAD",
1253 oid_to_hex(&info->w_tree), "--", NULL);
1254 if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1255 ret = -1;
1256 goto done;
1259 if (!out_patch->len) {
1260 if (!quiet)
1261 fprintf_ln(stderr, _("No changes selected"));
1262 ret = 1;
1265 done:
1266 release_index(&istate);
1267 remove_path(stash_index_path.buf);
1268 return ret;
1271 static int stash_working_tree(struct stash_info *info, const struct pathspec *ps)
1273 int ret = 0;
1274 struct rev_info rev;
1275 struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1276 struct strbuf diff_output = STRBUF_INIT;
1277 struct index_state istate = INDEX_STATE_INIT(the_repository);
1279 init_revisions(&rev, NULL);
1280 copy_pathspec(&rev.prune_data, ps);
1282 set_alternate_index_output(stash_index_path.buf);
1283 if (reset_tree(&info->i_tree, 0, 0)) {
1284 ret = -1;
1285 goto done;
1287 set_alternate_index_output(NULL);
1289 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1290 rev.diffopt.format_callback = add_diff_to_buf;
1291 rev.diffopt.format_callback_data = &diff_output;
1293 if (repo_read_index_preload(the_repository, &rev.diffopt.pathspec, 0) < 0) {
1294 ret = -1;
1295 goto done;
1298 add_pending_object(&rev, parse_object(the_repository, &info->b_commit),
1299 "");
1300 if (run_diff_index(&rev, 0)) {
1301 ret = -1;
1302 goto done;
1305 cp_upd_index.git_cmd = 1;
1306 strvec_pushl(&cp_upd_index.args, "update-index",
1307 "--ignore-skip-worktree-entries",
1308 "-z", "--add", "--remove", "--stdin", NULL);
1309 strvec_pushf(&cp_upd_index.env, "GIT_INDEX_FILE=%s",
1310 stash_index_path.buf);
1312 if (pipe_command(&cp_upd_index, diff_output.buf, diff_output.len,
1313 NULL, 0, NULL, 0)) {
1314 ret = -1;
1315 goto done;
1318 if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1319 NULL)) {
1320 ret = -1;
1321 goto done;
1324 done:
1325 release_index(&istate);
1326 release_revisions(&rev);
1327 strbuf_release(&diff_output);
1328 remove_path(stash_index_path.buf);
1329 return ret;
1332 static int do_create_stash(const struct pathspec *ps, struct strbuf *stash_msg_buf,
1333 int include_untracked, int patch_mode, int only_staged,
1334 struct stash_info *info, struct strbuf *patch,
1335 int quiet)
1337 int ret = 0;
1338 int flags = 0;
1339 int untracked_commit_option = 0;
1340 const char *head_short_sha1 = NULL;
1341 const char *branch_ref = NULL;
1342 const char *branch_name = "(no branch)";
1343 struct commit *head_commit = NULL;
1344 struct commit_list *parents = NULL;
1345 struct strbuf msg = STRBUF_INIT;
1346 struct strbuf commit_tree_label = STRBUF_INIT;
1347 struct strbuf untracked_files = STRBUF_INIT;
1349 prepare_fallback_ident("git stash", "git@stash");
1351 repo_read_index_preload(the_repository, NULL, 0);
1352 if (repo_refresh_and_write_index(the_repository, REFRESH_QUIET, 0, 0,
1353 NULL, NULL, NULL) < 0) {
1354 ret = -1;
1355 goto done;
1358 if (repo_get_oid(the_repository, "HEAD", &info->b_commit)) {
1359 if (!quiet)
1360 fprintf_ln(stderr, _("You do not have "
1361 "the initial commit yet"));
1362 ret = -1;
1363 goto done;
1364 } else {
1365 head_commit = lookup_commit(the_repository, &info->b_commit);
1368 if (!check_changes(ps, include_untracked, &untracked_files)) {
1369 ret = 1;
1370 goto done;
1373 branch_ref = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
1374 if (flags & REF_ISSYMREF)
1375 skip_prefix(branch_ref, "refs/heads/", &branch_name);
1376 head_short_sha1 = repo_find_unique_abbrev(the_repository,
1377 &head_commit->object.oid,
1378 DEFAULT_ABBREV);
1379 strbuf_addf(&msg, "%s: %s ", branch_name, head_short_sha1);
1380 pp_commit_easy(CMIT_FMT_ONELINE, head_commit, &msg);
1382 strbuf_addf(&commit_tree_label, "index on %s\n", msg.buf);
1383 commit_list_insert(head_commit, &parents);
1384 if (write_index_as_tree(&info->i_tree, &the_index, get_index_file(), 0,
1385 NULL) ||
1386 commit_tree(commit_tree_label.buf, commit_tree_label.len,
1387 &info->i_tree, parents, &info->i_commit, NULL, NULL)) {
1388 if (!quiet)
1389 fprintf_ln(stderr, _("Cannot save the current "
1390 "index state"));
1391 ret = -1;
1392 goto done;
1395 if (include_untracked) {
1396 if (save_untracked_files(info, &msg, untracked_files)) {
1397 if (!quiet)
1398 fprintf_ln(stderr, _("Cannot save "
1399 "the untracked files"));
1400 ret = -1;
1401 goto done;
1403 untracked_commit_option = 1;
1405 if (patch_mode) {
1406 ret = stash_patch(info, ps, patch, quiet);
1407 if (ret < 0) {
1408 if (!quiet)
1409 fprintf_ln(stderr, _("Cannot save the current "
1410 "worktree state"));
1411 goto done;
1412 } else if (ret > 0) {
1413 goto done;
1415 } else if (only_staged) {
1416 ret = stash_staged(info, patch, quiet);
1417 if (ret < 0) {
1418 if (!quiet)
1419 fprintf_ln(stderr, _("Cannot save the current "
1420 "staged state"));
1421 goto done;
1422 } else if (ret > 0) {
1423 goto done;
1425 } else {
1426 if (stash_working_tree(info, ps)) {
1427 if (!quiet)
1428 fprintf_ln(stderr, _("Cannot save the current "
1429 "worktree state"));
1430 ret = -1;
1431 goto done;
1435 if (!stash_msg_buf->len)
1436 strbuf_addf(stash_msg_buf, "WIP on %s", msg.buf);
1437 else
1438 strbuf_insertf(stash_msg_buf, 0, "On %s: ", branch_name);
1441 * `parents` will be empty after calling `commit_tree()`, so there is
1442 * no need to call `free_commit_list()`
1444 parents = NULL;
1445 if (untracked_commit_option)
1446 commit_list_insert(lookup_commit(the_repository,
1447 &info->u_commit),
1448 &parents);
1449 commit_list_insert(lookup_commit(the_repository, &info->i_commit),
1450 &parents);
1451 commit_list_insert(head_commit, &parents);
1453 if (commit_tree(stash_msg_buf->buf, stash_msg_buf->len, &info->w_tree,
1454 parents, &info->w_commit, NULL, NULL)) {
1455 if (!quiet)
1456 fprintf_ln(stderr, _("Cannot record "
1457 "working tree state"));
1458 ret = -1;
1459 goto done;
1462 done:
1463 strbuf_release(&commit_tree_label);
1464 strbuf_release(&msg);
1465 strbuf_release(&untracked_files);
1466 return ret;
1469 static int create_stash(int argc, const char **argv, const char *prefix)
1471 int ret;
1472 struct strbuf stash_msg_buf = STRBUF_INIT;
1473 struct stash_info info = STASH_INFO_INIT;
1474 struct pathspec ps;
1476 /* Starting with argv[1], since argv[0] is "create" */
1477 strbuf_join_argv(&stash_msg_buf, argc - 1, ++argv, ' ');
1479 memset(&ps, 0, sizeof(ps));
1480 if (!check_changes_tracked_files(&ps))
1481 return 0;
1483 ret = do_create_stash(&ps, &stash_msg_buf, 0, 0, 0, &info,
1484 NULL, 0);
1485 if (!ret)
1486 printf_ln("%s", oid_to_hex(&info.w_commit));
1488 free_stash_info(&info);
1489 strbuf_release(&stash_msg_buf);
1490 return ret;
1493 static int do_push_stash(const struct pathspec *ps, const char *stash_msg, int quiet,
1494 int keep_index, int patch_mode, int include_untracked, int only_staged)
1496 int ret = 0;
1497 struct stash_info info = STASH_INFO_INIT;
1498 struct strbuf patch = STRBUF_INIT;
1499 struct strbuf stash_msg_buf = STRBUF_INIT;
1500 struct strbuf untracked_files = STRBUF_INIT;
1502 if (patch_mode && keep_index == -1)
1503 keep_index = 1;
1505 if (patch_mode && include_untracked) {
1506 fprintf_ln(stderr, _("Can't use --patch and --include-untracked"
1507 " or --all at the same time"));
1508 ret = -1;
1509 goto done;
1512 /* --patch overrides --staged */
1513 if (patch_mode)
1514 only_staged = 0;
1516 if (only_staged && include_untracked) {
1517 fprintf_ln(stderr, _("Can't use --staged and --include-untracked"
1518 " or --all at the same time"));
1519 ret = -1;
1520 goto done;
1523 repo_read_index_preload(the_repository, NULL, 0);
1524 if (!include_untracked && ps->nr) {
1525 int i;
1526 char *ps_matched = xcalloc(ps->nr, 1);
1528 /* TODO: audit for interaction with sparse-index. */
1529 ensure_full_index(&the_index);
1530 for (i = 0; i < the_index.cache_nr; i++)
1531 ce_path_match(&the_index, the_index.cache[i], ps,
1532 ps_matched);
1534 if (report_path_error(ps_matched, ps)) {
1535 fprintf_ln(stderr, _("Did you forget to 'git add'?"));
1536 ret = -1;
1537 free(ps_matched);
1538 goto done;
1540 free(ps_matched);
1543 if (repo_refresh_and_write_index(the_repository, REFRESH_QUIET, 0, 0,
1544 NULL, NULL, NULL)) {
1545 ret = -1;
1546 goto done;
1549 if (!check_changes(ps, include_untracked, &untracked_files)) {
1550 if (!quiet)
1551 printf_ln(_("No local changes to save"));
1552 goto done;
1555 if (!reflog_exists(ref_stash) && do_clear_stash()) {
1556 ret = -1;
1557 if (!quiet)
1558 fprintf_ln(stderr, _("Cannot initialize stash"));
1559 goto done;
1562 if (stash_msg)
1563 strbuf_addstr(&stash_msg_buf, stash_msg);
1564 if (do_create_stash(ps, &stash_msg_buf, include_untracked, patch_mode, only_staged,
1565 &info, &patch, quiet)) {
1566 ret = -1;
1567 goto done;
1570 if (do_store_stash(&info.w_commit, stash_msg_buf.buf, 1)) {
1571 ret = -1;
1572 if (!quiet)
1573 fprintf_ln(stderr, _("Cannot save the current status"));
1574 goto done;
1577 if (!quiet)
1578 printf_ln(_("Saved working directory and index state %s"),
1579 stash_msg_buf.buf);
1581 if (!(patch_mode || only_staged)) {
1582 if (include_untracked && !ps->nr) {
1583 struct child_process cp = CHILD_PROCESS_INIT;
1585 cp.git_cmd = 1;
1586 if (startup_info->original_cwd) {
1587 cp.dir = startup_info->original_cwd;
1588 strvec_pushf(&cp.env, "%s=%s",
1589 GIT_WORK_TREE_ENVIRONMENT,
1590 the_repository->worktree);
1592 strvec_pushl(&cp.args, "clean", "--force",
1593 "--quiet", "-d", ":/", NULL);
1594 if (include_untracked == INCLUDE_ALL_FILES)
1595 strvec_push(&cp.args, "-x");
1596 if (run_command(&cp)) {
1597 ret = -1;
1598 goto done;
1601 discard_index(&the_index);
1602 if (ps->nr) {
1603 struct child_process cp_add = CHILD_PROCESS_INIT;
1604 struct child_process cp_diff = CHILD_PROCESS_INIT;
1605 struct child_process cp_apply = CHILD_PROCESS_INIT;
1606 struct strbuf out = STRBUF_INIT;
1608 cp_add.git_cmd = 1;
1609 strvec_push(&cp_add.args, "add");
1610 if (!include_untracked)
1611 strvec_push(&cp_add.args, "-u");
1612 if (include_untracked == INCLUDE_ALL_FILES)
1613 strvec_push(&cp_add.args, "--force");
1614 strvec_push(&cp_add.args, "--");
1615 add_pathspecs(&cp_add.args, ps);
1616 if (run_command(&cp_add)) {
1617 ret = -1;
1618 goto done;
1621 cp_diff.git_cmd = 1;
1622 strvec_pushl(&cp_diff.args, "diff-index", "-p",
1623 "--cached", "--binary", "HEAD", "--",
1624 NULL);
1625 add_pathspecs(&cp_diff.args, ps);
1626 if (pipe_command(&cp_diff, NULL, 0, &out, 0, NULL, 0)) {
1627 ret = -1;
1628 goto done;
1631 cp_apply.git_cmd = 1;
1632 strvec_pushl(&cp_apply.args, "apply", "--index",
1633 "-R", NULL);
1634 if (pipe_command(&cp_apply, out.buf, out.len, NULL, 0,
1635 NULL, 0)) {
1636 ret = -1;
1637 goto done;
1639 } else {
1640 struct child_process cp = CHILD_PROCESS_INIT;
1641 cp.git_cmd = 1;
1642 /* BUG: this nukes untracked files in the way */
1643 strvec_pushl(&cp.args, "reset", "--hard", "-q",
1644 "--no-recurse-submodules", NULL);
1645 if (run_command(&cp)) {
1646 ret = -1;
1647 goto done;
1651 if (keep_index == 1 && !is_null_oid(&info.i_tree)) {
1652 struct child_process cp = CHILD_PROCESS_INIT;
1654 cp.git_cmd = 1;
1655 strvec_pushl(&cp.args, "checkout", "--no-overlay",
1656 oid_to_hex(&info.i_tree), "--", NULL);
1657 if (!ps->nr)
1658 strvec_push(&cp.args, ":/");
1659 else
1660 add_pathspecs(&cp.args, ps);
1661 if (run_command(&cp)) {
1662 ret = -1;
1663 goto done;
1666 goto done;
1667 } else {
1668 struct child_process cp = CHILD_PROCESS_INIT;
1670 cp.git_cmd = 1;
1671 strvec_pushl(&cp.args, "apply", "-R", NULL);
1673 if (pipe_command(&cp, patch.buf, patch.len, NULL, 0, NULL, 0)) {
1674 if (!quiet)
1675 fprintf_ln(stderr, _("Cannot remove "
1676 "worktree changes"));
1677 ret = -1;
1678 goto done;
1681 if (keep_index < 1) {
1682 struct child_process cp = CHILD_PROCESS_INIT;
1684 cp.git_cmd = 1;
1685 strvec_pushl(&cp.args, "reset", "-q", "--refresh", "--",
1686 NULL);
1687 add_pathspecs(&cp.args, ps);
1688 if (run_command(&cp)) {
1689 ret = -1;
1690 goto done;
1693 goto done;
1696 done:
1697 strbuf_release(&patch);
1698 free_stash_info(&info);
1699 strbuf_release(&stash_msg_buf);
1700 strbuf_release(&untracked_files);
1701 return ret;
1704 static int push_stash(int argc, const char **argv, const char *prefix,
1705 int push_assumed)
1707 int force_assume = 0;
1708 int keep_index = -1;
1709 int only_staged = 0;
1710 int patch_mode = 0;
1711 int include_untracked = 0;
1712 int quiet = 0;
1713 int pathspec_file_nul = 0;
1714 const char *stash_msg = NULL;
1715 const char *pathspec_from_file = NULL;
1716 struct pathspec ps;
1717 struct option options[] = {
1718 OPT_BOOL('k', "keep-index", &keep_index,
1719 N_("keep index")),
1720 OPT_BOOL('S', "staged", &only_staged,
1721 N_("stash staged changes only")),
1722 OPT_BOOL('p', "patch", &patch_mode,
1723 N_("stash in patch mode")),
1724 OPT__QUIET(&quiet, N_("quiet mode")),
1725 OPT_BOOL('u', "include-untracked", &include_untracked,
1726 N_("include untracked files in stash")),
1727 OPT_SET_INT('a', "all", &include_untracked,
1728 N_("include ignore files"), 2),
1729 OPT_STRING('m', "message", &stash_msg, N_("message"),
1730 N_("stash message")),
1731 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1732 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
1733 OPT_END()
1735 int ret;
1737 if (argc) {
1738 force_assume = !strcmp(argv[0], "-p");
1739 argc = parse_options(argc, argv, prefix, options,
1740 push_assumed ? git_stash_usage :
1741 git_stash_push_usage,
1742 PARSE_OPT_KEEP_DASHDASH);
1745 if (argc) {
1746 if (!strcmp(argv[0], "--")) {
1747 argc--;
1748 argv++;
1749 } else if (push_assumed && !force_assume) {
1750 die("subcommand wasn't specified; 'push' can't be assumed due to unexpected token '%s'",
1751 argv[0]);
1755 parse_pathspec(&ps, 0, PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1756 prefix, argv);
1758 if (pathspec_from_file) {
1759 if (patch_mode)
1760 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--patch");
1762 if (only_staged)
1763 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--staged");
1765 if (ps.nr)
1766 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
1768 parse_pathspec_file(&ps, 0,
1769 PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1770 prefix, pathspec_from_file, pathspec_file_nul);
1771 } else if (pathspec_file_nul) {
1772 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
1775 ret = do_push_stash(&ps, stash_msg, quiet, keep_index, patch_mode,
1776 include_untracked, only_staged);
1777 clear_pathspec(&ps);
1778 return ret;
1781 static int push_stash_unassumed(int argc, const char **argv, const char *prefix)
1783 return push_stash(argc, argv, prefix, 0);
1786 static int save_stash(int argc, const char **argv, const char *prefix)
1788 int keep_index = -1;
1789 int only_staged = 0;
1790 int patch_mode = 0;
1791 int include_untracked = 0;
1792 int quiet = 0;
1793 int ret = 0;
1794 const char *stash_msg = NULL;
1795 struct pathspec ps;
1796 struct strbuf stash_msg_buf = STRBUF_INIT;
1797 struct option options[] = {
1798 OPT_BOOL('k', "keep-index", &keep_index,
1799 N_("keep index")),
1800 OPT_BOOL('S', "staged", &only_staged,
1801 N_("stash staged changes only")),
1802 OPT_BOOL('p', "patch", &patch_mode,
1803 N_("stash in patch mode")),
1804 OPT__QUIET(&quiet, N_("quiet mode")),
1805 OPT_BOOL('u', "include-untracked", &include_untracked,
1806 N_("include untracked files in stash")),
1807 OPT_SET_INT('a', "all", &include_untracked,
1808 N_("include ignore files"), 2),
1809 OPT_STRING('m', "message", &stash_msg, "message",
1810 N_("stash message")),
1811 OPT_END()
1814 argc = parse_options(argc, argv, prefix, options,
1815 git_stash_save_usage,
1816 PARSE_OPT_KEEP_DASHDASH);
1818 if (argc)
1819 stash_msg = strbuf_join_argv(&stash_msg_buf, argc, argv, ' ');
1821 memset(&ps, 0, sizeof(ps));
1822 ret = do_push_stash(&ps, stash_msg, quiet, keep_index,
1823 patch_mode, include_untracked, only_staged);
1825 strbuf_release(&stash_msg_buf);
1826 return ret;
1829 int cmd_stash(int argc, const char **argv, const char *prefix)
1831 pid_t pid = getpid();
1832 const char *index_file;
1833 struct strvec args = STRVEC_INIT;
1834 parse_opt_subcommand_fn *fn = NULL;
1835 struct option options[] = {
1836 OPT_SUBCOMMAND("apply", &fn, apply_stash),
1837 OPT_SUBCOMMAND("clear", &fn, clear_stash),
1838 OPT_SUBCOMMAND("drop", &fn, drop_stash),
1839 OPT_SUBCOMMAND("pop", &fn, pop_stash),
1840 OPT_SUBCOMMAND("branch", &fn, branch_stash),
1841 OPT_SUBCOMMAND("list", &fn, list_stash),
1842 OPT_SUBCOMMAND("show", &fn, show_stash),
1843 OPT_SUBCOMMAND("store", &fn, store_stash),
1844 OPT_SUBCOMMAND("create", &fn, create_stash),
1845 OPT_SUBCOMMAND("push", &fn, push_stash_unassumed),
1846 OPT_SUBCOMMAND_F("save", &fn, save_stash, PARSE_OPT_NOCOMPLETE),
1847 OPT_END()
1850 git_config(git_stash_config, NULL);
1852 argc = parse_options(argc, argv, prefix, options, git_stash_usage,
1853 PARSE_OPT_SUBCOMMAND_OPTIONAL |
1854 PARSE_OPT_KEEP_UNKNOWN_OPT |
1855 PARSE_OPT_KEEP_DASHDASH);
1857 prepare_repo_settings(the_repository);
1858 the_repository->settings.command_requires_full_index = 0;
1860 index_file = get_index_file();
1861 strbuf_addf(&stash_index_path, "%s.stash.%" PRIuMAX, index_file,
1862 (uintmax_t)pid);
1864 if (fn)
1865 return !!fn(argc, argv, prefix);
1866 else if (!argc)
1867 return !!push_stash_unassumed(0, NULL, prefix);
1869 /* Assume 'stash push' */
1870 strvec_push(&args, "push");
1871 strvec_pushv(&args, argv);
1872 return !!push_stash(args.nr, args.v, prefix, 1);