1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
4 #include "parse-options.h"
7 #include "cache-tree.h"
8 #include "unpack-trees.h"
9 #include "merge-recursive.h"
10 #include "argv-array.h"
11 #include "run-command.h"
19 #define INCLUDE_ALL_FILES 2
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>...]]"),
31 N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
32 " [-u|--include-untracked] [-a|--all] [<message>]"),
36 static const char * const git_stash_list_usage[] = {
37 N_("git stash list [<options>]"),
41 static const char * const git_stash_show_usage[] = {
42 N_("git stash show [<options>] [<stash>]"),
46 static const char * const git_stash_drop_usage[] = {
47 N_("git stash drop [-q|--quiet] [<stash>]"),
51 static const char * const git_stash_pop_usage[] = {
52 N_("git stash pop [--index] [-q|--quiet] [<stash>]"),
56 static const char * const git_stash_apply_usage[] = {
57 N_("git stash apply [--index] [-q|--quiet] [<stash>]"),
61 static const char * const git_stash_branch_usage[] = {
62 N_("git stash branch <branchname> [<stash>]"),
66 static const char * const git_stash_clear_usage[] = {
67 N_("git stash clear"),
71 static const char * const git_stash_store_usage[] = {
72 N_("git stash store [-m|--message <message>] [-q|--quiet] <commit>"),
76 static const char * const git_stash_push_usage[] = {
77 N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
78 " [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n"
79 " [--] [<pathspec>...]]"),
83 static const char * const git_stash_save_usage[] = {
84 N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
85 " [-u|--include-untracked] [-a|--all] [<message>]"),
89 static const char *ref_stash = "refs/stash";
90 static struct strbuf stash_index_path = STRBUF_INIT;
93 * w_commit is set to the commit containing the working tree
94 * b_commit is set to the base commit
95 * i_commit is set to the commit containing the index tree
96 * u_commit is set to the commit containing the untracked files tree
97 * w_tree is set to the working tree
98 * b_tree is set to the base tree
99 * i_tree is set to the index tree
100 * u_tree is set to the untracked files tree
103 struct object_id w_commit;
104 struct object_id b_commit;
105 struct object_id i_commit;
106 struct object_id u_commit;
107 struct object_id w_tree;
108 struct object_id b_tree;
109 struct object_id i_tree;
110 struct object_id u_tree;
111 struct strbuf revision;
116 static void free_stash_info(struct stash_info *info)
118 strbuf_release(&info->revision);
121 static void assert_stash_like(struct stash_info *info, const char *revision)
123 if (get_oidf(&info->b_commit, "%s^1", revision) ||
124 get_oidf(&info->w_tree, "%s:", revision) ||
125 get_oidf(&info->b_tree, "%s^1:", revision) ||
126 get_oidf(&info->i_tree, "%s^2:", revision))
127 die(_("'%s' is not a stash-like commit"), revision);
130 static int get_stash_info(struct stash_info *info, int argc, const char **argv)
135 const char *revision;
136 const char *commit = NULL;
137 struct object_id dummy;
138 struct strbuf symbolic = STRBUF_INIT;
142 struct strbuf refs_msg = STRBUF_INIT;
144 for (i = 0; i < argc; i++)
145 strbuf_addf(&refs_msg, " '%s'", argv[i]);
147 fprintf_ln(stderr, _("Too many revisions specified:%s"),
149 strbuf_release(&refs_msg);
157 strbuf_init(&info->revision, 0);
159 if (!ref_exists(ref_stash)) {
160 free_stash_info(info);
161 fprintf_ln(stderr, _("No stash entries found."));
165 strbuf_addf(&info->revision, "%s@{0}", ref_stash);
166 } else if (strspn(commit, "0123456789") == strlen(commit)) {
167 strbuf_addf(&info->revision, "%s@{%s}", ref_stash, commit);
169 strbuf_addstr(&info->revision, commit);
172 revision = info->revision.buf;
174 if (get_oid(revision, &info->w_commit)) {
175 error(_("%s is not a valid reference"), revision);
176 free_stash_info(info);
180 assert_stash_like(info, revision);
182 info->has_u = !get_oidf(&info->u_tree, "%s^3:", revision);
184 end_of_rev = strchrnul(revision, '@');
185 strbuf_add(&symbolic, revision, end_of_rev - revision);
187 ret = dwim_ref(symbolic.buf, symbolic.len, &dummy, &expanded_ref);
188 strbuf_release(&symbolic);
190 case 0: /* Not found, but valid ref */
191 info->is_stash_ref = 0;
194 info->is_stash_ref = !strcmp(expanded_ref, ref_stash);
196 default: /* Invalid or ambiguous */
197 free_stash_info(info);
201 return !(ret == 0 || ret == 1);
204 static int do_clear_stash(void)
206 struct object_id obj;
207 if (get_oid(ref_stash, &obj))
210 return delete_ref(NULL, ref_stash, &obj, 0);
213 static int clear_stash(int argc, const char **argv, const char *prefix)
215 struct option options[] = {
219 argc = parse_options(argc, argv, prefix, options,
220 git_stash_clear_usage,
221 PARSE_OPT_STOP_AT_NON_OPTION);
224 return error(_("git stash clear with parameters is "
227 return do_clear_stash();
230 static int reset_tree(struct object_id *i_tree, int update, int reset)
233 struct unpack_trees_options opts;
234 struct tree_desc t[MAX_UNPACK_TREES];
236 struct lock_file lock_file = LOCK_INIT;
238 read_cache_preload(NULL);
239 if (refresh_cache(REFRESH_QUIET))
242 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
244 memset(&opts, 0, sizeof(opts));
246 tree = parse_tree_indirect(i_tree);
247 if (parse_tree(tree))
250 init_tree_desc(t, tree->buffer, tree->size);
253 opts.src_index = &the_index;
254 opts.dst_index = &the_index;
257 opts.update = update;
258 opts.fn = oneway_merge;
260 if (unpack_trees(nr_trees, t, &opts))
263 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
264 return error(_("unable to write new index file"));
269 static int diff_tree_binary(struct strbuf *out, struct object_id *w_commit)
271 struct child_process cp = CHILD_PROCESS_INIT;
272 const char *w_commit_hex = oid_to_hex(w_commit);
275 * Diff-tree would not be very hard to replace with a native function,
276 * however it should be done together with apply_cached.
279 argv_array_pushl(&cp.args, "diff-tree", "--binary", NULL);
280 argv_array_pushf(&cp.args, "%s^2^..%s^2", w_commit_hex, w_commit_hex);
282 return pipe_command(&cp, NULL, 0, out, 0, NULL, 0);
285 static int apply_cached(struct strbuf *out)
287 struct child_process cp = CHILD_PROCESS_INIT;
290 * Apply currently only reads either from stdin or a file, thus
291 * apply_all_patches would have to be updated to optionally take a
295 argv_array_pushl(&cp.args, "apply", "--cached", NULL);
296 return pipe_command(&cp, out->buf, out->len, NULL, 0, NULL, 0);
299 static int reset_head(void)
301 struct child_process cp = CHILD_PROCESS_INIT;
304 * Reset is overall quite simple, however there is no current public
308 argv_array_push(&cp.args, "reset");
310 return run_command(&cp);
313 static void add_diff_to_buf(struct diff_queue_struct *q,
314 struct diff_options *options,
319 for (i = 0; i < q->nr; i++) {
320 strbuf_addstr(data, q->queue[i]->one->path);
322 /* NUL-terminate: will be fed to update-index -z */
323 strbuf_addch(data, '\0');
327 static int get_newly_staged(struct strbuf *out, struct object_id *c_tree)
329 struct child_process cp = CHILD_PROCESS_INIT;
330 const char *c_tree_hex = oid_to_hex(c_tree);
333 * diff-index is very similar to diff-tree above, and should be
334 * converted together with update_index.
337 argv_array_pushl(&cp.args, "diff-index", "--cached", "--name-only",
338 "--diff-filter=A", NULL);
339 argv_array_push(&cp.args, c_tree_hex);
340 return pipe_command(&cp, NULL, 0, out, 0, NULL, 0);
343 static int update_index(struct strbuf *out)
345 struct child_process cp = CHILD_PROCESS_INIT;
348 * Update-index is very complicated and may need to have a public
349 * function exposed in order to remove this forking.
352 argv_array_pushl(&cp.args, "update-index", "--add", "--stdin", NULL);
353 return pipe_command(&cp, out->buf, out->len, NULL, 0, NULL, 0);
356 static int restore_untracked(struct object_id *u_tree)
359 struct child_process cp = CHILD_PROCESS_INIT;
362 * We need to run restore files from a given index, but without
363 * affecting the current index, so we use GIT_INDEX_FILE with
364 * run_command to fork processes that will not interfere.
367 argv_array_push(&cp.args, "read-tree");
368 argv_array_push(&cp.args, oid_to_hex(u_tree));
369 argv_array_pushf(&cp.env_array, "GIT_INDEX_FILE=%s",
370 stash_index_path.buf);
371 if (run_command(&cp)) {
372 remove_path(stash_index_path.buf);
376 child_process_init(&cp);
378 argv_array_pushl(&cp.args, "checkout-index", "--all", NULL);
379 argv_array_pushf(&cp.env_array, "GIT_INDEX_FILE=%s",
380 stash_index_path.buf);
382 res = run_command(&cp);
383 remove_path(stash_index_path.buf);
387 static int do_apply_stash(const char *prefix, struct stash_info *info,
388 int index, int quiet)
391 int has_index = index;
392 struct merge_options o;
393 struct object_id c_tree;
394 struct object_id index_tree;
395 struct commit *result;
396 const struct object_id *bases[1];
398 read_cache_preload(NULL);
399 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0))
402 if (write_cache_as_tree(&c_tree, 0, NULL))
403 return error(_("cannot apply a stash in the middle of a merge"));
406 if (oideq(&info->b_tree, &info->i_tree) ||
407 oideq(&c_tree, &info->i_tree)) {
410 struct strbuf out = STRBUF_INIT;
412 if (diff_tree_binary(&out, &info->w_commit)) {
413 strbuf_release(&out);
414 return error(_("could not generate diff %s^!."),
415 oid_to_hex(&info->w_commit));
418 ret = apply_cached(&out);
419 strbuf_release(&out);
421 return error(_("conflicts in index."
422 "Try without --index."));
426 if (write_cache_as_tree(&index_tree, 0, NULL))
427 return error(_("could not save index tree"));
435 if (info->has_u && restore_untracked(&info->u_tree))
436 return error(_("could not restore untracked files from stash"));
438 init_merge_options(&o, the_repository);
440 o.branch1 = "Updated upstream";
441 o.branch2 = "Stashed changes";
443 if (oideq(&info->b_tree, &c_tree))
444 o.branch1 = "Version stash was based on";
449 if (o.verbosity >= 3)
450 printf_ln(_("Merging %s with %s"), o.branch1, o.branch2);
452 bases[0] = &info->b_tree;
454 ret = merge_recursive_generic(&o, &c_tree, &info->w_tree, 1, bases,
460 fprintf_ln(stderr, _("Index was not unstashed."));
466 if (reset_tree(&index_tree, 0, 0))
469 struct strbuf out = STRBUF_INIT;
471 if (get_newly_staged(&out, &c_tree)) {
472 strbuf_release(&out);
476 if (reset_tree(&c_tree, 0, 1)) {
477 strbuf_release(&out);
481 ret = update_index(&out);
482 strbuf_release(&out);
486 /* read back the result of update_index() back from the disk */
492 struct child_process cp = CHILD_PROCESS_INIT;
495 * Status is quite simple and could be replaced with calls to
496 * wt_status in the future, but it adds complexities which may
497 * require more tests.
501 argv_array_pushf(&cp.env_array, GIT_WORK_TREE_ENVIRONMENT"=%s",
502 absolute_path(get_git_work_tree()));
503 argv_array_pushf(&cp.env_array, GIT_DIR_ENVIRONMENT"=%s",
504 absolute_path(get_git_dir()));
505 argv_array_push(&cp.args, "status");
512 static int apply_stash(int argc, const char **argv, const char *prefix)
517 struct stash_info info;
518 struct option options[] = {
519 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
520 OPT_BOOL(0, "index", &index,
521 N_("attempt to recreate the index")),
525 argc = parse_options(argc, argv, prefix, options,
526 git_stash_apply_usage, 0);
528 if (get_stash_info(&info, argc, argv))
531 ret = do_apply_stash(prefix, &info, index, quiet);
532 free_stash_info(&info);
536 static int do_drop_stash(struct stash_info *info, int quiet)
539 struct child_process cp_reflog = CHILD_PROCESS_INIT;
540 struct child_process cp = CHILD_PROCESS_INIT;
543 * reflog does not provide a simple function for deleting refs. One will
544 * need to be added to avoid implementing too much reflog code here
547 cp_reflog.git_cmd = 1;
548 argv_array_pushl(&cp_reflog.args, "reflog", "delete", "--updateref",
550 argv_array_push(&cp_reflog.args, info->revision.buf);
551 ret = run_command(&cp_reflog);
554 printf_ln(_("Dropped %s (%s)"), info->revision.buf,
555 oid_to_hex(&info->w_commit));
557 return error(_("%s: Could not drop stash entry"),
562 * This could easily be replaced by get_oid, but currently it will throw
563 * a fatal error when a reflog is empty, which we can not recover from.
566 /* Even though --quiet is specified, rev-parse still outputs the hash */
568 argv_array_pushl(&cp.args, "rev-parse", "--verify", "--quiet", NULL);
569 argv_array_pushf(&cp.args, "%s@{0}", ref_stash);
570 ret = run_command(&cp);
572 /* do_clear_stash if we just dropped the last stash entry */
579 static void assert_stash_ref(struct stash_info *info)
581 if (!info->is_stash_ref) {
582 error(_("'%s' is not a stash reference"), info->revision.buf);
583 free_stash_info(info);
588 static int drop_stash(int argc, const char **argv, const char *prefix)
592 struct stash_info info;
593 struct option options[] = {
594 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
598 argc = parse_options(argc, argv, prefix, options,
599 git_stash_drop_usage, 0);
601 if (get_stash_info(&info, argc, argv))
604 assert_stash_ref(&info);
606 ret = do_drop_stash(&info, quiet);
607 free_stash_info(&info);
611 static int pop_stash(int argc, const char **argv, const char *prefix)
616 struct stash_info info;
617 struct option options[] = {
618 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
619 OPT_BOOL(0, "index", &index,
620 N_("attempt to recreate the index")),
624 argc = parse_options(argc, argv, prefix, options,
625 git_stash_pop_usage, 0);
627 if (get_stash_info(&info, argc, argv))
630 assert_stash_ref(&info);
631 if ((ret = do_apply_stash(prefix, &info, index, quiet)))
632 printf_ln(_("The stash entry is kept in case "
633 "you need it again."));
635 ret = do_drop_stash(&info, quiet);
637 free_stash_info(&info);
641 static int branch_stash(int argc, const char **argv, const char *prefix)
644 const char *branch = NULL;
645 struct stash_info info;
646 struct child_process cp = CHILD_PROCESS_INIT;
647 struct option options[] = {
651 argc = parse_options(argc, argv, prefix, options,
652 git_stash_branch_usage, 0);
655 fprintf_ln(stderr, _("No branch name specified"));
661 if (get_stash_info(&info, argc - 1, argv + 1))
665 argv_array_pushl(&cp.args, "checkout", "-b", NULL);
666 argv_array_push(&cp.args, branch);
667 argv_array_push(&cp.args, oid_to_hex(&info.b_commit));
668 ret = run_command(&cp);
670 ret = do_apply_stash(prefix, &info, 1, 0);
671 if (!ret && info.is_stash_ref)
672 ret = do_drop_stash(&info, 0);
674 free_stash_info(&info);
679 static int list_stash(int argc, const char **argv, const char *prefix)
681 struct child_process cp = CHILD_PROCESS_INIT;
682 struct option options[] = {
686 argc = parse_options(argc, argv, prefix, options,
687 git_stash_list_usage,
688 PARSE_OPT_KEEP_UNKNOWN);
690 if (!ref_exists(ref_stash))
694 argv_array_pushl(&cp.args, "log", "--format=%gd: %gs", "-g",
695 "--first-parent", "-m", NULL);
696 argv_array_pushv(&cp.args, argv);
697 argv_array_push(&cp.args, ref_stash);
698 argv_array_push(&cp.args, "--");
699 return run_command(&cp);
702 static int show_stat = 1;
703 static int show_patch;
705 static int git_stash_config(const char *var, const char *value, void *cb)
707 if (!strcmp(var, "stash.showstat")) {
708 show_stat = git_config_bool(var, value);
711 if (!strcmp(var, "stash.showpatch")) {
712 show_patch = git_config_bool(var, value);
715 return git_default_config(var, value, cb);
718 static int show_stash(int argc, const char **argv, const char *prefix)
722 struct stash_info info;
724 struct argv_array stash_args = ARGV_ARRAY_INIT;
725 struct argv_array revision_args = ARGV_ARRAY_INIT;
726 struct option options[] = {
730 init_diff_ui_defaults();
731 git_config(git_diff_ui_config, NULL);
732 init_revisions(&rev, prefix);
734 argv_array_push(&revision_args, argv[0]);
735 for (i = 1; i < argc; i++) {
736 if (argv[i][0] != '-')
737 argv_array_push(&stash_args, argv[i]);
739 argv_array_push(&revision_args, argv[i]);
742 ret = get_stash_info(&info, stash_args.argc, stash_args.argv);
743 argv_array_clear(&stash_args);
748 * The config settings are applied only if there are not passed
751 if (revision_args.argc == 1) {
752 git_config(git_stash_config, NULL);
754 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT;
757 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
759 if (!show_stat && !show_patch) {
760 free_stash_info(&info);
765 argc = setup_revisions(revision_args.argc, revision_args.argv, &rev, NULL);
767 free_stash_info(&info);
768 usage_with_options(git_stash_show_usage, options);
770 if (!rev.diffopt.output_format) {
771 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
772 diff_setup_done(&rev.diffopt);
775 rev.diffopt.flags.recursive = 1;
776 setup_diff_pager(&rev.diffopt);
777 diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
778 log_tree_diff_flush(&rev);
780 free_stash_info(&info);
781 return diff_result_code(&rev.diffopt, 0);
784 static int do_store_stash(const struct object_id *w_commit, const char *stash_msg,
788 stash_msg = "Created via \"git stash store\".";
790 if (update_ref(stash_msg, ref_stash, w_commit, NULL,
791 REF_FORCE_CREATE_REFLOG,
792 quiet ? UPDATE_REFS_QUIET_ON_ERR :
793 UPDATE_REFS_MSG_ON_ERR)) {
795 fprintf_ln(stderr, _("Cannot update %s with %s"),
796 ref_stash, oid_to_hex(w_commit));
804 static int store_stash(int argc, const char **argv, const char *prefix)
807 const char *stash_msg = NULL;
808 struct object_id obj;
809 struct object_context dummy;
810 struct option options[] = {
811 OPT__QUIET(&quiet, N_("be quiet")),
812 OPT_STRING('m', "message", &stash_msg, "message",
813 N_("stash message")),
817 argc = parse_options(argc, argv, prefix, options,
818 git_stash_store_usage,
819 PARSE_OPT_KEEP_UNKNOWN);
823 fprintf_ln(stderr, _("\"git stash store\" requires one "
824 "<commit> argument"));
828 if (get_oid_with_context(the_repository,
829 argv[0], quiet ? GET_OID_QUIETLY : 0, &obj,
832 fprintf_ln(stderr, _("Cannot update %s with %s"),
837 return do_store_stash(&obj, stash_msg, quiet);
840 static void add_pathspecs(struct argv_array *args,
841 const struct pathspec *ps) {
844 for (i = 0; i < ps->nr; i++)
845 argv_array_push(args, ps->items[i].original);
849 * `untracked_files` will be filled with the names of untracked files.
850 * The return value is:
852 * = 0 if there are not any untracked files
853 * > 0 if there are untracked files
855 static int get_untracked_files(const struct pathspec *ps, int include_untracked,
856 struct strbuf *untracked_files)
862 struct dir_struct dir;
864 memset(&dir, 0, sizeof(dir));
865 if (include_untracked != INCLUDE_ALL_FILES)
866 setup_standard_excludes(&dir);
868 seen = xcalloc(ps->nr, 1);
870 max_len = fill_directory(&dir, the_repository->index, ps);
871 for (i = 0; i < dir.nr; i++) {
872 struct dir_entry *ent = dir.entries[i];
873 if (dir_path_match(&the_index, ent, ps, max_len, seen)) {
875 strbuf_addstr(untracked_files, ent->name);
876 /* NUL-terminate: will be fed to update-index -z */
877 strbuf_addch(untracked_files, '\0');
885 clear_directory(&dir);
890 * The return value of `check_changes_tracked_files()` can be:
892 * < 0 if there was an error
893 * = 0 if there are no changes.
894 * > 0 if there are changes.
896 static int check_changes_tracked_files(const struct pathspec *ps)
900 struct object_id dummy;
903 /* No initial commit. */
904 if (get_oid("HEAD", &dummy))
907 if (read_cache() < 0)
910 init_revisions(&rev, NULL);
911 copy_pathspec(&rev.prune_data, ps);
913 rev.diffopt.flags.quick = 1;
914 rev.diffopt.flags.ignore_submodules = 1;
917 add_head_to_pending(&rev);
918 diff_setup_done(&rev.diffopt);
920 result = run_diff_index(&rev, 1);
921 if (diff_result_code(&rev.diffopt, result)) {
926 object_array_clear(&rev.pending);
927 result = run_diff_files(&rev, 0);
928 if (diff_result_code(&rev.diffopt, result)) {
934 clear_pathspec(&rev.prune_data);
939 * The function will fill `untracked_files` with the names of untracked files
940 * It will return 1 if there were any changes and 0 if there were not.
942 static int check_changes(const struct pathspec *ps, int include_untracked,
943 struct strbuf *untracked_files)
946 if (check_changes_tracked_files(ps))
949 if (include_untracked && get_untracked_files(ps, include_untracked,
956 static int save_untracked_files(struct stash_info *info, struct strbuf *msg,
960 struct strbuf untracked_msg = STRBUF_INIT;
961 struct child_process cp_upd_index = CHILD_PROCESS_INIT;
962 struct index_state istate = { NULL };
964 cp_upd_index.git_cmd = 1;
965 argv_array_pushl(&cp_upd_index.args, "update-index", "-z", "--add",
966 "--remove", "--stdin", NULL);
967 argv_array_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
968 stash_index_path.buf);
970 strbuf_addf(&untracked_msg, "untracked files on %s\n", msg->buf);
971 if (pipe_command(&cp_upd_index, files.buf, files.len, NULL, 0,
977 if (write_index_as_tree(&info->u_tree, &istate, stash_index_path.buf, 0,
983 if (commit_tree(untracked_msg.buf, untracked_msg.len,
984 &info->u_tree, NULL, &info->u_commit, NULL, NULL)) {
990 discard_index(&istate);
991 strbuf_release(&untracked_msg);
992 remove_path(stash_index_path.buf);
996 static int stash_patch(struct stash_info *info, const struct pathspec *ps,
997 struct strbuf *out_patch, int quiet)
1000 struct child_process cp_read_tree = CHILD_PROCESS_INIT;
1001 struct child_process cp_add_i = CHILD_PROCESS_INIT;
1002 struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
1003 struct index_state istate = { NULL };
1005 remove_path(stash_index_path.buf);
1007 cp_read_tree.git_cmd = 1;
1008 argv_array_pushl(&cp_read_tree.args, "read-tree", "HEAD", NULL);
1009 argv_array_pushf(&cp_read_tree.env_array, "GIT_INDEX_FILE=%s",
1010 stash_index_path.buf);
1011 if (run_command(&cp_read_tree)) {
1016 /* Find out what the user wants. */
1017 cp_add_i.git_cmd = 1;
1018 argv_array_pushl(&cp_add_i.args, "add--interactive", "--patch=stash",
1020 add_pathspecs(&cp_add_i.args, ps);
1021 argv_array_pushf(&cp_add_i.env_array, "GIT_INDEX_FILE=%s",
1022 stash_index_path.buf);
1023 if (run_command(&cp_add_i)) {
1028 /* State of the working tree. */
1029 if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1035 cp_diff_tree.git_cmd = 1;
1036 argv_array_pushl(&cp_diff_tree.args, "diff-tree", "-p", "HEAD",
1037 oid_to_hex(&info->w_tree), "--", NULL);
1038 if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1043 if (!out_patch->len) {
1045 fprintf_ln(stderr, _("No changes selected"));
1050 discard_index(&istate);
1051 remove_path(stash_index_path.buf);
1055 static int stash_working_tree(struct stash_info *info, const struct pathspec *ps)
1058 struct rev_info rev;
1059 struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1060 struct strbuf diff_output = STRBUF_INIT;
1061 struct index_state istate = { NULL };
1063 init_revisions(&rev, NULL);
1064 copy_pathspec(&rev.prune_data, ps);
1066 set_alternate_index_output(stash_index_path.buf);
1067 if (reset_tree(&info->i_tree, 0, 0)) {
1071 set_alternate_index_output(NULL);
1073 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1074 rev.diffopt.format_callback = add_diff_to_buf;
1075 rev.diffopt.format_callback_data = &diff_output;
1077 if (read_cache_preload(&rev.diffopt.pathspec) < 0) {
1082 add_pending_object(&rev, parse_object(the_repository, &info->b_commit),
1084 if (run_diff_index(&rev, 0)) {
1089 cp_upd_index.git_cmd = 1;
1090 argv_array_pushl(&cp_upd_index.args, "update-index",
1091 "--ignore-skip-worktree-entries",
1092 "-z", "--add", "--remove", "--stdin", NULL);
1093 argv_array_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
1094 stash_index_path.buf);
1096 if (pipe_command(&cp_upd_index, diff_output.buf, diff_output.len,
1097 NULL, 0, NULL, 0)) {
1102 if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1109 discard_index(&istate);
1111 object_array_clear(&rev.pending);
1112 clear_pathspec(&rev.prune_data);
1113 strbuf_release(&diff_output);
1114 remove_path(stash_index_path.buf);
1118 static int do_create_stash(const struct pathspec *ps, struct strbuf *stash_msg_buf,
1119 int include_untracked, int patch_mode,
1120 struct stash_info *info, struct strbuf *patch,
1125 int untracked_commit_option = 0;
1126 const char *head_short_sha1 = NULL;
1127 const char *branch_ref = NULL;
1128 const char *branch_name = "(no branch)";
1129 struct commit *head_commit = NULL;
1130 struct commit_list *parents = NULL;
1131 struct strbuf msg = STRBUF_INIT;
1132 struct strbuf commit_tree_label = STRBUF_INIT;
1133 struct strbuf untracked_files = STRBUF_INIT;
1135 prepare_fallback_ident("git stash", "git@stash");
1137 read_cache_preload(NULL);
1138 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0) {
1143 if (get_oid("HEAD", &info->b_commit)) {
1145 fprintf_ln(stderr, _("You do not have "
1146 "the initial commit yet"));
1150 head_commit = lookup_commit(the_repository, &info->b_commit);
1153 if (!check_changes(ps, include_untracked, &untracked_files)) {
1158 branch_ref = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
1159 if (flags & REF_ISSYMREF)
1160 branch_name = strrchr(branch_ref, '/') + 1;
1161 head_short_sha1 = find_unique_abbrev(&head_commit->object.oid,
1163 strbuf_addf(&msg, "%s: %s ", branch_name, head_short_sha1);
1164 pp_commit_easy(CMIT_FMT_ONELINE, head_commit, &msg);
1166 strbuf_addf(&commit_tree_label, "index on %s\n", msg.buf);
1167 commit_list_insert(head_commit, &parents);
1168 if (write_cache_as_tree(&info->i_tree, 0, NULL) ||
1169 commit_tree(commit_tree_label.buf, commit_tree_label.len,
1170 &info->i_tree, parents, &info->i_commit, NULL, NULL)) {
1172 fprintf_ln(stderr, _("Cannot save the current "
1178 if (include_untracked) {
1179 if (save_untracked_files(info, &msg, untracked_files)) {
1181 fprintf_ln(stderr, _("Cannot save "
1182 "the untracked files"));
1186 untracked_commit_option = 1;
1189 ret = stash_patch(info, ps, patch, quiet);
1192 fprintf_ln(stderr, _("Cannot save the current "
1195 } else if (ret > 0) {
1199 if (stash_working_tree(info, ps)) {
1201 fprintf_ln(stderr, _("Cannot save the current "
1208 if (!stash_msg_buf->len)
1209 strbuf_addf(stash_msg_buf, "WIP on %s", msg.buf);
1211 strbuf_insertf(stash_msg_buf, 0, "On %s: ", branch_name);
1214 * `parents` will be empty after calling `commit_tree()`, so there is
1215 * no need to call `free_commit_list()`
1218 if (untracked_commit_option)
1219 commit_list_insert(lookup_commit(the_repository,
1222 commit_list_insert(lookup_commit(the_repository, &info->i_commit),
1224 commit_list_insert(head_commit, &parents);
1226 if (commit_tree(stash_msg_buf->buf, stash_msg_buf->len, &info->w_tree,
1227 parents, &info->w_commit, NULL, NULL)) {
1229 fprintf_ln(stderr, _("Cannot record "
1230 "working tree state"));
1236 strbuf_release(&commit_tree_label);
1237 strbuf_release(&msg);
1238 strbuf_release(&untracked_files);
1242 static int create_stash(int argc, const char **argv, const char *prefix)
1245 struct strbuf stash_msg_buf = STRBUF_INIT;
1246 struct stash_info info;
1249 /* Starting with argv[1], since argv[0] is "create" */
1250 strbuf_join_argv(&stash_msg_buf, argc - 1, ++argv, ' ');
1252 memset(&ps, 0, sizeof(ps));
1253 if (!check_changes_tracked_files(&ps))
1256 ret = do_create_stash(&ps, &stash_msg_buf, 0, 0, &info,
1259 printf_ln("%s", oid_to_hex(&info.w_commit));
1261 strbuf_release(&stash_msg_buf);
1265 static int do_push_stash(const struct pathspec *ps, const char *stash_msg, int quiet,
1266 int keep_index, int patch_mode, int include_untracked)
1269 struct stash_info info;
1270 struct strbuf patch = STRBUF_INIT;
1271 struct strbuf stash_msg_buf = STRBUF_INIT;
1272 struct strbuf untracked_files = STRBUF_INIT;
1274 if (patch_mode && keep_index == -1)
1277 if (patch_mode && include_untracked) {
1278 fprintf_ln(stderr, _("Can't use --patch and --include-untracked"
1279 " or --all at the same time"));
1284 read_cache_preload(NULL);
1285 if (!include_untracked && ps->nr) {
1287 char *ps_matched = xcalloc(ps->nr, 1);
1289 for (i = 0; i < active_nr; i++)
1290 ce_path_match(&the_index, active_cache[i], ps,
1293 if (report_path_error(ps_matched, ps)) {
1294 fprintf_ln(stderr, _("Did you forget to 'git add'?"));
1302 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0)) {
1307 if (!check_changes(ps, include_untracked, &untracked_files)) {
1309 printf_ln(_("No local changes to save"));
1313 if (!reflog_exists(ref_stash) && do_clear_stash()) {
1316 fprintf_ln(stderr, _("Cannot initialize stash"));
1321 strbuf_addstr(&stash_msg_buf, stash_msg);
1322 if (do_create_stash(ps, &stash_msg_buf, include_untracked, patch_mode,
1323 &info, &patch, quiet)) {
1328 if (do_store_stash(&info.w_commit, stash_msg_buf.buf, 1)) {
1331 fprintf_ln(stderr, _("Cannot save the current status"));
1336 printf_ln(_("Saved working directory and index state %s"),
1340 if (include_untracked && !ps->nr) {
1341 struct child_process cp = CHILD_PROCESS_INIT;
1344 argv_array_pushl(&cp.args, "clean", "--force",
1345 "--quiet", "-d", NULL);
1346 if (include_untracked == INCLUDE_ALL_FILES)
1347 argv_array_push(&cp.args, "-x");
1348 if (run_command(&cp)) {
1355 struct child_process cp_add = CHILD_PROCESS_INIT;
1356 struct child_process cp_diff = CHILD_PROCESS_INIT;
1357 struct child_process cp_apply = CHILD_PROCESS_INIT;
1358 struct strbuf out = STRBUF_INIT;
1361 argv_array_push(&cp_add.args, "add");
1362 if (!include_untracked)
1363 argv_array_push(&cp_add.args, "-u");
1364 if (include_untracked == INCLUDE_ALL_FILES)
1365 argv_array_push(&cp_add.args, "--force");
1366 argv_array_push(&cp_add.args, "--");
1367 add_pathspecs(&cp_add.args, ps);
1368 if (run_command(&cp_add)) {
1373 cp_diff.git_cmd = 1;
1374 argv_array_pushl(&cp_diff.args, "diff-index", "-p",
1375 "--cached", "--binary", "HEAD", "--",
1377 add_pathspecs(&cp_diff.args, ps);
1378 if (pipe_command(&cp_diff, NULL, 0, &out, 0, NULL, 0)) {
1383 cp_apply.git_cmd = 1;
1384 argv_array_pushl(&cp_apply.args, "apply", "--index",
1386 if (pipe_command(&cp_apply, out.buf, out.len, NULL, 0,
1392 struct child_process cp = CHILD_PROCESS_INIT;
1394 argv_array_pushl(&cp.args, "reset", "--hard", "-q",
1395 "--no-recurse-submodules", NULL);
1396 if (run_command(&cp)) {
1402 if (keep_index == 1 && !is_null_oid(&info.i_tree)) {
1403 struct child_process cp = CHILD_PROCESS_INIT;
1406 argv_array_pushl(&cp.args, "checkout", "--no-overlay",
1407 oid_to_hex(&info.i_tree), "--", NULL);
1409 argv_array_push(&cp.args, ":/");
1411 add_pathspecs(&cp.args, ps);
1412 if (run_command(&cp)) {
1419 struct child_process cp = CHILD_PROCESS_INIT;
1422 argv_array_pushl(&cp.args, "apply", "-R", NULL);
1424 if (pipe_command(&cp, patch.buf, patch.len, NULL, 0, NULL, 0)) {
1426 fprintf_ln(stderr, _("Cannot remove "
1427 "worktree changes"));
1432 if (keep_index < 1) {
1433 struct child_process cp = CHILD_PROCESS_INIT;
1436 argv_array_pushl(&cp.args, "reset", "-q", "--", NULL);
1437 add_pathspecs(&cp.args, ps);
1438 if (run_command(&cp)) {
1447 strbuf_release(&stash_msg_buf);
1451 static int push_stash(int argc, const char **argv, const char *prefix)
1453 int keep_index = -1;
1455 int include_untracked = 0;
1457 const char *stash_msg = NULL;
1459 struct option options[] = {
1460 OPT_BOOL('k', "keep-index", &keep_index,
1462 OPT_BOOL('p', "patch", &patch_mode,
1463 N_("stash in patch mode")),
1464 OPT__QUIET(&quiet, N_("quiet mode")),
1465 OPT_BOOL('u', "include-untracked", &include_untracked,
1466 N_("include untracked files in stash")),
1467 OPT_SET_INT('a', "all", &include_untracked,
1468 N_("include ignore files"), 2),
1469 OPT_STRING('m', "message", &stash_msg, N_("message"),
1470 N_("stash message")),
1475 argc = parse_options(argc, argv, prefix, options,
1476 git_stash_push_usage,
1479 parse_pathspec(&ps, 0, PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1481 return do_push_stash(&ps, stash_msg, quiet, keep_index, patch_mode,
1485 static int save_stash(int argc, const char **argv, const char *prefix)
1487 int keep_index = -1;
1489 int include_untracked = 0;
1492 const char *stash_msg = NULL;
1494 struct strbuf stash_msg_buf = STRBUF_INIT;
1495 struct option options[] = {
1496 OPT_BOOL('k', "keep-index", &keep_index,
1498 OPT_BOOL('p', "patch", &patch_mode,
1499 N_("stash in patch mode")),
1500 OPT__QUIET(&quiet, N_("quiet mode")),
1501 OPT_BOOL('u', "include-untracked", &include_untracked,
1502 N_("include untracked files in stash")),
1503 OPT_SET_INT('a', "all", &include_untracked,
1504 N_("include ignore files"), 2),
1505 OPT_STRING('m', "message", &stash_msg, "message",
1506 N_("stash message")),
1510 argc = parse_options(argc, argv, prefix, options,
1511 git_stash_save_usage,
1512 PARSE_OPT_KEEP_DASHDASH);
1515 stash_msg = strbuf_join_argv(&stash_msg_buf, argc, argv, ' ');
1517 memset(&ps, 0, sizeof(ps));
1518 ret = do_push_stash(&ps, stash_msg, quiet, keep_index,
1519 patch_mode, include_untracked);
1521 strbuf_release(&stash_msg_buf);
1525 static int use_builtin_stash(void)
1527 struct child_process cp = CHILD_PROCESS_INIT;
1528 struct strbuf out = STRBUF_INIT;
1529 int ret, env = git_env_bool("GIT_TEST_STASH_USE_BUILTIN", -1);
1534 argv_array_pushl(&cp.args,
1535 "config", "--bool", "stash.usebuiltin", NULL);
1537 if (capture_command(&cp, &out, 6)) {
1538 strbuf_release(&out);
1543 ret = !strcmp("true", out.buf);
1544 strbuf_release(&out);
1548 int cmd_stash(int argc, const char **argv, const char *prefix)
1551 pid_t pid = getpid();
1552 const char *index_file;
1553 struct argv_array args = ARGV_ARRAY_INIT;
1555 struct option options[] = {
1559 if (!use_builtin_stash()) {
1560 const char *path = mkpath("%s/git-legacy-stash",
1563 if (sane_execvp(path, (char **)argv) < 0)
1564 die_errno(_("could not exec %s"), path);
1566 BUG("sane_execvp() returned???");
1569 prefix = setup_git_directory();
1570 trace_repo_setup(prefix);
1573 git_config(git_diff_basic_config, NULL);
1575 argc = parse_options(argc, argv, prefix, options, git_stash_usage,
1576 PARSE_OPT_KEEP_UNKNOWN | PARSE_OPT_KEEP_DASHDASH);
1578 index_file = get_index_file();
1579 strbuf_addf(&stash_index_path, "%s.stash.%" PRIuMAX, index_file,
1583 return !!push_stash(0, NULL, prefix);
1584 else if (!strcmp(argv[0], "apply"))
1585 return !!apply_stash(argc, argv, prefix);
1586 else if (!strcmp(argv[0], "clear"))
1587 return !!clear_stash(argc, argv, prefix);
1588 else if (!strcmp(argv[0], "drop"))
1589 return !!drop_stash(argc, argv, prefix);
1590 else if (!strcmp(argv[0], "pop"))
1591 return !!pop_stash(argc, argv, prefix);
1592 else if (!strcmp(argv[0], "branch"))
1593 return !!branch_stash(argc, argv, prefix);
1594 else if (!strcmp(argv[0], "list"))
1595 return !!list_stash(argc, argv, prefix);
1596 else if (!strcmp(argv[0], "show"))
1597 return !!show_stash(argc, argv, prefix);
1598 else if (!strcmp(argv[0], "store"))
1599 return !!store_stash(argc, argv, prefix);
1600 else if (!strcmp(argv[0], "create"))
1601 return !!create_stash(argc, argv, prefix);
1602 else if (!strcmp(argv[0], "push"))
1603 return !!push_stash(argc, argv, prefix);
1604 else if (!strcmp(argv[0], "save"))
1605 return !!save_stash(argc, argv, prefix);
1606 else if (*argv[0] != '-')
1607 usage_msg_opt(xstrfmt(_("unknown subcommand: %s"), argv[0]),
1608 git_stash_usage, options);
1610 if (strcmp(argv[0], "-p")) {
1611 while (++i < argc && strcmp(argv[i], "--")) {
1613 * `akpqu` is a string which contains all short options,
1614 * except `-m` which is verified separately.
1616 if ((strlen(argv[i]) == 2) && *argv[i] == '-' &&
1617 strchr("akpqu", argv[i][1]))
1620 if (!strcmp(argv[i], "--all") ||
1621 !strcmp(argv[i], "--keep-index") ||
1622 !strcmp(argv[i], "--no-keep-index") ||
1623 !strcmp(argv[i], "--patch") ||
1624 !strcmp(argv[i], "--quiet") ||
1625 !strcmp(argv[i], "--include-untracked"))
1629 * `-m` and `--message=` are verified separately because
1630 * they need to be immediately followed by a string
1631 * (i.e.`-m"foobar"` or `--message="foobar"`).
1633 if (starts_with(argv[i], "-m") ||
1634 starts_with(argv[i], "--message="))
1637 usage_with_options(git_stash_usage, options);
1641 argv_array_push(&args, "push");
1642 argv_array_pushv(&args, argv);
1643 return !!push_stash(args.argc, args.argv, prefix);