]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/stash.c
Merge branch 'js/params-vs-args'
[thirdparty/git.git] / builtin / stash.c
CommitLineData
e36adf71 1#define USE_THE_INDEX_COMPATIBILITY_MACROS
8a0fc8d1
JT
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"
dbbcd44f 10#include "strvec.h"
8a0fc8d1
JT
11#include "run-command.h"
12#include "dir.h"
13#include "rerere.h"
dc7bd382
PSU
14#include "revision.h"
15#include "log-tree.h"
d4788af8 16#include "diffcore.h"
90a46272 17#include "exec-cmd.h"
d4788af8
PSU
18
19#define INCLUDE_ALL_FILES 2
8a0fc8d1 20
40af1468
PSU
21static 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"
d553f538 29 " [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n"
8a98758a 30 " [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
d553f538 31 " [--] [<pathspec>...]]"),
40af1468 32 N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
64fe9c26 33 " [-u|--include-untracked] [-a|--all] [<message>]"),
4e2dd393
JT
34 NULL
35};
36
40af1468
PSU
37static const char * const git_stash_list_usage[] = {
38 N_("git stash list [<options>]"),
130f2697
PSU
39 NULL
40};
41
40af1468
PSU
42static const char * const git_stash_show_usage[] = {
43 N_("git stash show [<options>] [<stash>]"),
dc7bd382
PSU
44 NULL
45};
46
40af1468
PSU
47static const char * const git_stash_drop_usage[] = {
48 N_("git stash drop [-q|--quiet] [<stash>]"),
8a0fc8d1
JT
49 NULL
50};
51
40af1468
PSU
52static const char * const git_stash_pop_usage[] = {
53 N_("git stash pop [--index] [-q|--quiet] [<stash>]"),
c4de61d7
JT
54 NULL
55};
56
40af1468
PSU
57static const char * const git_stash_apply_usage[] = {
58 N_("git stash apply [--index] [-q|--quiet] [<stash>]"),
8a0fc8d1
JT
59 NULL
60};
61
40af1468
PSU
62static const char * const git_stash_branch_usage[] = {
63 N_("git stash branch <branchname> [<stash>]"),
577c1995
JT
64 NULL
65};
66
40af1468
PSU
67static const char * const git_stash_clear_usage[] = {
68 N_("git stash clear"),
4e2dd393
JT
69 NULL
70};
71
40af1468
PSU
72static const char * const git_stash_store_usage[] = {
73 N_("git stash store [-m|--message <message>] [-q|--quiet] <commit>"),
41e0dd55
PSU
74 NULL
75};
76
40af1468
PSU
77static const char * const git_stash_push_usage[] = {
78 N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
d553f538
PSU
79 " [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n"
80 " [--] [<pathspec>...]]"),
81 NULL
82};
83
40af1468
PSU
84static const char * const git_stash_save_usage[] = {
85 N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
64fe9c26
PSU
86 " [-u|--include-untracked] [-a|--all] [<message>]"),
87 NULL
88};
89
3e885f02 90static const char ref_stash[] = "refs/stash";
8a0fc8d1
JT
91static 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 */
103struct 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
117static void free_stash_info(struct stash_info *info)
118{
119 strbuf_release(&info->revision);
120}
121
122static 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
131static 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
f24c30e0 188 ret = dwim_ref(symbolic.buf, symbolic.len, &dummy, &expanded_ref, 0);
8a0fc8d1
JT
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
4e2dd393
JT
205static 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
214static 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,
40af1468 221 git_stash_clear_usage,
4e2dd393
JT
222 PARSE_OPT_STOP_AT_NON_OPTION);
223
224 if (argc)
b8657347 225 return error(_("git stash clear with arguments is "
4e2dd393
JT
226 "unimplemented"));
227
228 return do_clear_stash();
229}
230
8a0fc8d1
JT
231static 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
270static 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;
22f9b7f3
JK
280 strvec_pushl(&cp.args, "diff-tree", "--binary", NULL);
281 strvec_pushf(&cp.args, "%s^2^..%s^2", w_commit_hex, w_commit_hex);
8a0fc8d1
JT
282
283 return pipe_command(&cp, NULL, 0, out, 0, NULL, 0);
284}
285
286static 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;
22f9b7f3 296 strvec_pushl(&cp.args, "apply", "--cached", NULL);
8a0fc8d1
JT
297 return pipe_command(&cp, out->buf, out->len, NULL, 0, NULL, 0);
298}
299
300static 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;
22f9b7f3 309 strvec_push(&cp.args, "reset");
8a0fc8d1
JT
310
311 return run_command(&cp);
312}
313
d4788af8
PSU
314static 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
8a0fc8d1
JT
328static 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;
22f9b7f3
JK
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",
f6d8942b 342 stash_index_path.buf);
8a0fc8d1
JT
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;
22f9b7f3
JK
350 strvec_pushl(&cp.args, "checkout-index", "--all", NULL);
351 strvec_pushf(&cp.env_array, "GIT_INDEX_FILE=%s",
f6d8942b 352 stash_index_path.buf);
8a0fc8d1
JT
353
354 res = run_command(&cp);
355 remove_path(stash_index_path.buf);
356 return res;
357}
358
b34ab4a4
EN
359static 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.
ba359fd5
EN
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.
b34ab4a4
EN
370 */
371
ba359fd5 372 struct checkout state = CHECKOUT_INIT;
b34ab4a4
EN
373 struct diff_options diff_opts;
374 struct lock_file lock = LOCK_INIT;
375 int i;
376
ba359fd5
EN
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
b34ab4a4
EN
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 /*
ba359fd5
EN
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
b34ab4a4
EN
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 /*
ba359fd5 466 * Step 4: write the new index to disk
b34ab4a4
EN
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
8a0fc8d1
JT
474static 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);
34933d0e 486 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0))
8a0fc8d1
JT
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)
eaf53415 508 return error(_("conflicts in index. "
8a0fc8d1
JT
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();
9822175d
EN
517 discard_cache();
518 read_cache();
8a0fc8d1
JT
519 }
520 }
521
522 if (info->has_u && restore_untracked(&info->u_tree))
523 return error(_("could not restore untracked files from stash"));
524
e36adf71 525 init_merge_options(&o, the_repository);
8a0fc8d1
JT
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 {
b34ab4a4 556 unstage_changes_unless_new(&c_tree);
8a0fc8d1
JT
557 }
558
df53c808 559 if (!quiet) {
8a0fc8d1
JT
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;
22f9b7f3 569 strvec_pushf(&cp.env_array, GIT_WORK_TREE_ENVIRONMENT"=%s",
f6d8942b 570 absolute_path(get_git_work_tree()));
22f9b7f3 571 strvec_pushf(&cp.env_array, GIT_DIR_ENVIRONMENT"=%s",
f6d8942b 572 absolute_path(get_git_dir()));
22f9b7f3 573 strvec_push(&cp.args, "status");
8a0fc8d1
JT
574 run_command(&cp);
575 }
576
577 return 0;
578}
579
580static 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,
40af1468 594 git_stash_apply_usage, 0);
8a0fc8d1
JT
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
4f44c565
RS
604static 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
611static int reflog_is_empty(const char *refname)
612{
613 return !for_each_reflog_ent(refname, reject_reflog_ent, NULL);
614}
615
eabf7405 616static int do_drop_stash(struct stash_info *info, int quiet)
4e2dd393
JT
617{
618 int ret;
619 struct child_process cp_reflog = CHILD_PROCESS_INIT;
4e2dd393
JT
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;
22f9b7f3 627 strvec_pushl(&cp_reflog.args, "reflog", "delete", "--updateref",
f6d8942b 628 "--rewrite", NULL);
22f9b7f3 629 strvec_push(&cp_reflog.args, info->revision.buf);
4e2dd393
JT
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
4f44c565 640 if (reflog_is_empty(ref_stash))
4e2dd393
JT
641 do_clear_stash();
642
643 return 0;
644}
645
646static 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
655static 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,
40af1468 666 git_stash_drop_usage, 0);
4e2dd393
JT
667
668 if (get_stash_info(&info, argc, argv))
669 return -1;
670
671 assert_stash_ref(&info);
672
eabf7405 673 ret = do_drop_stash(&info, quiet);
4e2dd393
JT
674 free_stash_info(&info);
675 return ret;
676}
677
c4de61d7
JT
678static 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,
40af1468 692 git_stash_pop_usage, 0);
c4de61d7
JT
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
eabf7405 702 ret = do_drop_stash(&info, quiet);
c4de61d7
JT
703
704 free_stash_info(&info);
705 return ret;
706}
707
577c1995
JT
708static 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,
40af1468 719 git_stash_branch_usage, 0);
577c1995
JT
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;
22f9b7f3
JK
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));
577c1995
JT
735 ret = run_command(&cp);
736 if (!ret)
737 ret = do_apply_stash(prefix, &info, 1, 0);
738 if (!ret && info.is_stash_ref)
eabf7405 739 ret = do_drop_stash(&info, 0);
577c1995
JT
740
741 free_stash_info(&info);
742
743 return ret;
744}
745
130f2697
PSU
746static 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,
40af1468 754 git_stash_list_usage,
130f2697
PSU
755 PARSE_OPT_KEEP_UNKNOWN);
756
757 if (!ref_exists(ref_stash))
758 return 0;
759
760 cp.git_cmd = 1;
22f9b7f3 761 strvec_pushl(&cp.args, "log", "--format=%gd: %gs", "-g",
f6d8942b 762 "--first-parent", "-m", NULL);
22f9b7f3
JK
763 strvec_pushv(&cp.args, argv);
764 strvec_push(&cp.args, ref_stash);
765 strvec_push(&cp.args, "--");
130f2697
PSU
766 return run_command(&cp);
767}
768
dc7bd382
PSU
769static int show_stat = 1;
770static int show_patch;
8a2cd3f5 771static int use_legacy_stash;
dc7bd382
PSU
772
773static 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 }
8a2cd3f5
TG
783 if (!strcmp(var, "stash.usebuiltin")) {
784 use_legacy_stash = !git_config_bool(var, value);
785 return 0;
786 }
b0c7362d 787 return git_diff_basic_config(var, value, cb);
dc7bd382
PSU
788}
789
790static int show_stash(int argc, const char **argv, const char *prefix)
791{
792 int i;
dc7bd382
PSU
793 int ret = 0;
794 struct stash_info info;
795 struct rev_info rev;
22f9b7f3
JK
796 struct strvec stash_args = STRVEC_INIT;
797 struct strvec revision_args = STRVEC_INIT;
dc7bd382
PSU
798 struct option options[] = {
799 OPT_END()
800 };
801
802 init_diff_ui_defaults();
803 git_config(git_diff_ui_config, NULL);
804 init_revisions(&rev, prefix);
805
22f9b7f3 806 strvec_push(&revision_args, argv[0]);
dc7bd382
PSU
807 for (i = 1; i < argc; i++) {
808 if (argv[i][0] != '-')
22f9b7f3 809 strvec_push(&stash_args, argv[i]);
dc7bd382 810 else
22f9b7f3 811 strvec_push(&revision_args, argv[i]);
dc7bd382
PSU
812 }
813
d70a9eb6 814 ret = get_stash_info(&info, stash_args.nr, stash_args.v);
22f9b7f3 815 strvec_clear(&stash_args);
dc7bd382
PSU
816 if (ret)
817 return -1;
818
819 /*
820 * The config settings are applied only if there are not passed
821 * any options.
822 */
d70a9eb6 823 if (revision_args.nr == 1) {
dc7bd382
PSU
824 if (show_stat)
825 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT;
826
827 if (show_patch)
828 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
829
830 if (!show_stat && !show_patch) {
831 free_stash_info(&info);
832 return 0;
833 }
834 }
835
d70a9eb6 836 argc = setup_revisions(revision_args.nr, revision_args.v, &rev, NULL);
dc7bd382
PSU
837 if (argc > 1) {
838 free_stash_info(&info);
40af1468 839 usage_with_options(git_stash_show_usage, options);
dc7bd382 840 }
8e407bc8
TG
841 if (!rev.diffopt.output_format) {
842 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
843 diff_setup_done(&rev.diffopt);
844 }
dc7bd382
PSU
845
846 rev.diffopt.flags.recursive = 1;
847 setup_diff_pager(&rev.diffopt);
848 diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
849 log_tree_diff_flush(&rev);
850
851 free_stash_info(&info);
852 return diff_result_code(&rev.diffopt, 0);
853}
854
41e0dd55
PSU
855static int do_store_stash(const struct object_id *w_commit, const char *stash_msg,
856 int quiet)
857{
858 if (!stash_msg)
859 stash_msg = "Created via \"git stash store\".";
860
861 if (update_ref(stash_msg, ref_stash, w_commit, NULL,
862 REF_FORCE_CREATE_REFLOG,
863 quiet ? UPDATE_REFS_QUIET_ON_ERR :
864 UPDATE_REFS_MSG_ON_ERR)) {
865 if (!quiet) {
866 fprintf_ln(stderr, _("Cannot update %s with %s"),
867 ref_stash, oid_to_hex(w_commit));
868 }
869 return -1;
870 }
871
872 return 0;
873}
874
875static int store_stash(int argc, const char **argv, const char *prefix)
876{
877 int quiet = 0;
878 const char *stash_msg = NULL;
879 struct object_id obj;
880 struct object_context dummy;
881 struct option options[] = {
882 OPT__QUIET(&quiet, N_("be quiet")),
883 OPT_STRING('m', "message", &stash_msg, "message",
884 N_("stash message")),
885 OPT_END()
886 };
887
888 argc = parse_options(argc, argv, prefix, options,
40af1468 889 git_stash_store_usage,
41e0dd55
PSU
890 PARSE_OPT_KEEP_UNKNOWN);
891
892 if (argc != 1) {
893 if (!quiet)
894 fprintf_ln(stderr, _("\"git stash store\" requires one "
895 "<commit> argument"));
896 return -1;
897 }
898
e36adf71
JH
899 if (get_oid_with_context(the_repository,
900 argv[0], quiet ? GET_OID_QUIETLY : 0, &obj,
41e0dd55
PSU
901 &dummy)) {
902 if (!quiet)
903 fprintf_ln(stderr, _("Cannot update %s with %s"),
904 ref_stash, argv[0]);
905 return -1;
906 }
907
908 return do_store_stash(&obj, stash_msg, quiet);
909}
910
22f9b7f3 911static void add_pathspecs(struct strvec *args,
7db9302d 912 const struct pathspec *ps) {
d4788af8
PSU
913 int i;
914
7db9302d 915 for (i = 0; i < ps->nr; i++)
22f9b7f3 916 strvec_push(args, ps->items[i].original);
d4788af8
PSU
917}
918
919/*
920 * `untracked_files` will be filled with the names of untracked files.
921 * The return value is:
922 *
923 * = 0 if there are not any untracked files
924 * > 0 if there are untracked files
925 */
7db9302d 926static int get_untracked_files(const struct pathspec *ps, int include_untracked,
d4788af8
PSU
927 struct strbuf *untracked_files)
928{
929 int i;
d4788af8 930 int found = 0;
d4788af8
PSU
931 struct dir_struct dir;
932
eceba532 933 dir_init(&dir);
d4788af8
PSU
934 if (include_untracked != INCLUDE_ALL_FILES)
935 setup_standard_excludes(&dir);
936
95c11ecc 937 fill_directory(&dir, the_repository->index, ps);
d4788af8
PSU
938 for (i = 0; i < dir.nr; i++) {
939 struct dir_entry *ent = dir.entries[i];
95c11ecc
EN
940 found++;
941 strbuf_addstr(untracked_files, ent->name);
942 /* NUL-terminate: will be fed to update-index -z */
943 strbuf_addch(untracked_files, '\0');
d4788af8
PSU
944 }
945
eceba532 946 dir_clear(&dir);
d4788af8
PSU
947 return found;
948}
949
950/*
ef0f0b45 951 * The return value of `check_changes_tracked_files()` can be:
d4788af8
PSU
952 *
953 * < 0 if there was an error
954 * = 0 if there are no changes.
955 * > 0 if there are changes.
956 */
7db9302d 957static int check_changes_tracked_files(const struct pathspec *ps)
d4788af8
PSU
958{
959 int result;
960 struct rev_info rev;
961 struct object_id dummy;
7db9302d 962 int ret = 0;
d4788af8
PSU
963
964 /* No initial commit. */
965 if (get_oid("HEAD", &dummy))
966 return -1;
967
968 if (read_cache() < 0)
969 return -1;
970
971 init_revisions(&rev, NULL);
7db9302d 972 copy_pathspec(&rev.prune_data, ps);
d4788af8
PSU
973
974 rev.diffopt.flags.quick = 1;
975 rev.diffopt.flags.ignore_submodules = 1;
976 rev.abbrev = 0;
977
978 add_head_to_pending(&rev);
979 diff_setup_done(&rev.diffopt);
980
981 result = run_diff_index(&rev, 1);
7db9302d
TG
982 if (diff_result_code(&rev.diffopt, result)) {
983 ret = 1;
984 goto done;
985 }
d4788af8
PSU
986
987 object_array_clear(&rev.pending);
988 result = run_diff_files(&rev, 0);
7db9302d
TG
989 if (diff_result_code(&rev.diffopt, result)) {
990 ret = 1;
991 goto done;
992 }
d4788af8 993
7db9302d
TG
994done:
995 clear_pathspec(&rev.prune_data);
996 return ret;
ef0f0b45
PSU
997}
998
999/*
1000 * The function will fill `untracked_files` with the names of untracked files
1001 * It will return 1 if there were any changes and 0 if there were not.
1002 */
7db9302d 1003static int check_changes(const struct pathspec *ps, int include_untracked,
ef0f0b45
PSU
1004 struct strbuf *untracked_files)
1005{
1006 int ret = 0;
1007 if (check_changes_tracked_files(ps))
1008 ret = 1;
1009
d4788af8 1010 if (include_untracked && get_untracked_files(ps, include_untracked,
ef0f0b45
PSU
1011 untracked_files))
1012 ret = 1;
d4788af8 1013
ef0f0b45 1014 return ret;
d4788af8
PSU
1015}
1016
1017static int save_untracked_files(struct stash_info *info, struct strbuf *msg,
1018 struct strbuf files)
1019{
1020 int ret = 0;
1021 struct strbuf untracked_msg = STRBUF_INIT;
d4788af8 1022 struct child_process cp_upd_index = CHILD_PROCESS_INIT;
48ee24ab 1023 struct index_state istate = { NULL };
d4788af8
PSU
1024
1025 cp_upd_index.git_cmd = 1;
22f9b7f3 1026 strvec_pushl(&cp_upd_index.args, "update-index", "-z", "--add",
f6d8942b 1027 "--remove", "--stdin", NULL);
22f9b7f3 1028 strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
d4788af8
PSU
1029 stash_index_path.buf);
1030
1031 strbuf_addf(&untracked_msg, "untracked files on %s\n", msg->buf);
1032 if (pipe_command(&cp_upd_index, files.buf, files.len, NULL, 0,
1033 NULL, 0)) {
1034 ret = -1;
1035 goto done;
1036 }
1037
48ee24ab
PSU
1038 if (write_index_as_tree(&info->u_tree, &istate, stash_index_path.buf, 0,
1039 NULL)) {
d4788af8
PSU
1040 ret = -1;
1041 goto done;
1042 }
d4788af8
PSU
1043
1044 if (commit_tree(untracked_msg.buf, untracked_msg.len,
1045 &info->u_tree, NULL, &info->u_commit, NULL, NULL)) {
1046 ret = -1;
1047 goto done;
1048 }
1049
1050done:
48ee24ab 1051 discard_index(&istate);
d4788af8 1052 strbuf_release(&untracked_msg);
d4788af8
PSU
1053 remove_path(stash_index_path.buf);
1054 return ret;
1055}
1056
7db9302d 1057static int stash_patch(struct stash_info *info, const struct pathspec *ps,
1ac528c0 1058 struct strbuf *out_patch, int quiet)
d4788af8
PSU
1059{
1060 int ret = 0;
d4788af8 1061 struct child_process cp_read_tree = CHILD_PROCESS_INIT;
d4788af8 1062 struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
48ee24ab 1063 struct index_state istate = { NULL };
6610e462 1064 char *old_index_env = NULL, *old_repo_index_file;
d4788af8
PSU
1065
1066 remove_path(stash_index_path.buf);
1067
1068 cp_read_tree.git_cmd = 1;
22f9b7f3
JK
1069 strvec_pushl(&cp_read_tree.args, "read-tree", "HEAD", NULL);
1070 strvec_pushf(&cp_read_tree.env_array, "GIT_INDEX_FILE=%s",
f6d8942b 1071 stash_index_path.buf);
d4788af8
PSU
1072 if (run_command(&cp_read_tree)) {
1073 ret = -1;
1074 goto done;
1075 }
1076
1077 /* Find out what the user wants. */
6610e462
JS
1078 old_repo_index_file = the_repository->index_file;
1079 the_repository->index_file = stash_index_path.buf;
1080 old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
1081 setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
1082
1083 ret = run_add_interactive(NULL, "--patch=stash", ps);
1084
1085 the_repository->index_file = old_repo_index_file;
1086 if (old_index_env && *old_index_env)
1087 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
1088 else
1089 unsetenv(INDEX_ENVIRONMENT);
1090 FREE_AND_NULL(old_index_env);
d4788af8
PSU
1091
1092 /* State of the working tree. */
48ee24ab
PSU
1093 if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1094 NULL)) {
d4788af8
PSU
1095 ret = -1;
1096 goto done;
1097 }
1098
d4788af8 1099 cp_diff_tree.git_cmd = 1;
22f9b7f3 1100 strvec_pushl(&cp_diff_tree.args, "diff-tree", "-p", "-U1", "HEAD",
f6d8942b 1101 oid_to_hex(&info->w_tree), "--", NULL);
d4788af8
PSU
1102 if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1103 ret = -1;
1104 goto done;
1105 }
1106
1107 if (!out_patch->len) {
1ac528c0
PSU
1108 if (!quiet)
1109 fprintf_ln(stderr, _("No changes selected"));
d4788af8
PSU
1110 ret = 1;
1111 }
1112
1113done:
48ee24ab 1114 discard_index(&istate);
d4788af8
PSU
1115 remove_path(stash_index_path.buf);
1116 return ret;
1117}
1118
7db9302d 1119static int stash_working_tree(struct stash_info *info, const struct pathspec *ps)
d4788af8
PSU
1120{
1121 int ret = 0;
1122 struct rev_info rev;
1123 struct child_process cp_upd_index = CHILD_PROCESS_INIT;
d4788af8 1124 struct strbuf diff_output = STRBUF_INIT;
48ee24ab 1125 struct index_state istate = { NULL };
d4788af8
PSU
1126
1127 init_revisions(&rev, NULL);
7db9302d 1128 copy_pathspec(&rev.prune_data, ps);
d4788af8
PSU
1129
1130 set_alternate_index_output(stash_index_path.buf);
1131 if (reset_tree(&info->i_tree, 0, 0)) {
1132 ret = -1;
1133 goto done;
1134 }
1135 set_alternate_index_output(NULL);
1136
d4788af8
PSU
1137 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1138 rev.diffopt.format_callback = add_diff_to_buf;
1139 rev.diffopt.format_callback_data = &diff_output;
1140
1141 if (read_cache_preload(&rev.diffopt.pathspec) < 0) {
1142 ret = -1;
1143 goto done;
1144 }
1145
1146 add_pending_object(&rev, parse_object(the_repository, &info->b_commit),
1147 "");
1148 if (run_diff_index(&rev, 0)) {
1149 ret = -1;
1150 goto done;
1151 }
1152
1153 cp_upd_index.git_cmd = 1;
22f9b7f3 1154 strvec_pushl(&cp_upd_index.args, "update-index",
f6d8942b
JK
1155 "--ignore-skip-worktree-entries",
1156 "-z", "--add", "--remove", "--stdin", NULL);
22f9b7f3 1157 strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
f6d8942b 1158 stash_index_path.buf);
d4788af8
PSU
1159
1160 if (pipe_command(&cp_upd_index, diff_output.buf, diff_output.len,
1161 NULL, 0, NULL, 0)) {
1162 ret = -1;
1163 goto done;
1164 }
1165
48ee24ab
PSU
1166 if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1167 NULL)) {
d4788af8
PSU
1168 ret = -1;
1169 goto done;
1170 }
1171
d4788af8 1172done:
48ee24ab 1173 discard_index(&istate);
d4788af8 1174 UNLEAK(rev);
d4788af8 1175 object_array_clear(&rev.pending);
7db9302d 1176 clear_pathspec(&rev.prune_data);
d4788af8
PSU
1177 strbuf_release(&diff_output);
1178 remove_path(stash_index_path.buf);
1179 return ret;
1180}
1181
7db9302d 1182static int do_create_stash(const struct pathspec *ps, struct strbuf *stash_msg_buf,
d4788af8 1183 int include_untracked, int patch_mode,
1ac528c0
PSU
1184 struct stash_info *info, struct strbuf *patch,
1185 int quiet)
d4788af8
PSU
1186{
1187 int ret = 0;
1188 int flags = 0;
1189 int untracked_commit_option = 0;
1190 const char *head_short_sha1 = NULL;
1191 const char *branch_ref = NULL;
1192 const char *branch_name = "(no branch)";
1193 struct commit *head_commit = NULL;
1194 struct commit_list *parents = NULL;
1195 struct strbuf msg = STRBUF_INIT;
1196 struct strbuf commit_tree_label = STRBUF_INIT;
1197 struct strbuf untracked_files = STRBUF_INIT;
d4788af8
PSU
1198
1199 prepare_fallback_ident("git stash", "git@stash");
1200
1201 read_cache_preload(NULL);
34933d0e
TG
1202 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0) {
1203 ret = -1;
1204 goto done;
1205 }
d4788af8
PSU
1206
1207 if (get_oid("HEAD", &info->b_commit)) {
1ac528c0
PSU
1208 if (!quiet)
1209 fprintf_ln(stderr, _("You do not have "
1210 "the initial commit yet"));
d4788af8
PSU
1211 ret = -1;
1212 goto done;
1213 } else {
1214 head_commit = lookup_commit(the_repository, &info->b_commit);
1215 }
1216
ef0f0b45 1217 if (!check_changes(ps, include_untracked, &untracked_files)) {
d4788af8
PSU
1218 ret = 1;
1219 goto done;
1220 }
1221
1222 branch_ref = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
1223 if (flags & REF_ISSYMREF)
1224 branch_name = strrchr(branch_ref, '/') + 1;
1225 head_short_sha1 = find_unique_abbrev(&head_commit->object.oid,
1226 DEFAULT_ABBREV);
1227 strbuf_addf(&msg, "%s: %s ", branch_name, head_short_sha1);
1228 pp_commit_easy(CMIT_FMT_ONELINE, head_commit, &msg);
1229
1230 strbuf_addf(&commit_tree_label, "index on %s\n", msg.buf);
1231 commit_list_insert(head_commit, &parents);
1232 if (write_cache_as_tree(&info->i_tree, 0, NULL) ||
1233 commit_tree(commit_tree_label.buf, commit_tree_label.len,
1234 &info->i_tree, parents, &info->i_commit, NULL, NULL)) {
1ac528c0
PSU
1235 if (!quiet)
1236 fprintf_ln(stderr, _("Cannot save the current "
1237 "index state"));
d4788af8
PSU
1238 ret = -1;
1239 goto done;
1240 }
1241
ef0f0b45 1242 if (include_untracked) {
d4788af8 1243 if (save_untracked_files(info, &msg, untracked_files)) {
1ac528c0
PSU
1244 if (!quiet)
1245 fprintf_ln(stderr, _("Cannot save "
1246 "the untracked files"));
d4788af8
PSU
1247 ret = -1;
1248 goto done;
1249 }
1250 untracked_commit_option = 1;
1251 }
1252 if (patch_mode) {
1ac528c0 1253 ret = stash_patch(info, ps, patch, quiet);
d4788af8 1254 if (ret < 0) {
1ac528c0
PSU
1255 if (!quiet)
1256 fprintf_ln(stderr, _("Cannot save the current "
1257 "worktree state"));
d4788af8
PSU
1258 goto done;
1259 } else if (ret > 0) {
1260 goto done;
1261 }
1262 } else {
1263 if (stash_working_tree(info, ps)) {
1ac528c0
PSU
1264 if (!quiet)
1265 fprintf_ln(stderr, _("Cannot save the current "
1266 "worktree state"));
d4788af8
PSU
1267 ret = -1;
1268 goto done;
1269 }
1270 }
1271
1272 if (!stash_msg_buf->len)
1273 strbuf_addf(stash_msg_buf, "WIP on %s", msg.buf);
1274 else
1275 strbuf_insertf(stash_msg_buf, 0, "On %s: ", branch_name);
1276
1277 /*
1278 * `parents` will be empty after calling `commit_tree()`, so there is
1279 * no need to call `free_commit_list()`
1280 */
1281 parents = NULL;
1282 if (untracked_commit_option)
1283 commit_list_insert(lookup_commit(the_repository,
1284 &info->u_commit),
1285 &parents);
1286 commit_list_insert(lookup_commit(the_repository, &info->i_commit),
1287 &parents);
1288 commit_list_insert(head_commit, &parents);
1289
1290 if (commit_tree(stash_msg_buf->buf, stash_msg_buf->len, &info->w_tree,
1291 parents, &info->w_commit, NULL, NULL)) {
1ac528c0
PSU
1292 if (!quiet)
1293 fprintf_ln(stderr, _("Cannot record "
1294 "working tree state"));
d4788af8
PSU
1295 ret = -1;
1296 goto done;
1297 }
1298
1299done:
1300 strbuf_release(&commit_tree_label);
1301 strbuf_release(&msg);
1302 strbuf_release(&untracked_files);
1303 return ret;
1304}
1305
1306static int create_stash(int argc, const char **argv, const char *prefix)
1307{
d4788af8 1308 int ret = 0;
d4788af8
PSU
1309 struct strbuf stash_msg_buf = STRBUF_INIT;
1310 struct stash_info info;
1311 struct pathspec ps;
d4788af8 1312
40af1468
PSU
1313 /* Starting with argv[1], since argv[0] is "create" */
1314 strbuf_join_argv(&stash_msg_buf, argc - 1, ++argv, ' ');
d4788af8
PSU
1315
1316 memset(&ps, 0, sizeof(ps));
7db9302d 1317 if (!check_changes_tracked_files(&ps))
ef0f0b45
PSU
1318 return 0;
1319
7db9302d 1320 ret = do_create_stash(&ps, &stash_msg_buf, 0, 0, &info,
1ac528c0 1321 NULL, 0);
d4788af8
PSU
1322 if (!ret)
1323 printf_ln("%s", oid_to_hex(&info.w_commit));
1324
1325 strbuf_release(&stash_msg_buf);
ef0f0b45 1326 return ret;
d4788af8
PSU
1327}
1328
7db9302d 1329static int do_push_stash(const struct pathspec *ps, const char *stash_msg, int quiet,
d553f538
PSU
1330 int keep_index, int patch_mode, int include_untracked)
1331{
1332 int ret = 0;
1333 struct stash_info info;
1334 struct strbuf patch = STRBUF_INIT;
1335 struct strbuf stash_msg_buf = STRBUF_INIT;
ef0f0b45 1336 struct strbuf untracked_files = STRBUF_INIT;
d553f538
PSU
1337
1338 if (patch_mode && keep_index == -1)
1339 keep_index = 1;
1340
1341 if (patch_mode && include_untracked) {
1342 fprintf_ln(stderr, _("Can't use --patch and --include-untracked"
1343 " or --all at the same time"));
1344 ret = -1;
1345 goto done;
1346 }
1347
1348 read_cache_preload(NULL);
7db9302d 1349 if (!include_untracked && ps->nr) {
d553f538 1350 int i;
7db9302d 1351 char *ps_matched = xcalloc(ps->nr, 1);
d553f538
PSU
1352
1353 for (i = 0; i < active_nr; i++)
7db9302d 1354 ce_path_match(&the_index, active_cache[i], ps,
d553f538
PSU
1355 ps_matched);
1356
42844973 1357 if (report_path_error(ps_matched, ps)) {
d553f538
PSU
1358 fprintf_ln(stderr, _("Did you forget to 'git add'?"));
1359 ret = -1;
1360 free(ps_matched);
1361 goto done;
1362 }
1363 free(ps_matched);
1364 }
1365
34933d0e 1366 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0)) {
d553f538
PSU
1367 ret = -1;
1368 goto done;
1369 }
1370
ef0f0b45 1371 if (!check_changes(ps, include_untracked, &untracked_files)) {
d553f538
PSU
1372 if (!quiet)
1373 printf_ln(_("No local changes to save"));
1374 goto done;
1375 }
1376
1377 if (!reflog_exists(ref_stash) && do_clear_stash()) {
1378 ret = -1;
1ac528c0
PSU
1379 if (!quiet)
1380 fprintf_ln(stderr, _("Cannot initialize stash"));
d553f538
PSU
1381 goto done;
1382 }
1383
1384 if (stash_msg)
1385 strbuf_addstr(&stash_msg_buf, stash_msg);
1386 if (do_create_stash(ps, &stash_msg_buf, include_untracked, patch_mode,
1ac528c0 1387 &info, &patch, quiet)) {
d553f538
PSU
1388 ret = -1;
1389 goto done;
1390 }
1391
1392 if (do_store_stash(&info.w_commit, stash_msg_buf.buf, 1)) {
1393 ret = -1;
1ac528c0
PSU
1394 if (!quiet)
1395 fprintf_ln(stderr, _("Cannot save the current status"));
d553f538
PSU
1396 goto done;
1397 }
1398
1ac528c0
PSU
1399 if (!quiet)
1400 printf_ln(_("Saved working directory and index state %s"),
1401 stash_msg_buf.buf);
d553f538
PSU
1402
1403 if (!patch_mode) {
7db9302d 1404 if (include_untracked && !ps->nr) {
d553f538
PSU
1405 struct child_process cp = CHILD_PROCESS_INIT;
1406
1407 cp.git_cmd = 1;
22f9b7f3 1408 strvec_pushl(&cp.args, "clean", "--force",
f6d8942b 1409 "--quiet", "-d", NULL);
d553f538 1410 if (include_untracked == INCLUDE_ALL_FILES)
22f9b7f3 1411 strvec_push(&cp.args, "-x");
d553f538
PSU
1412 if (run_command(&cp)) {
1413 ret = -1;
1414 goto done;
1415 }
1416 }
1417 discard_cache();
7db9302d 1418 if (ps->nr) {
d553f538
PSU
1419 struct child_process cp_add = CHILD_PROCESS_INIT;
1420 struct child_process cp_diff = CHILD_PROCESS_INIT;
1421 struct child_process cp_apply = CHILD_PROCESS_INIT;
1422 struct strbuf out = STRBUF_INIT;
1423
1424 cp_add.git_cmd = 1;
22f9b7f3 1425 strvec_push(&cp_add.args, "add");
d553f538 1426 if (!include_untracked)
22f9b7f3 1427 strvec_push(&cp_add.args, "-u");
d553f538 1428 if (include_untracked == INCLUDE_ALL_FILES)
22f9b7f3
JK
1429 strvec_push(&cp_add.args, "--force");
1430 strvec_push(&cp_add.args, "--");
d553f538
PSU
1431 add_pathspecs(&cp_add.args, ps);
1432 if (run_command(&cp_add)) {
1433 ret = -1;
1434 goto done;
1435 }
1436
1437 cp_diff.git_cmd = 1;
22f9b7f3 1438 strvec_pushl(&cp_diff.args, "diff-index", "-p",
f6d8942b
JK
1439 "--cached", "--binary", "HEAD", "--",
1440 NULL);
d553f538
PSU
1441 add_pathspecs(&cp_diff.args, ps);
1442 if (pipe_command(&cp_diff, NULL, 0, &out, 0, NULL, 0)) {
1443 ret = -1;
1444 goto done;
1445 }
1446
1447 cp_apply.git_cmd = 1;
22f9b7f3 1448 strvec_pushl(&cp_apply.args, "apply", "--index",
f6d8942b 1449 "-R", NULL);
d553f538
PSU
1450 if (pipe_command(&cp_apply, out.buf, out.len, NULL, 0,
1451 NULL, 0)) {
1452 ret = -1;
1453 goto done;
1454 }
1455 } else {
1456 struct child_process cp = CHILD_PROCESS_INIT;
1457 cp.git_cmd = 1;
22f9b7f3 1458 strvec_pushl(&cp.args, "reset", "--hard", "-q",
f6d8942b 1459 "--no-recurse-submodules", NULL);
d553f538
PSU
1460 if (run_command(&cp)) {
1461 ret = -1;
1462 goto done;
1463 }
1464 }
1465
1466 if (keep_index == 1 && !is_null_oid(&info.i_tree)) {
b932f6a5 1467 struct child_process cp = CHILD_PROCESS_INIT;
d553f538 1468
b932f6a5 1469 cp.git_cmd = 1;
22f9b7f3 1470 strvec_pushl(&cp.args, "checkout", "--no-overlay",
f6d8942b 1471 oid_to_hex(&info.i_tree), "--", NULL);
b932f6a5 1472 if (!ps->nr)
22f9b7f3 1473 strvec_push(&cp.args, ":/");
b932f6a5
TG
1474 else
1475 add_pathspecs(&cp.args, ps);
1476 if (run_command(&cp)) {
d553f538
PSU
1477 ret = -1;
1478 goto done;
1479 }
1480 }
1481 goto done;
1482 } else {
1483 struct child_process cp = CHILD_PROCESS_INIT;
1484
1485 cp.git_cmd = 1;
22f9b7f3 1486 strvec_pushl(&cp.args, "apply", "-R", NULL);
d553f538
PSU
1487
1488 if (pipe_command(&cp, patch.buf, patch.len, NULL, 0, NULL, 0)) {
1ac528c0
PSU
1489 if (!quiet)
1490 fprintf_ln(stderr, _("Cannot remove "
1491 "worktree changes"));
d553f538
PSU
1492 ret = -1;
1493 goto done;
1494 }
1495
1496 if (keep_index < 1) {
1497 struct child_process cp = CHILD_PROCESS_INIT;
1498
1499 cp.git_cmd = 1;
22f9b7f3 1500 strvec_pushl(&cp.args, "reset", "-q", "--", NULL);
d553f538
PSU
1501 add_pathspecs(&cp.args, ps);
1502 if (run_command(&cp)) {
1503 ret = -1;
1504 goto done;
1505 }
1506 }
1507 goto done;
1508 }
1509
1510done:
1511 strbuf_release(&stash_msg_buf);
1512 return ret;
1513}
1514
8c3713ce
AM
1515static int push_stash(int argc, const char **argv, const char *prefix,
1516 int push_assumed)
d553f538 1517{
8c3713ce 1518 int force_assume = 0;
d553f538
PSU
1519 int keep_index = -1;
1520 int patch_mode = 0;
1521 int include_untracked = 0;
1522 int quiet = 0;
8a98758a 1523 int pathspec_file_nul = 0;
d553f538 1524 const char *stash_msg = NULL;
8a98758a 1525 const char *pathspec_from_file = NULL;
d553f538
PSU
1526 struct pathspec ps;
1527 struct option options[] = {
1528 OPT_BOOL('k', "keep-index", &keep_index,
1529 N_("keep index")),
1530 OPT_BOOL('p', "patch", &patch_mode,
1531 N_("stash in patch mode")),
1532 OPT__QUIET(&quiet, N_("quiet mode")),
1533 OPT_BOOL('u', "include-untracked", &include_untracked,
1534 N_("include untracked files in stash")),
1535 OPT_SET_INT('a', "all", &include_untracked,
1536 N_("include ignore files"), 2),
1537 OPT_STRING('m', "message", &stash_msg, N_("message"),
1538 N_("stash message")),
8a98758a
AM
1539 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1540 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
d553f538
PSU
1541 OPT_END()
1542 };
1543
8c3713ce
AM
1544 if (argc) {
1545 force_assume = !strcmp(argv[0], "-p");
40af1468
PSU
1546 argc = parse_options(argc, argv, prefix, options,
1547 git_stash_push_usage,
8c3713ce
AM
1548 PARSE_OPT_KEEP_DASHDASH);
1549 }
1550
1551 if (argc) {
1552 if (!strcmp(argv[0], "--")) {
1553 argc--;
1554 argv++;
1555 } else if (push_assumed && !force_assume) {
1556 die("subcommand wasn't specified; 'push' can't be assumed due to unexpected token '%s'",
1557 argv[0]);
1558 }
1559 }
d553f538 1560
1366c78c
JS
1561 parse_pathspec(&ps, 0, PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1562 prefix, argv);
8a98758a
AM
1563
1564 if (pathspec_from_file) {
1565 if (patch_mode)
1566 die(_("--pathspec-from-file is incompatible with --patch"));
1567
1568 if (ps.nr)
1569 die(_("--pathspec-from-file is incompatible with pathspec arguments"));
1570
1571 parse_pathspec_file(&ps, 0,
1572 PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1573 prefix, pathspec_from_file, pathspec_file_nul);
1574 } else if (pathspec_file_nul) {
1575 die(_("--pathspec-file-nul requires --pathspec-from-file"));
1576 }
1577
7db9302d 1578 return do_push_stash(&ps, stash_msg, quiet, keep_index, patch_mode,
d553f538
PSU
1579 include_untracked);
1580}
1581
64fe9c26
PSU
1582static int save_stash(int argc, const char **argv, const char *prefix)
1583{
1584 int keep_index = -1;
1585 int patch_mode = 0;
1586 int include_untracked = 0;
1587 int quiet = 0;
1588 int ret = 0;
1589 const char *stash_msg = NULL;
1590 struct pathspec ps;
1591 struct strbuf stash_msg_buf = STRBUF_INIT;
1592 struct option options[] = {
1593 OPT_BOOL('k', "keep-index", &keep_index,
1594 N_("keep index")),
1595 OPT_BOOL('p', "patch", &patch_mode,
1596 N_("stash in patch mode")),
1597 OPT__QUIET(&quiet, N_("quiet mode")),
1598 OPT_BOOL('u', "include-untracked", &include_untracked,
1599 N_("include untracked files in stash")),
1600 OPT_SET_INT('a', "all", &include_untracked,
1601 N_("include ignore files"), 2),
1602 OPT_STRING('m', "message", &stash_msg, "message",
1603 N_("stash message")),
1604 OPT_END()
1605 };
1606
1607 argc = parse_options(argc, argv, prefix, options,
40af1468 1608 git_stash_save_usage,
64fe9c26
PSU
1609 PARSE_OPT_KEEP_DASHDASH);
1610
1611 if (argc)
1612 stash_msg = strbuf_join_argv(&stash_msg_buf, argc, argv, ' ');
1613
1614 memset(&ps, 0, sizeof(ps));
7db9302d 1615 ret = do_push_stash(&ps, stash_msg, quiet, keep_index,
64fe9c26
PSU
1616 patch_mode, include_untracked);
1617
1618 strbuf_release(&stash_msg_buf);
1619 return ret;
1620}
1621
40af1468 1622int cmd_stash(int argc, const char **argv, const char *prefix)
8a0fc8d1
JT
1623{
1624 pid_t pid = getpid();
1625 const char *index_file;
22f9b7f3 1626 struct strvec args = STRVEC_INIT;
8a0fc8d1
JT
1627
1628 struct option options[] = {
1629 OPT_END()
1630 };
1631
b0c7362d 1632 git_config(git_stash_config, NULL);
90a46272 1633
8a2cd3f5
TG
1634 if (use_legacy_stash ||
1635 !git_env_bool("GIT_TEST_STASH_USE_BUILTIN", -1))
1636 warning(_("the stash.useBuiltin support has been removed!\n"
1637 "See its entry in 'git help config' for details."));
8a0fc8d1 1638
40af1468 1639 argc = parse_options(argc, argv, prefix, options, git_stash_usage,
8a0fc8d1
JT
1640 PARSE_OPT_KEEP_UNKNOWN | PARSE_OPT_KEEP_DASHDASH);
1641
1642 index_file = get_index_file();
1643 strbuf_addf(&stash_index_path, "%s.stash.%" PRIuMAX, index_file,
1644 (uintmax_t)pid);
1645
40af1468 1646 if (!argc)
8c3713ce 1647 return !!push_stash(0, NULL, prefix, 0);
40af1468 1648 else if (!strcmp(argv[0], "apply"))
8a0fc8d1 1649 return !!apply_stash(argc, argv, prefix);
4e2dd393
JT
1650 else if (!strcmp(argv[0], "clear"))
1651 return !!clear_stash(argc, argv, prefix);
1652 else if (!strcmp(argv[0], "drop"))
1653 return !!drop_stash(argc, argv, prefix);
c4de61d7
JT
1654 else if (!strcmp(argv[0], "pop"))
1655 return !!pop_stash(argc, argv, prefix);
577c1995
JT
1656 else if (!strcmp(argv[0], "branch"))
1657 return !!branch_stash(argc, argv, prefix);
130f2697
PSU
1658 else if (!strcmp(argv[0], "list"))
1659 return !!list_stash(argc, argv, prefix);
dc7bd382
PSU
1660 else if (!strcmp(argv[0], "show"))
1661 return !!show_stash(argc, argv, prefix);
41e0dd55
PSU
1662 else if (!strcmp(argv[0], "store"))
1663 return !!store_stash(argc, argv, prefix);
d4788af8
PSU
1664 else if (!strcmp(argv[0], "create"))
1665 return !!create_stash(argc, argv, prefix);
d553f538 1666 else if (!strcmp(argv[0], "push"))
8c3713ce 1667 return !!push_stash(argc, argv, prefix, 0);
64fe9c26
PSU
1668 else if (!strcmp(argv[0], "save"))
1669 return !!save_stash(argc, argv, prefix);
40af1468
PSU
1670 else if (*argv[0] != '-')
1671 usage_msg_opt(xstrfmt(_("unknown subcommand: %s"), argv[0]),
1672 git_stash_usage, options);
1673
8c3713ce 1674 /* Assume 'stash push' */
22f9b7f3
JK
1675 strvec_push(&args, "push");
1676 strvec_pushv(&args, argv);
d70a9eb6 1677 return !!push_stash(args.nr, args.v, prefix, 1);
8a0fc8d1 1678}