1/*
2 * "git rebase" builtin command
3 *
4 * Copyright (c) 2018 Pratik Karki
5 */
6
7#define USE_THE_INDEX_COMPATIBILITY_MACROS
8#include "builtin.h"
9#include "run-command.h"
10#include "exec-cmd.h"
11#include "argv-array.h"
12#include "dir.h"
13#include "packfile.h"
14#include "refs.h"
15#include "quote.h"
16#include "config.h"
17#include "cache-tree.h"
18#include "unpack-trees.h"
19#include "lockfile.h"
20#include "parse-options.h"
21#include "commit.h"
22#include "diff.h"
23#include "wt-status.h"
24#include "revision.h"
25#include "commit-reach.h"
26#include "rerere.h"
27#include "branch.h"
28
29static char const * const builtin_rebase_usage[] = {
30 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
31 "[<upstream>] [<branch>]"),
32 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
33 "--root [<branch>]"),
34 N_("git rebase --continue | --abort | --skip | --edit-todo"),
35 NULL
36};
37
38static GIT_PATH_FUNC(apply_dir, "rebase-apply")
39static GIT_PATH_FUNC(merge_dir, "rebase-merge")
40
41enum rebase_type {
42 REBASE_UNSPECIFIED = -1,
43 REBASE_AM,
44 REBASE_MERGE,
45 REBASE_INTERACTIVE,
46 REBASE_PRESERVE_MERGES
47};
48
49static int use_builtin_rebase(void)
50{
51 struct child_process cp = CHILD_PROCESS_INIT;
52 struct strbuf out = STRBUF_INIT;
53 int ret, env = git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1);
54
55 if (env != -1)
56 return env;
57
58 argv_array_pushl(&cp.args,
59 "config", "--bool", "rebase.usebuiltin", NULL);
60 cp.git_cmd = 1;
61 if (capture_command(&cp, &out, 6)) {
62 strbuf_release(&out);
63 return 1;
64 }
65
66 strbuf_trim(&out);
67 ret = !strcmp("true", out.buf);
68 strbuf_release(&out);
69 return ret;
70}
71
72struct rebase_options {
73 enum rebase_type type;
74 const char *state_dir;
75 struct commit *upstream;
76 const char *upstream_name;
77 const char *upstream_arg;
78 char *head_name;
79 struct object_id orig_head;
80 struct commit *onto;
81 const char *onto_name;
82 const char *revisions;
83 const char *switch_to;
84 int root;
85 struct object_id *squash_onto;
86 struct commit *restrict_revision;
87 int dont_finish_rebase;
88 enum {
89 REBASE_NO_QUIET = 1<<0,
90 REBASE_VERBOSE = 1<<1,
91 REBASE_DIFFSTAT = 1<<2,
92 REBASE_FORCE = 1<<3,
93 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
94 } flags;
95 struct argv_array git_am_opts;
96 const char *action;
97 int signoff;
98 int allow_rerere_autoupdate;
99 int keep_empty;
100 int autosquash;
101 char *gpg_sign_opt;
102 int autostash;
103 char *cmd;
104 int allow_empty_message;
105 int rebase_merges, rebase_cousins;
106 char *strategy, *strategy_opts;
107 struct strbuf git_format_patch_opt;
108 int reschedule_failed_exec;
109};
110
111static int is_interactive(struct rebase_options *opts)
112{
113 return opts->type == REBASE_INTERACTIVE ||
114 opts->type == REBASE_PRESERVE_MERGES;
115}
116
117static void imply_interactive(struct rebase_options *opts, const char *option)
118{
119 switch (opts->type) {
120 case REBASE_AM:
121 die(_("%s requires an interactive rebase"), option);
122 break;
123 case REBASE_INTERACTIVE:
124 case REBASE_PRESERVE_MERGES:
125 break;
126 case REBASE_MERGE:
127 /* we now implement --merge via --interactive */
128 default:
129 opts->type = REBASE_INTERACTIVE; /* implied */
130 break;
131 }
132}
133
134/* Returns the filename prefixed by the state_dir */
135static const char *state_dir_path(const char *filename, struct rebase_options *opts)
136{
137 static struct strbuf path = STRBUF_INIT;
138 static size_t prefix_len;
139
140 if (!prefix_len) {
141 strbuf_addf(&path, "%s/", opts->state_dir);
142 prefix_len = path.len;
143 }
144
145 strbuf_setlen(&path, prefix_len);
146 strbuf_addstr(&path, filename);
147 return path.buf;
148}
149
150/* Read one file, then strip line endings */
151static int read_one(const char *path, struct strbuf *buf)
152{
153 if (strbuf_read_file(buf, path, 0) < 0)
154 return error_errno(_("could not read '%s'"), path);
155 strbuf_trim_trailing_newline(buf);
156 return 0;
157}
158
159/* Initialize the rebase options from the state directory. */
160static int read_basic_state(struct rebase_options *opts)
161{
162 struct strbuf head_name = STRBUF_INIT;
163 struct strbuf buf = STRBUF_INIT;
164 struct object_id oid;
165
166 if (read_one(state_dir_path("head-name", opts), &head_name) ||
167 read_one(state_dir_path("onto", opts), &buf))
168 return -1;
169 opts->head_name = starts_with(head_name.buf, "refs/") ?
170 xstrdup(head_name.buf) : NULL;
171 strbuf_release(&head_name);
172 if (get_oid(buf.buf, &oid))
173 return error(_("could not get 'onto': '%s'"), buf.buf);
174 opts->onto = lookup_commit_or_die(&oid, buf.buf);
175
176 /*
177 * We always write to orig-head, but interactive rebase used to write to
178 * head. Fall back to reading from head to cover for the case that the
179 * user upgraded git with an ongoing interactive rebase.
180 */
181 strbuf_reset(&buf);
182 if (file_exists(state_dir_path("orig-head", opts))) {
183 if (read_one(state_dir_path("orig-head", opts), &buf))
184 return -1;
185 } else if (read_one(state_dir_path("head", opts), &buf))
186 return -1;
187 if (get_oid(buf.buf, &opts->orig_head))
188 return error(_("invalid orig-head: '%s'"), buf.buf);
189
190 if (file_exists(state_dir_path("quiet", opts)))
191 opts->flags &= ~REBASE_NO_QUIET;
192 else
193 opts->flags |= REBASE_NO_QUIET;
194
195 if (file_exists(state_dir_path("verbose", opts)))
196 opts->flags |= REBASE_VERBOSE;
197
198 if (file_exists(state_dir_path("signoff", opts))) {
199 opts->signoff = 1;
200 opts->flags |= REBASE_FORCE;
201 }
202
203 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
204 strbuf_reset(&buf);
205 if (read_one(state_dir_path("allow_rerere_autoupdate", opts),
206 &buf))
207 return -1;
208 if (!strcmp(buf.buf, "--rerere-autoupdate"))
209 opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
210 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
211 opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
212 else
213 warning(_("ignoring invalid allow_rerere_autoupdate: "
214 "'%s'"), buf.buf);
215 }
216
217 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
218 strbuf_reset(&buf);
219 if (read_one(state_dir_path("gpg_sign_opt", opts),
220 &buf))
221 return -1;
222 free(opts->gpg_sign_opt);
223 opts->gpg_sign_opt = xstrdup(buf.buf);
224 }
225
226 if (file_exists(state_dir_path("strategy", opts))) {
227 strbuf_reset(&buf);
228 if (read_one(state_dir_path("strategy", opts), &buf))
229 return -1;
230 free(opts->strategy);
231 opts->strategy = xstrdup(buf.buf);
232 }
233
234 if (file_exists(state_dir_path("strategy_opts", opts))) {
235 strbuf_reset(&buf);
236 if (read_one(state_dir_path("strategy_opts", opts), &buf))
237 return -1;
238 free(opts->strategy_opts);
239 opts->strategy_opts = xstrdup(buf.buf);
240 }
241
242 strbuf_release(&buf);
243
244 return 0;
245}
246
247static int rebase_write_basic_state(struct rebase_options *opts)
248{
249 write_file(state_dir_path("head-name", opts), "%s",
250 opts->head_name ? opts->head_name : "detached HEAD");
251 write_file(state_dir_path("onto", opts), "%s",
252 opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
253 write_file(state_dir_path("orig-head", opts), "%s",
254 oid_to_hex(&opts->orig_head));
255 write_file(state_dir_path("quiet", opts), "%s",
256 opts->flags & REBASE_NO_QUIET ? "" : "t");
257 if (opts->flags & REBASE_VERBOSE)
258 write_file(state_dir_path("verbose", opts), "%s", "");
259 if (opts->strategy)
260 write_file(state_dir_path("strategy", opts), "%s",
261 opts->strategy);
262 if (opts->strategy_opts)
263 write_file(state_dir_path("strategy_opts", opts), "%s",
264 opts->strategy_opts);
265 if (opts->allow_rerere_autoupdate > 0)
266 write_file(state_dir_path("allow_rerere_autoupdate", opts),
267 "-%s-rerere-autoupdate",
268 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
269 "" : "-no");
270 if (opts->gpg_sign_opt)
271 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
272 opts->gpg_sign_opt);
273 if (opts->signoff)
274 write_file(state_dir_path("strategy", opts), "--signoff");
275
276 return 0;
277}
278
279static int apply_autostash(struct rebase_options *opts)
280{
281 const char *path = state_dir_path("autostash", opts);
282 struct strbuf autostash = STRBUF_INIT;
283 struct child_process stash_apply = CHILD_PROCESS_INIT;
284
285 if (!file_exists(path))
286 return 0;
287
288 if (read_one(path, &autostash))
289 return error(_("Could not read '%s'"), path);
290 /* Ensure that the hash is not mistaken for a number */
291 strbuf_addstr(&autostash, "^0");
292 argv_array_pushl(&stash_apply.args,
293 "stash", "apply", autostash.buf, NULL);
294 stash_apply.git_cmd = 1;
295 stash_apply.no_stderr = stash_apply.no_stdout =
296 stash_apply.no_stdin = 1;
297 if (!run_command(&stash_apply))
298 printf(_("Applied autostash.\n"));
299 else {
300 struct argv_array args = ARGV_ARRAY_INIT;
301 int res = 0;
302
303 argv_array_pushl(&args,
304 "stash", "store", "-m", "autostash", "-q",
305 autostash.buf, NULL);
306 if (run_command_v_opt(args.argv, RUN_GIT_CMD))
307 res = error(_("Cannot store %s"), autostash.buf);
308 argv_array_clear(&args);
309 strbuf_release(&autostash);
310 if (res)
311 return res;
312
313 fprintf(stderr,
314 _("Applying autostash resulted in conflicts.\n"
315 "Your changes are safe in the stash.\n"
316 "You can run \"git stash pop\" or \"git stash drop\" "
317 "at any time.\n"));
318 }
319
320 strbuf_release(&autostash);
321 return 0;
322}
323
324static int finish_rebase(struct rebase_options *opts)
325{
326 struct strbuf dir = STRBUF_INIT;
327 const char *argv_gc_auto[] = { "gc", "--auto", NULL };
328
329 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
330 apply_autostash(opts);
331 close_all_packs(the_repository->objects);
332 /*
333 * We ignore errors in 'gc --auto', since the
334 * user should see them.
335 */
336 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
337 strbuf_addstr(&dir, opts->state_dir);
338 remove_dir_recursively(&dir, 0);
339 strbuf_release(&dir);
340
341 return 0;
342}
343
344static struct commit *peel_committish(const char *name)
345{
346 struct object *obj;
347 struct object_id oid;
348
349 if (get_oid(name, &oid))
350 return NULL;
351 obj = parse_object(the_repository, &oid);
352 return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
353}
354
355static void add_var(struct strbuf *buf, const char *name, const char *value)
356{
357 if (!value)
358 strbuf_addf(buf, "unset %s; ", name);
359 else {
360 strbuf_addf(buf, "%s=", name);
361 sq_quote_buf(buf, value);
362 strbuf_addstr(buf, "; ");
363 }
364}
365
366#define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
367
368#define RESET_HEAD_DETACH (1<<0)
369#define RESET_HEAD_HARD (1<<1)
370#define RESET_HEAD_RUN_POST_CHECKOUT_HOOK (1<<2)
371#define RESET_HEAD_REFS_ONLY (1<<3)
372
373static int reset_head(struct object_id *oid, const char *action,
374 const char *switch_to_branch, unsigned flags,
375 const char *reflog_orig_head, const char *reflog_head)
376{
377 unsigned detach_head = flags & RESET_HEAD_DETACH;
378 unsigned reset_hard = flags & RESET_HEAD_HARD;
379 unsigned run_hook = flags & RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
380 unsigned refs_only = flags & RESET_HEAD_REFS_ONLY;
381 struct object_id head_oid;
382 struct tree_desc desc[2] = { { NULL }, { NULL } };
383 struct lock_file lock = LOCK_INIT;
384 struct unpack_trees_options unpack_tree_opts;
385 struct tree *tree;
386 const char *reflog_action;
387 struct strbuf msg = STRBUF_INIT;
388 size_t prefix_len;
389 struct object_id *orig = NULL, oid_orig,
390 *old_orig = NULL, oid_old_orig;
391 int ret = 0, nr = 0;
392
393 if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
394 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
395
396 if (!refs_only && hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
397 ret = -1;
398 goto leave_reset_head;
399 }
400
401 if ((!oid || !reset_hard) && get_oid("HEAD", &head_oid)) {
402 ret = error(_("could not determine HEAD revision"));
403 goto leave_reset_head;
404 }
405
406 if (!oid)
407 oid = &head_oid;
408
409 if (refs_only)
410 goto reset_head_refs;
411
412 memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
413 setup_unpack_trees_porcelain(&unpack_tree_opts, action);
414 unpack_tree_opts.head_idx = 1;
415 unpack_tree_opts.src_index = the_repository->index;
416 unpack_tree_opts.dst_index = the_repository->index;
417 unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
418 unpack_tree_opts.update = 1;
419 unpack_tree_opts.merge = 1;
420 if (!detach_head)
421 unpack_tree_opts.reset = 1;
422
423 if (repo_read_index_unmerged(the_repository) < 0) {
424 ret = error(_("could not read index"));
425 goto leave_reset_head;
426 }
427
428 if (!reset_hard && !fill_tree_descriptor(&desc[nr++], &head_oid)) {
429 ret = error(_("failed to find tree of %s"),
430 oid_to_hex(&head_oid));
431 goto leave_reset_head;
432 }
433
434 if (!fill_tree_descriptor(&desc[nr++], oid)) {
435 ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
436 goto leave_reset_head;
437 }
438
439 if (unpack_trees(nr, desc, &unpack_tree_opts)) {
440 ret = -1;
441 goto leave_reset_head;
442 }
443
444 tree = parse_tree_indirect(oid);
445 prime_cache_tree(the_repository, the_repository->index, tree);
446
447 if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0) {
448 ret = error(_("could not write index"));
449 goto leave_reset_head;
450 }
451
452reset_head_refs:
453 reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
454 strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
455 prefix_len = msg.len;
456
457 if (!get_oid("ORIG_HEAD", &oid_old_orig))
458 old_orig = &oid_old_orig;
459 if (!get_oid("HEAD", &oid_orig)) {
460 orig = &oid_orig;
461 if (!reflog_orig_head) {
462 strbuf_addstr(&msg, "updating ORIG_HEAD");
463 reflog_orig_head = msg.buf;
464 }
465 update_ref(reflog_orig_head, "ORIG_HEAD", orig, old_orig, 0,
466 UPDATE_REFS_MSG_ON_ERR);
467 } else if (old_orig)
468 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
469 if (!reflog_head) {
470 strbuf_setlen(&msg, prefix_len);
471 strbuf_addstr(&msg, "updating HEAD");
472 reflog_head = msg.buf;
473 }
474 if (!switch_to_branch)
475 ret = update_ref(reflog_head, "HEAD", oid, orig,
476 detach_head ? REF_NO_DEREF : 0,
477 UPDATE_REFS_MSG_ON_ERR);
478 else {
479 ret = update_ref(reflog_orig_head, switch_to_branch, oid,
480 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
481 if (!ret)
482 ret = create_symref("HEAD", switch_to_branch,
483 reflog_head);
484 }
485 if (run_hook)
486 run_hook_le(NULL, "post-checkout",
487 oid_to_hex(orig ? orig : &null_oid),
488 oid_to_hex(oid), "1", NULL);
489
490leave_reset_head:
491 strbuf_release(&msg);
492 rollback_lock_file(&lock);
493 while (nr)
494 free((void *)desc[--nr].buffer);
495 return ret;
496}
497
498static int move_to_original_branch(struct rebase_options *opts)
499{
500 struct strbuf orig_head_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
501 int ret;
502
503 if (!opts->head_name)
504 return 0; /* nothing to move back to */
505
506 if (!opts->onto)
507 BUG("move_to_original_branch without onto");
508
509 strbuf_addf(&orig_head_reflog, "rebase finished: %s onto %s",
510 opts->head_name, oid_to_hex(&opts->onto->object.oid));
511 strbuf_addf(&head_reflog, "rebase finished: returning to %s",
512 opts->head_name);
513 ret = reset_head(NULL, "", opts->head_name, RESET_HEAD_REFS_ONLY,
514 orig_head_reflog.buf, head_reflog.buf);
515
516 strbuf_release(&orig_head_reflog);
517 strbuf_release(&head_reflog);
518 return ret;
519}
520
521static const char *resolvemsg =
522N_("Resolve all conflicts manually, mark them as resolved with\n"
523"\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
524"You can instead skip this commit: run \"git rebase --skip\".\n"
525"To abort and get back to the state before \"git rebase\", run "
526"\"git rebase --abort\".");
527
528static int run_am(struct rebase_options *opts)
529{
530 struct child_process am = CHILD_PROCESS_INIT;
531 struct child_process format_patch = CHILD_PROCESS_INIT;
532 struct strbuf revisions = STRBUF_INIT;
533 int status;
534 char *rebased_patches;
535
536 am.git_cmd = 1;
537 argv_array_push(&am.args, "am");
538
539 if (opts->action && !strcmp("continue", opts->action)) {
540 argv_array_push(&am.args, "--resolved");
541 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
542 if (opts->gpg_sign_opt)
543 argv_array_push(&am.args, opts->gpg_sign_opt);
544 status = run_command(&am);
545 if (status)
546 return status;
547
548 return move_to_original_branch(opts);
549 }
550 if (opts->action && !strcmp("skip", opts->action)) {
551 argv_array_push(&am.args, "--skip");
552 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
553 status = run_command(&am);
554 if (status)
555 return status;
556
557 return move_to_original_branch(opts);
558 }
559 if (opts->action && !strcmp("show-current-patch", opts->action)) {
560 argv_array_push(&am.args, "--show-current-patch");
561 return run_command(&am);
562 }
563
564 strbuf_addf(&revisions, "%s...%s",
565 oid_to_hex(opts->root ?
566 /* this is now equivalent to !opts->upstream */
567 &opts->onto->object.oid :
568 &opts->upstream->object.oid),
569 oid_to_hex(&opts->orig_head));
570
571 rebased_patches = xstrdup(git_path("rebased-patches"));
572 format_patch.out = open(rebased_patches,
573 O_WRONLY | O_CREAT | O_TRUNC, 0666);
574 if (format_patch.out < 0) {
575 status = error_errno(_("could not open '%s' for writing"),
576 rebased_patches);
577 free(rebased_patches);
578 argv_array_clear(&am.args);
579 return status;
580 }
581
582 format_patch.git_cmd = 1;
583 argv_array_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
584 "--full-index", "--cherry-pick", "--right-only",
585 "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
586 "--no-cover-letter", "--pretty=mboxrd", "--topo-order", NULL);
587 if (opts->git_format_patch_opt.len)
588 argv_array_split(&format_patch.args,
589 opts->git_format_patch_opt.buf);
590 argv_array_push(&format_patch.args, revisions.buf);
591 if (opts->restrict_revision)
592 argv_array_pushf(&format_patch.args, "^%s",
593 oid_to_hex(&opts->restrict_revision->object.oid));
594
595 status = run_command(&format_patch);
596 if (status) {
597 unlink(rebased_patches);
598 free(rebased_patches);
599 argv_array_clear(&am.args);
600
601 reset_head(&opts->orig_head, "checkout", opts->head_name, 0,
602 "HEAD", NULL);
603 error(_("\ngit encountered an error while preparing the "
604 "patches to replay\n"
605 "these revisions:\n"
606 "\n %s\n\n"
607 "As a result, git cannot rebase them."),
608 opts->revisions);
609
610 strbuf_release(&revisions);
611 return status;
612 }
613 strbuf_release(&revisions);
614
615 am.in = open(rebased_patches, O_RDONLY);
616 if (am.in < 0) {
617 status = error_errno(_("could not open '%s' for reading"),
618 rebased_patches);
619 free(rebased_patches);
620 argv_array_clear(&am.args);
621 return status;
622 }
623
624 argv_array_pushv(&am.args, opts->git_am_opts.argv);
625 argv_array_push(&am.args, "--rebasing");
626 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
627 argv_array_push(&am.args, "--patch-format=mboxrd");
628 if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
629 argv_array_push(&am.args, "--rerere-autoupdate");
630 else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
631 argv_array_push(&am.args, "--no-rerere-autoupdate");
632 if (opts->gpg_sign_opt)
633 argv_array_push(&am.args, opts->gpg_sign_opt);
634 status = run_command(&am);
635 unlink(rebased_patches);
636 free(rebased_patches);
637
638 if (!status) {
639 return move_to_original_branch(opts);
640 }
641
642 if (is_directory(opts->state_dir))
643 rebase_write_basic_state(opts);
644
645 return status;
646}
647
648static int run_specific_rebase(struct rebase_options *opts)
649{
650 const char *argv[] = { NULL, NULL };
651 struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
652 int status;
653 const char *backend, *backend_func;
654
655 if (opts->type == REBASE_INTERACTIVE) {
656 /* Run builtin interactive rebase */
657 struct child_process child = CHILD_PROCESS_INIT;
658
659 argv_array_pushf(&child.env_array, "GIT_CHERRY_PICK_HELP=%s",
660 resolvemsg);
661 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
662 argv_array_push(&child.env_array,
663 "GIT_SEQUENCE_EDITOR=:");
664 opts->autosquash = 0;
665 }
666
667 child.git_cmd = 1;
668 argv_array_push(&child.args, "rebase--interactive");
669
670 if (opts->action)
671 argv_array_pushf(&child.args, "--%s", opts->action);
672 if (opts->keep_empty)
673 argv_array_push(&child.args, "--keep-empty");
674 if (opts->rebase_merges)
675 argv_array_push(&child.args, "--rebase-merges");
676 if (opts->rebase_cousins)
677 argv_array_push(&child.args, "--rebase-cousins");
678 if (opts->autosquash)
679 argv_array_push(&child.args, "--autosquash");
680 if (opts->flags & REBASE_VERBOSE)
681 argv_array_push(&child.args, "--verbose");
682 if (opts->flags & REBASE_FORCE)
683 argv_array_push(&child.args, "--no-ff");
684 if (opts->restrict_revision)
685 argv_array_pushf(&child.args,
686 "--restrict-revision=^%s",
687 oid_to_hex(&opts->restrict_revision->object.oid));
688 if (opts->upstream)
689 argv_array_pushf(&child.args, "--upstream=%s",
690 oid_to_hex(&opts->upstream->object.oid));
691 if (opts->onto)
692 argv_array_pushf(&child.args, "--onto=%s",
693 oid_to_hex(&opts->onto->object.oid));
694 if (opts->squash_onto)
695 argv_array_pushf(&child.args, "--squash-onto=%s",
696 oid_to_hex(opts->squash_onto));
697 if (opts->onto_name)
698 argv_array_pushf(&child.args, "--onto-name=%s",
699 opts->onto_name);
700 argv_array_pushf(&child.args, "--head-name=%s",
701 opts->head_name ?
702 opts->head_name : "detached HEAD");
703 if (opts->strategy)
704 argv_array_pushf(&child.args, "--strategy=%s",
705 opts->strategy);
706 if (opts->strategy_opts)
707 argv_array_pushf(&child.args, "--strategy-opts=%s",
708 opts->strategy_opts);
709 if (opts->switch_to)
710 argv_array_pushf(&child.args, "--switch-to=%s",
711 opts->switch_to);
712 if (opts->cmd)
713 argv_array_pushf(&child.args, "--cmd=%s", opts->cmd);
714 if (opts->allow_empty_message)
715 argv_array_push(&child.args, "--allow-empty-message");
716 if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
717 argv_array_push(&child.args, "--rerere-autoupdate");
718 else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
719 argv_array_push(&child.args, "--no-rerere-autoupdate");
720 if (opts->gpg_sign_opt)
721 argv_array_push(&child.args, opts->gpg_sign_opt);
722 if (opts->signoff)
723 argv_array_push(&child.args, "--signoff");
724 if (opts->reschedule_failed_exec)
725 argv_array_push(&child.args, "--reschedule-failed-exec");
726
727 status = run_command(&child);
728 goto finished_rebase;
729 }
730
731 if (opts->type == REBASE_AM) {
732 status = run_am(opts);
733 goto finished_rebase;
734 }
735
736 add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
737 add_var(&script_snippet, "state_dir", opts->state_dir);
738
739 add_var(&script_snippet, "upstream_name", opts->upstream_name);
740 add_var(&script_snippet, "upstream", opts->upstream ?
741 oid_to_hex(&opts->upstream->object.oid) : NULL);
742 add_var(&script_snippet, "head_name",
743 opts->head_name ? opts->head_name : "detached HEAD");
744 add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
745 add_var(&script_snippet, "onto", opts->onto ?
746 oid_to_hex(&opts->onto->object.oid) : NULL);
747 add_var(&script_snippet, "onto_name", opts->onto_name);
748 add_var(&script_snippet, "revisions", opts->revisions);
749 add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
750 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
751 add_var(&script_snippet, "GIT_QUIET",
752 opts->flags & REBASE_NO_QUIET ? "" : "t");
753 sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
754 add_var(&script_snippet, "git_am_opt", buf.buf);
755 strbuf_release(&buf);
756 add_var(&script_snippet, "verbose",
757 opts->flags & REBASE_VERBOSE ? "t" : "");
758 add_var(&script_snippet, "diffstat",
759 opts->flags & REBASE_DIFFSTAT ? "t" : "");
760 add_var(&script_snippet, "force_rebase",
761 opts->flags & REBASE_FORCE ? "t" : "");
762 if (opts->switch_to)
763 add_var(&script_snippet, "switch_to", opts->switch_to);
764 add_var(&script_snippet, "action", opts->action ? opts->action : "");
765 add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
766 add_var(&script_snippet, "allow_rerere_autoupdate",
767 opts->allow_rerere_autoupdate ?
768 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
769 "--rerere-autoupdate" : "--no-rerere-autoupdate" : "");
770 add_var(&script_snippet, "keep_empty", opts->keep_empty ? "yes" : "");
771 add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
772 add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
773 add_var(&script_snippet, "cmd", opts->cmd);
774 add_var(&script_snippet, "allow_empty_message",
775 opts->allow_empty_message ? "--allow-empty-message" : "");
776 add_var(&script_snippet, "rebase_merges",
777 opts->rebase_merges ? "t" : "");
778 add_var(&script_snippet, "rebase_cousins",
779 opts->rebase_cousins ? "t" : "");
780 add_var(&script_snippet, "strategy", opts->strategy);
781 add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
782 add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
783 add_var(&script_snippet, "squash_onto",
784 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
785 add_var(&script_snippet, "git_format_patch_opt",
786 opts->git_format_patch_opt.buf);
787
788 if (is_interactive(opts) &&
789 !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
790 strbuf_addstr(&script_snippet,
791 "GIT_SEQUENCE_EDITOR=:; export GIT_SEQUENCE_EDITOR; ");
792 opts->autosquash = 0;
793 }
794
795 switch (opts->type) {
796 case REBASE_AM:
797 backend = "git-rebase--am";
798 backend_func = "git_rebase__am";
799 break;
800 case REBASE_PRESERVE_MERGES:
801 backend = "git-rebase--preserve-merges";
802 backend_func = "git_rebase__preserve_merges";
803 break;
804 default:
805 BUG("Unhandled rebase type %d", opts->type);
806 break;
807 }
808
809 strbuf_addf(&script_snippet,
810 ". git-sh-setup && . git-rebase--common &&"
811 " . %s && %s", backend, backend_func);
812 argv[0] = script_snippet.buf;
813
814 status = run_command_v_opt(argv, RUN_USING_SHELL);
815finished_rebase:
816 if (opts->dont_finish_rebase)
817 ; /* do nothing */
818 else if (opts->type == REBASE_INTERACTIVE)
819 ; /* interactive rebase cleans up after itself */
820 else if (status == 0) {
821 if (!file_exists(state_dir_path("stopped-sha", opts)))
822 finish_rebase(opts);
823 } else if (status == 2) {
824 struct strbuf dir = STRBUF_INIT;
825
826 apply_autostash(opts);
827 strbuf_addstr(&dir, opts->state_dir);
828 remove_dir_recursively(&dir, 0);
829 strbuf_release(&dir);
830 die("Nothing to do");
831 }
832
833 strbuf_release(&script_snippet);
834
835 return status ? -1 : 0;
836}
837
838static int rebase_config(const char *var, const char *value, void *data)
839{
840 struct rebase_options *opts = data;
841
842 if (!strcmp(var, "rebase.stat")) {
843 if (git_config_bool(var, value))
844 opts->flags |= REBASE_DIFFSTAT;
845 else
846 opts->flags &= !REBASE_DIFFSTAT;
847 return 0;
848 }
849
850 if (!strcmp(var, "rebase.autosquash")) {
851 opts->autosquash = git_config_bool(var, value);
852 return 0;
853 }
854
855 if (!strcmp(var, "commit.gpgsign")) {
856 free(opts->gpg_sign_opt);
857 opts->gpg_sign_opt = git_config_bool(var, value) ?
858 xstrdup("-S") : NULL;
859 return 0;
860 }
861
862 if (!strcmp(var, "rebase.autostash")) {
863 opts->autostash = git_config_bool(var, value);
864 return 0;
865 }
866
867 if (!strcmp(var, "rebase.reschedulefailedexec")) {
868 opts->reschedule_failed_exec = git_config_bool(var, value);
869 return 0;
870 }
871
872 return git_default_config(var, value, data);
873}
874
875/*
876 * Determines whether the commits in from..to are linear, i.e. contain
877 * no merge commits. This function *expects* `from` to be an ancestor of
878 * `to`.
879 */
880static int is_linear_history(struct commit *from, struct commit *to)
881{
882 while (to && to != from) {
883 parse_commit(to);
884 if (!to->parents)
885 return 1;
886 if (to->parents->next)
887 return 0;
888 to = to->parents->item;
889 }
890 return 1;
891}
892
893static int can_fast_forward(struct commit *onto, struct object_id *head_oid,
894 struct object_id *merge_base)
895{
896 struct commit *head = lookup_commit(the_repository, head_oid);
897 struct commit_list *merge_bases;
898 int res;
899
900 if (!head)
901 return 0;
902
903 merge_bases = get_merge_bases(onto, head);
904 if (merge_bases && !merge_bases->next) {
905 oidcpy(merge_base, &merge_bases->item->object.oid);
906 res = oideq(merge_base, &onto->object.oid);
907 } else {
908 oidcpy(merge_base, &null_oid);
909 res = 0;
910 }
911 free_commit_list(merge_bases);
912 return res && is_linear_history(onto, head);
913}
914
915/* -i followed by -m is still -i */
916static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
917{
918 struct rebase_options *opts = opt->value;
919
920 BUG_ON_OPT_NEG(unset);
921 BUG_ON_OPT_ARG(arg);
922
923 if (!is_interactive(opts))
924 opts->type = REBASE_MERGE;
925
926 return 0;
927}
928
929/* -i followed by -p is still explicitly interactive, but -p alone is not */
930static int parse_opt_interactive(const struct option *opt, const char *arg,
931 int unset)
932{
933 struct rebase_options *opts = opt->value;
934
935 BUG_ON_OPT_NEG(unset);
936 BUG_ON_OPT_ARG(arg);
937
938 opts->type = REBASE_INTERACTIVE;
939 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
940
941 return 0;
942}
943
944static void NORETURN error_on_missing_default_upstream(void)
945{
946 struct branch *current_branch = branch_get(NULL);
947
948 printf(_("%s\n"
949 "Please specify which branch you want to rebase against.\n"
950 "See git-rebase(1) for details.\n"
951 "\n"
952 " git rebase '<branch>'\n"
953 "\n"),
954 current_branch ? _("There is no tracking information for "
955 "the current branch.") :
956 _("You are not currently on a branch."));
957
958 if (current_branch) {
959 const char *remote = current_branch->remote_name;
960
961 if (!remote)
962 remote = _("<remote>");
963
964 printf(_("If you wish to set tracking information for this "
965 "branch you can do so with:\n"
966 "\n"
967 " git branch --set-upstream-to=%s/<branch> %s\n"
968 "\n"),
969 remote, current_branch->name);
970 }
971 exit(1);
972}
973
974static void set_reflog_action(struct rebase_options *options)
975{
976 const char *env;
977 struct strbuf buf = STRBUF_INIT;
978
979 if (!is_interactive(options))
980 return;
981
982 env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
983 if (env && strcmp("rebase", env))
984 return; /* only override it if it is "rebase" */
985
986 strbuf_addf(&buf, "rebase -i (%s)", options->action);
987 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
988 strbuf_release(&buf);
989}
990
991static int check_exec_cmd(const char *cmd)
992{
993 if (strchr(cmd, '\n'))
994 return error(_("exec commands cannot contain newlines"));
995
996 /* Does the command consist purely of whitespace? */
997 if (!cmd[strspn(cmd, " \t\r\f\v")])
998 return error(_("empty exec command"));
999
1000 return 0;
1001}
1002
1003
1004int cmd_rebase(int argc, const char **argv, const char *prefix)
1005{
1006 struct rebase_options options = {
1007 .type = REBASE_UNSPECIFIED,
1008 .flags = REBASE_NO_QUIET,
1009 .git_am_opts = ARGV_ARRAY_INIT,
1010 .allow_empty_message = 1,
1011 .git_format_patch_opt = STRBUF_INIT,
1012 };
1013 const char *branch_name;
1014 int ret, flags, total_argc, in_progress = 0;
1015 int ok_to_skip_pre_rebase = 0;
1016 struct strbuf msg = STRBUF_INIT;
1017 struct strbuf revisions = STRBUF_INIT;
1018 struct strbuf buf = STRBUF_INIT;
1019 struct object_id merge_base;
1020 enum {
1021 NO_ACTION,
1022 ACTION_CONTINUE,
1023 ACTION_SKIP,
1024 ACTION_ABORT,
1025 ACTION_QUIT,
1026 ACTION_EDIT_TODO,
1027 ACTION_SHOW_CURRENT_PATCH,
1028 } action = NO_ACTION;
1029 static const char *action_names[] = { "undefined",
1030 "continue",
1031 "skip",
1032 "abort",
1033 "quit",
1034 "edit_todo",
1035 "show_current_patch" };
1036 const char *gpg_sign = NULL;
1037 struct string_list exec = STRING_LIST_INIT_NODUP;
1038 const char *rebase_merges = NULL;
1039 int fork_point = -1;
1040 struct string_list strategy_options = STRING_LIST_INIT_NODUP;
1041 struct object_id squash_onto;
1042 char *squash_onto_name = NULL;
1043 struct option builtin_rebase_options[] = {
1044 OPT_STRING(0, "onto", &options.onto_name,
1045 N_("revision"),
1046 N_("rebase onto given branch instead of upstream")),
1047 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1048 N_("allow pre-rebase hook to run")),
1049 OPT_NEGBIT('q', "quiet", &options.flags,
1050 N_("be quiet. implies --no-stat"),
1051 REBASE_NO_QUIET| REBASE_VERBOSE | REBASE_DIFFSTAT),
1052 OPT_BIT('v', "verbose", &options.flags,
1053 N_("display a diffstat of what changed upstream"),
1054 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1055 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1056 N_("do not show diffstat of what changed upstream"),
1057 PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
1058 OPT_BOOL(0, "signoff", &options.signoff,
1059 N_("add a Signed-off-by: line to each commit")),
1060 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
1061 NULL, N_("passed to 'git am'"),
1062 PARSE_OPT_NOARG),
1063 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
1064 &options.git_am_opts, NULL,
1065 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1066 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
1067 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1068 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1069 N_("passed to 'git apply'"), 0),
1070 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1071 N_("action"), N_("passed to 'git apply'"), 0),
1072 OPT_BIT('f', "force-rebase", &options.flags,
1073 N_("cherry-pick all commits, even if unchanged"),
1074 REBASE_FORCE),
1075 OPT_BIT(0, "no-ff", &options.flags,
1076 N_("cherry-pick all commits, even if unchanged"),
1077 REBASE_FORCE),
1078 OPT_CMDMODE(0, "continue", &action, N_("continue"),
1079 ACTION_CONTINUE),
1080 OPT_CMDMODE(0, "skip", &action,
1081 N_("skip current patch and continue"), ACTION_SKIP),
1082 OPT_CMDMODE(0, "abort", &action,
1083 N_("abort and check out the original branch"),
1084 ACTION_ABORT),
1085 OPT_CMDMODE(0, "quit", &action,
1086 N_("abort but keep HEAD where it is"), ACTION_QUIT),
1087 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
1088 "during an interactive rebase"), ACTION_EDIT_TODO),
1089 OPT_CMDMODE(0, "show-current-patch", &action,
1090 N_("show the patch file being applied or merged"),
1091 ACTION_SHOW_CURRENT_PATCH),
1092 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
1093 N_("use merging strategies to rebase"),
1094 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1095 parse_opt_merge },
1096 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
1097 N_("let the user edit the list of commits to rebase"),
1098 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1099 parse_opt_interactive },
1100 OPT_SET_INT('p', "preserve-merges", &options.type,
1101 N_("try to recreate merges instead of ignoring "
1102 "them"), REBASE_PRESERVE_MERGES),
1103 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
1104 OPT_BOOL('k', "keep-empty", &options.keep_empty,
1105 N_("preserve empty commits during rebase")),
1106 OPT_BOOL(0, "autosquash", &options.autosquash,
1107 N_("move commits that begin with "
1108 "squash!/fixup! under -i")),
1109 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1110 N_("GPG-sign commits"),
1111 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1112 OPT_BOOL(0, "autostash", &options.autostash,
1113 N_("automatically stash/stash pop before and after")),
1114 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
1115 N_("add exec lines after each commit of the "
1116 "editable list")),
1117 OPT_BOOL(0, "allow-empty-message",
1118 &options.allow_empty_message,
1119 N_("allow rebasing commits with empty messages")),
1120 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1121 N_("mode"),
1122 N_("try to rebase merges instead of skipping them"),
1123 PARSE_OPT_OPTARG, NULL, (intptr_t)""},
1124 OPT_BOOL(0, "fork-point", &fork_point,
1125 N_("use 'merge-base --fork-point' to refine upstream")),
1126 OPT_STRING('s', "strategy", &options.strategy,
1127 N_("strategy"), N_("use the given merge strategy")),
1128 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1129 N_("option"),
1130 N_("pass the argument through to the merge "
1131 "strategy")),
1132 OPT_BOOL(0, "root", &options.root,
1133 N_("rebase all reachable commits up to the root(s)")),
1134 OPT_BOOL(0, "reschedule-failed-exec",
1135 &options.reschedule_failed_exec,
1136 N_("automatically re-schedule any `exec` that fails")),
1137 OPT_END(),
1138 };
1139 int i;
1140
1141 /*
1142 * NEEDSWORK: Once the builtin rebase has been tested enough
1143 * and git-legacy-rebase.sh is retired to contrib/, this preamble
1144 * can be removed.
1145 */
1146
1147 if (!use_builtin_rebase()) {
1148 const char *path = mkpath("%s/git-legacy-rebase",
1149 git_exec_path());
1150
1151 if (sane_execvp(path, (char **)argv) < 0)
1152 die_errno(_("could not exec %s"), path);
1153 else
1154 BUG("sane_execvp() returned???");
1155 }
1156
1157 if (argc == 2 && !strcmp(argv[1], "-h"))
1158 usage_with_options(builtin_rebase_usage,
1159 builtin_rebase_options);
1160
1161 prefix = setup_git_directory();
1162 trace_repo_setup(prefix);
1163 setup_work_tree();
1164
1165 git_config(rebase_config, &options);
1166
1167 strbuf_reset(&buf);
1168 strbuf_addf(&buf, "%s/applying", apply_dir());
1169 if(file_exists(buf.buf))
1170 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1171
1172 if (is_directory(apply_dir())) {
1173 options.type = REBASE_AM;
1174 options.state_dir = apply_dir();
1175 } else if (is_directory(merge_dir())) {
1176 strbuf_reset(&buf);
1177 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1178 if (is_directory(buf.buf)) {
1179 options.type = REBASE_PRESERVE_MERGES;
1180 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1181 } else {
1182 strbuf_reset(&buf);
1183 strbuf_addf(&buf, "%s/interactive", merge_dir());
1184 if(file_exists(buf.buf)) {
1185 options.type = REBASE_INTERACTIVE;
1186 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1187 } else
1188 options.type = REBASE_MERGE;
1189 }
1190 options.state_dir = merge_dir();
1191 }
1192
1193 if (options.type != REBASE_UNSPECIFIED)
1194 in_progress = 1;
1195
1196 total_argc = argc;
1197 argc = parse_options(argc, argv, prefix,
1198 builtin_rebase_options,
1199 builtin_rebase_usage, 0);
1200
1201 if (action != NO_ACTION && total_argc != 2) {
1202 usage_with_options(builtin_rebase_usage,
1203 builtin_rebase_options);
1204 }
1205
1206 if (argc > 2)
1207 usage_with_options(builtin_rebase_usage,
1208 builtin_rebase_options);
1209
1210 if (action != NO_ACTION && !in_progress)
1211 die(_("No rebase in progress?"));
1212 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
1213
1214 if (action == ACTION_EDIT_TODO && !is_interactive(&options))
1215 die(_("The --edit-todo action can only be used during "
1216 "interactive rebase."));
1217
1218 if (trace2_is_enabled()) {
1219 if (is_interactive(&options))
1220 trace2_cmd_mode("interactive");
1221 else if (exec.nr)
1222 trace2_cmd_mode("interactive-exec");
1223 else
1224 trace2_cmd_mode(action_names[action]);
1225 }
1226
1227 switch (action) {
1228 case ACTION_CONTINUE: {
1229 struct object_id head;
1230 struct lock_file lock_file = LOCK_INIT;
1231 int fd;
1232
1233 options.action = "continue";
1234 set_reflog_action(&options);
1235
1236 /* Sanity check */
1237 if (get_oid("HEAD", &head))
1238 die(_("Cannot read HEAD"));
1239
1240 fd = hold_locked_index(&lock_file, 0);
1241 if (repo_read_index(the_repository) < 0)
1242 die(_("could not read index"));
1243 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1244 NULL);
1245 if (0 <= fd)
1246 repo_update_index_if_able(the_repository, &lock_file);
1247 rollback_lock_file(&lock_file);
1248
1249 if (has_unstaged_changes(the_repository, 1)) {
1250 puts(_("You must edit all merge conflicts and then\n"
1251 "mark them as resolved using git add"));
1252 exit(1);
1253 }
1254 if (read_basic_state(&options))
1255 exit(1);
1256 goto run_rebase;
1257 }
1258 case ACTION_SKIP: {
1259 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1260
1261 options.action = "skip";
1262 set_reflog_action(&options);
1263
1264 rerere_clear(the_repository, &merge_rr);
1265 string_list_clear(&merge_rr, 1);
1266
1267 if (reset_head(NULL, "reset", NULL, RESET_HEAD_HARD,
1268 NULL, NULL) < 0)
1269 die(_("could not discard worktree changes"));
1270 remove_branch_state(the_repository);
1271 if (read_basic_state(&options))
1272 exit(1);
1273 goto run_rebase;
1274 }
1275 case ACTION_ABORT: {
1276 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1277 options.action = "abort";
1278 set_reflog_action(&options);
1279
1280 rerere_clear(the_repository, &merge_rr);
1281 string_list_clear(&merge_rr, 1);
1282
1283 if (read_basic_state(&options))
1284 exit(1);
1285 if (reset_head(&options.orig_head, "reset",
1286 options.head_name, RESET_HEAD_HARD,
1287 NULL, NULL) < 0)
1288 die(_("could not move back to %s"),
1289 oid_to_hex(&options.orig_head));
1290 remove_branch_state(the_repository);
1291 ret = finish_rebase(&options);
1292 goto cleanup;
1293 }
1294 case ACTION_QUIT: {
1295 strbuf_reset(&buf);
1296 strbuf_addstr(&buf, options.state_dir);
1297 ret = !!remove_dir_recursively(&buf, 0);
1298 if (ret)
1299 die(_("could not remove '%s'"), options.state_dir);
1300 goto cleanup;
1301 }
1302 case ACTION_EDIT_TODO:
1303 options.action = "edit-todo";
1304 options.dont_finish_rebase = 1;
1305 goto run_rebase;
1306 case ACTION_SHOW_CURRENT_PATCH:
1307 options.action = "show-current-patch";
1308 options.dont_finish_rebase = 1;
1309 goto run_rebase;
1310 case NO_ACTION:
1311 break;
1312 default:
1313 BUG("action: %d", action);
1314 }
1315
1316 /* Make sure no rebase is in progress */
1317 if (in_progress) {
1318 const char *last_slash = strrchr(options.state_dir, '/');
1319 const char *state_dir_base =
1320 last_slash ? last_slash + 1 : options.state_dir;
1321 const char *cmd_live_rebase =
1322 "git rebase (--continue | --abort | --skip)";
1323 strbuf_reset(&buf);
1324 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1325 die(_("It seems that there is already a %s directory, and\n"
1326 "I wonder if you are in the middle of another rebase. "
1327 "If that is the\n"
1328 "case, please try\n\t%s\n"
1329 "If that is not the case, please\n\t%s\n"
1330 "and run me again. I am stopping in case you still "
1331 "have something\n"
1332 "valuable there.\n"),
1333 state_dir_base, cmd_live_rebase, buf.buf);
1334 }
1335
1336 for (i = 0; i < options.git_am_opts.argc; i++) {
1337 const char *option = options.git_am_opts.argv[i], *p;
1338 if (!strcmp(option, "--committer-date-is-author-date") ||
1339 !strcmp(option, "--ignore-date") ||
1340 !strcmp(option, "--whitespace=fix") ||
1341 !strcmp(option, "--whitespace=strip"))
1342 options.flags |= REBASE_FORCE;
1343 else if (skip_prefix(option, "-C", &p)) {
1344 while (*p)
1345 if (!isdigit(*(p++)))
1346 die(_("switch `C' expects a "
1347 "numerical value"));
1348 } else if (skip_prefix(option, "--whitespace=", &p)) {
1349 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1350 strcmp(p, "error") && strcmp(p, "error-all"))
1351 die("Invalid whitespace option: '%s'", p);
1352 }
1353 }
1354
1355 for (i = 0; i < exec.nr; i++)
1356 if (check_exec_cmd(exec.items[i].string))
1357 exit(1);
1358
1359 if (!(options.flags & REBASE_NO_QUIET))
1360 argv_array_push(&options.git_am_opts, "-q");
1361
1362 if (options.keep_empty)
1363 imply_interactive(&options, "--keep-empty");
1364
1365 if (gpg_sign) {
1366 free(options.gpg_sign_opt);
1367 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1368 }
1369
1370 if (exec.nr) {
1371 int i;
1372
1373 imply_interactive(&options, "--exec");
1374
1375 strbuf_reset(&buf);
1376 for (i = 0; i < exec.nr; i++)
1377 strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1378 options.cmd = xstrdup(buf.buf);
1379 }
1380
1381 if (rebase_merges) {
1382 if (!*rebase_merges)
1383 ; /* default mode; do nothing */
1384 else if (!strcmp("rebase-cousins", rebase_merges))
1385 options.rebase_cousins = 1;
1386 else if (strcmp("no-rebase-cousins", rebase_merges))
1387 die(_("Unknown mode: %s"), rebase_merges);
1388 options.rebase_merges = 1;
1389 imply_interactive(&options, "--rebase-merges");
1390 }
1391
1392 if (strategy_options.nr) {
1393 int i;
1394
1395 if (!options.strategy)
1396 options.strategy = "recursive";
1397
1398 strbuf_reset(&buf);
1399 for (i = 0; i < strategy_options.nr; i++)
1400 strbuf_addf(&buf, " --%s",
1401 strategy_options.items[i].string);
1402 options.strategy_opts = xstrdup(buf.buf);
1403 }
1404
1405 if (options.strategy) {
1406 options.strategy = xstrdup(options.strategy);
1407 switch (options.type) {
1408 case REBASE_AM:
1409 die(_("--strategy requires --merge or --interactive"));
1410 case REBASE_MERGE:
1411 case REBASE_INTERACTIVE:
1412 case REBASE_PRESERVE_MERGES:
1413 /* compatible */
1414 break;
1415 case REBASE_UNSPECIFIED:
1416 options.type = REBASE_MERGE;
1417 break;
1418 default:
1419 BUG("unhandled rebase type (%d)", options.type);
1420 }
1421 }
1422
1423 if (options.type == REBASE_MERGE)
1424 imply_interactive(&options, "--merge");
1425
1426 if (options.root && !options.onto_name)
1427 imply_interactive(&options, "--root without --onto");
1428
1429 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1430 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1431
1432 switch (options.type) {
1433 case REBASE_MERGE:
1434 case REBASE_INTERACTIVE:
1435 case REBASE_PRESERVE_MERGES:
1436 options.state_dir = merge_dir();
1437 break;
1438 case REBASE_AM:
1439 options.state_dir = apply_dir();
1440 break;
1441 default:
1442 /* the default rebase backend is `--am` */
1443 options.type = REBASE_AM;
1444 options.state_dir = apply_dir();
1445 break;
1446 }
1447
1448 if (options.reschedule_failed_exec && !is_interactive(&options))
1449 die(_("%s requires an interactive rebase"), "--reschedule-failed-exec");
1450
1451 if (options.git_am_opts.argc) {
1452 /* all am options except -q are compatible only with --am */
1453 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1454 if (strcmp(options.git_am_opts.argv[i], "-q"))
1455 break;
1456
1457 if (is_interactive(&options) && i >= 0)
1458 die(_("cannot combine am options with either "
1459 "interactive or merge options"));
1460 }
1461
1462 if (options.signoff) {
1463 if (options.type == REBASE_PRESERVE_MERGES)
1464 die("cannot combine '--signoff' with "
1465 "'--preserve-merges'");
1466 argv_array_push(&options.git_am_opts, "--signoff");
1467 options.flags |= REBASE_FORCE;
1468 }
1469
1470 if (options.type == REBASE_PRESERVE_MERGES) {
1471 /*
1472 * Note: incompatibility with --signoff handled in signoff block above
1473 * Note: incompatibility with --interactive is just a strong warning;
1474 * git-rebase.txt caveats with "unless you know what you are doing"
1475 */
1476 if (options.rebase_merges)
1477 die(_("cannot combine '--preserve-merges' with "
1478 "'--rebase-merges'"));
1479
1480 if (options.reschedule_failed_exec)
1481 die(_("error: cannot combine '--preserve-merges' with "
1482 "'--reschedule-failed-exec'"));
1483 }
1484
1485 if (options.rebase_merges) {
1486 if (strategy_options.nr)
1487 die(_("cannot combine '--rebase-merges' with "
1488 "'--strategy-option'"));
1489 if (options.strategy)
1490 die(_("cannot combine '--rebase-merges' with "
1491 "'--strategy'"));
1492 }
1493
1494 if (!options.root) {
1495 if (argc < 1) {
1496 struct branch *branch;
1497
1498 branch = branch_get(NULL);
1499 options.upstream_name = branch_get_upstream(branch,
1500 NULL);
1501 if (!options.upstream_name)
1502 error_on_missing_default_upstream();
1503 if (fork_point < 0)
1504 fork_point = 1;
1505 } else {
1506 options.upstream_name = argv[0];
1507 argc--;
1508 argv++;
1509 if (!strcmp(options.upstream_name, "-"))
1510 options.upstream_name = "@{-1}";
1511 }
1512 options.upstream = peel_committish(options.upstream_name);
1513 if (!options.upstream)
1514 die(_("invalid upstream '%s'"), options.upstream_name);
1515 options.upstream_arg = options.upstream_name;
1516 } else {
1517 if (!options.onto_name) {
1518 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1519 &squash_onto, NULL, NULL) < 0)
1520 die(_("Could not create new root commit"));
1521 options.squash_onto = &squash_onto;
1522 options.onto_name = squash_onto_name =
1523 xstrdup(oid_to_hex(&squash_onto));
1524 }
1525 options.upstream_name = NULL;
1526 options.upstream = NULL;
1527 if (argc > 1)
1528 usage_with_options(builtin_rebase_usage,
1529 builtin_rebase_options);
1530 options.upstream_arg = "--root";
1531 }
1532
1533 /* Make sure the branch to rebase onto is valid. */
1534 if (!options.onto_name)
1535 options.onto_name = options.upstream_name;
1536 if (strstr(options.onto_name, "...")) {
1537 if (get_oid_mb(options.onto_name, &merge_base) < 0)
1538 die(_("'%s': need exactly one merge base"),
1539 options.onto_name);
1540 options.onto = lookup_commit_or_die(&merge_base,
1541 options.onto_name);
1542 } else {
1543 options.onto = peel_committish(options.onto_name);
1544 if (!options.onto)
1545 die(_("Does not point to a valid commit '%s'"),
1546 options.onto_name);
1547 }
1548
1549 /*
1550 * If the branch to rebase is given, that is the branch we will rebase
1551 * branch_name -- branch/commit being rebased, or
1552 * HEAD (already detached)
1553 * orig_head -- commit object name of tip of the branch before rebasing
1554 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1555 */
1556 if (argc == 1) {
1557 /* Is it "rebase other branchname" or "rebase other commit"? */
1558 branch_name = argv[0];
1559 options.switch_to = argv[0];
1560
1561 /* Is it a local branch? */
1562 strbuf_reset(&buf);
1563 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1564 if (!read_ref(buf.buf, &options.orig_head))
1565 options.head_name = xstrdup(buf.buf);
1566 /* If not is it a valid ref (branch or commit)? */
1567 else if (!get_oid(branch_name, &options.orig_head))
1568 options.head_name = NULL;
1569 else
1570 die(_("fatal: no such branch/commit '%s'"),
1571 branch_name);
1572 } else if (argc == 0) {
1573 /* Do not need to switch branches, we are already on it. */
1574 options.head_name =
1575 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1576 &flags));
1577 if (!options.head_name)
1578 die(_("No such ref: %s"), "HEAD");
1579 if (flags & REF_ISSYMREF) {
1580 if (!skip_prefix(options.head_name,
1581 "refs/heads/", &branch_name))
1582 branch_name = options.head_name;
1583
1584 } else {
1585 free(options.head_name);
1586 options.head_name = NULL;
1587 branch_name = "HEAD";
1588 }
1589 if (get_oid("HEAD", &options.orig_head))
1590 die(_("Could not resolve HEAD to a revision"));
1591 } else
1592 BUG("unexpected number of arguments left to parse");
1593
1594 if (fork_point > 0) {
1595 struct commit *head =
1596 lookup_commit_reference(the_repository,
1597 &options.orig_head);
1598 options.restrict_revision =
1599 get_fork_point(options.upstream_name, head);
1600 }
1601
1602 if (repo_read_index(the_repository) < 0)
1603 die(_("could not read index"));
1604
1605 if (options.autostash) {
1606 struct lock_file lock_file = LOCK_INIT;
1607 int fd;
1608
1609 fd = hold_locked_index(&lock_file, 0);
1610 refresh_cache(REFRESH_QUIET);
1611 if (0 <= fd)
1612 repo_update_index_if_able(the_repository, &lock_file);
1613 rollback_lock_file(&lock_file);
1614
1615 if (has_unstaged_changes(the_repository, 1) ||
1616 has_uncommitted_changes(the_repository, 1)) {
1617 const char *autostash =
1618 state_dir_path("autostash", &options);
1619 struct child_process stash = CHILD_PROCESS_INIT;
1620 struct object_id oid;
1621 struct commit *head =
1622 lookup_commit_reference(the_repository,
1623 &options.orig_head);
1624
1625 argv_array_pushl(&stash.args,
1626 "stash", "create", "autostash", NULL);
1627 stash.git_cmd = 1;
1628 stash.no_stdin = 1;
1629 strbuf_reset(&buf);
1630 if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
1631 die(_("Cannot autostash"));
1632 strbuf_trim_trailing_newline(&buf);
1633 if (get_oid(buf.buf, &oid))
1634 die(_("Unexpected stash response: '%s'"),
1635 buf.buf);
1636 strbuf_reset(&buf);
1637 strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
1638
1639 if (safe_create_leading_directories_const(autostash))
1640 die(_("Could not create directory for '%s'"),
1641 options.state_dir);
1642 write_file(autostash, "%s", oid_to_hex(&oid));
1643 printf(_("Created autostash: %s\n"), buf.buf);
1644 if (reset_head(&head->object.oid, "reset --hard",
1645 NULL, RESET_HEAD_HARD, NULL, NULL) < 0)
1646 die(_("could not reset --hard"));
1647 printf(_("HEAD is now at %s"),
1648 find_unique_abbrev(&head->object.oid,
1649 DEFAULT_ABBREV));
1650 strbuf_reset(&buf);
1651 pp_commit_easy(CMIT_FMT_ONELINE, head, &buf);
1652 if (buf.len > 0)
1653 printf(" %s", buf.buf);
1654 putchar('\n');
1655
1656 if (discard_index(the_repository->index) < 0 ||
1657 repo_read_index(the_repository) < 0)
1658 die(_("could not read index"));
1659 }
1660 }
1661
1662 if (require_clean_work_tree(the_repository, "rebase",
1663 _("Please commit or stash them."), 1, 1)) {
1664 ret = 1;
1665 goto cleanup;
1666 }
1667
1668 /*
1669 * Now we are rebasing commits upstream..orig_head (or with --root,
1670 * everything leading up to orig_head) on top of onto.
1671 */
1672
1673 /*
1674 * Check if we are already based on onto with linear history,
1675 * but this should be done only when upstream and onto are the same
1676 * and if this is not an interactive rebase.
1677 */
1678 if (can_fast_forward(options.onto, &options.orig_head, &merge_base) &&
1679 !is_interactive(&options) && !options.restrict_revision &&
1680 options.upstream &&
1681 !oidcmp(&options.upstream->object.oid, &options.onto->object.oid)) {
1682 int flag;
1683
1684 if (!(options.flags & REBASE_FORCE)) {
1685 /* Lazily switch to the target branch if needed... */
1686 if (options.switch_to) {
1687 struct object_id oid;
1688
1689 if (get_oid(options.switch_to, &oid) < 0) {
1690 ret = !!error(_("could not parse '%s'"),
1691 options.switch_to);
1692 goto cleanup;
1693 }
1694
1695 strbuf_reset(&buf);
1696 strbuf_addf(&buf, "%s: checkout %s",
1697 getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
1698 options.switch_to);
1699 if (reset_head(&oid, "checkout",
1700 options.head_name,
1701 RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
1702 NULL, buf.buf) < 0) {
1703 ret = !!error(_("could not switch to "
1704 "%s"),
1705 options.switch_to);
1706 goto cleanup;
1707 }
1708 }
1709
1710 if (!(options.flags & REBASE_NO_QUIET))
1711 ; /* be quiet */
1712 else if (!strcmp(branch_name, "HEAD") &&
1713 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1714 puts(_("HEAD is up to date."));
1715 else
1716 printf(_("Current branch %s is up to date.\n"),
1717 branch_name);
1718 ret = !!finish_rebase(&options);
1719 goto cleanup;
1720 } else if (!(options.flags & REBASE_NO_QUIET))
1721 ; /* be quiet */
1722 else if (!strcmp(branch_name, "HEAD") &&
1723 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1724 puts(_("HEAD is up to date, rebase forced."));
1725 else
1726 printf(_("Current branch %s is up to date, rebase "
1727 "forced.\n"), branch_name);
1728 }
1729
1730 /* If a hook exists, give it a chance to interrupt*/
1731 if (!ok_to_skip_pre_rebase &&
1732 run_hook_le(NULL, "pre-rebase", options.upstream_arg,
1733 argc ? argv[0] : NULL, NULL))
1734 die(_("The pre-rebase hook refused to rebase."));
1735
1736 if (options.flags & REBASE_DIFFSTAT) {
1737 struct diff_options opts;
1738
1739 if (options.flags & REBASE_VERBOSE) {
1740 if (is_null_oid(&merge_base))
1741 printf(_("Changes to %s:\n"),
1742 oid_to_hex(&options.onto->object.oid));
1743 else
1744 printf(_("Changes from %s to %s:\n"),
1745 oid_to_hex(&merge_base),
1746 oid_to_hex(&options.onto->object.oid));
1747 }
1748
1749 /* We want color (if set), but no pager */
1750 diff_setup(&opts);
1751 opts.stat_width = -1; /* use full terminal width */
1752 opts.stat_graph_width = -1; /* respect statGraphWidth config */
1753 opts.output_format |=
1754 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1755 opts.detect_rename = DIFF_DETECT_RENAME;
1756 diff_setup_done(&opts);
1757 diff_tree_oid(is_null_oid(&merge_base) ?
1758 the_hash_algo->empty_tree : &merge_base,
1759 &options.onto->object.oid, "", &opts);
1760 diffcore_std(&opts);
1761 diff_flush(&opts);
1762 }
1763
1764 if (is_interactive(&options))
1765 goto run_rebase;
1766
1767 /* Detach HEAD and reset the tree */
1768 if (options.flags & REBASE_NO_QUIET)
1769 printf(_("First, rewinding head to replay your work on top of "
1770 "it...\n"));
1771
1772 strbuf_addf(&msg, "%s: checkout %s",
1773 getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
1774 if (reset_head(&options.onto->object.oid, "checkout", NULL,
1775 RESET_HEAD_DETACH | RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
1776 NULL, msg.buf))
1777 die(_("Could not detach HEAD"));
1778 strbuf_release(&msg);
1779
1780 /*
1781 * If the onto is a proper descendant of the tip of the branch, then
1782 * we just fast-forwarded.
1783 */
1784 strbuf_reset(&msg);
1785 if (!oidcmp(&merge_base, &options.orig_head)) {
1786 printf(_("Fast-forwarded %s to %s.\n"),
1787 branch_name, options.onto_name);
1788 strbuf_addf(&msg, "rebase finished: %s onto %s",
1789 options.head_name ? options.head_name : "detached HEAD",
1790 oid_to_hex(&options.onto->object.oid));
1791 reset_head(NULL, "Fast-forwarded", options.head_name, 0,
1792 "HEAD", msg.buf);
1793 strbuf_release(&msg);
1794 ret = !!finish_rebase(&options);
1795 goto cleanup;
1796 }
1797
1798 strbuf_addf(&revisions, "%s..%s",
1799 options.root ? oid_to_hex(&options.onto->object.oid) :
1800 (options.restrict_revision ?
1801 oid_to_hex(&options.restrict_revision->object.oid) :
1802 oid_to_hex(&options.upstream->object.oid)),
1803 oid_to_hex(&options.orig_head));
1804
1805 options.revisions = revisions.buf;
1806
1807run_rebase:
1808 ret = !!run_specific_rebase(&options);
1809
1810cleanup:
1811 strbuf_release(&revisions);
1812 free(options.head_name);
1813 free(options.gpg_sign_opt);
1814 free(options.cmd);
1815 free(squash_onto_name);
1816 return ret;
1817}