t1300: add tests for missing keys
[alt-git.git] / builtin / rebase.c
blob6635f10d5294d16d017eae225de799efb7b1b9aa
1 /*
2 * "git rebase" builtin command
4 * Copyright (c) 2018 Pratik Karki
5 */
7 #define USE_THE_INDEX_VARIABLE
8 #include "builtin.h"
9 #include "run-command.h"
10 #include "exec-cmd.h"
11 #include "strvec.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 #include "sequencer.h"
29 #include "rebase-interactive.h"
30 #include "reset.h"
31 #include "hook.h"
33 static char const * const builtin_rebase_usage[] = {
34 N_("git rebase [-i] [options] [--exec <cmd>] "
35 "[--onto <newbase> | --keep-base] [<upstream> [<branch>]]"),
36 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
37 "--root [<branch>]"),
38 "git rebase --continue | --abort | --skip | --edit-todo",
39 NULL
42 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
43 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
44 static GIT_PATH_FUNC(apply_dir, "rebase-apply")
45 static GIT_PATH_FUNC(merge_dir, "rebase-merge")
47 enum rebase_type {
48 REBASE_UNSPECIFIED = -1,
49 REBASE_APPLY,
50 REBASE_MERGE
53 enum empty_type {
54 EMPTY_UNSPECIFIED = -1,
55 EMPTY_DROP,
56 EMPTY_KEEP,
57 EMPTY_ASK
60 enum action {
61 ACTION_NONE = 0,
62 ACTION_CONTINUE,
63 ACTION_SKIP,
64 ACTION_ABORT,
65 ACTION_QUIT,
66 ACTION_EDIT_TODO,
67 ACTION_SHOW_CURRENT_PATCH
70 static const char *action_names[] = {
71 "undefined",
72 "continue",
73 "skip",
74 "abort",
75 "quit",
76 "edit_todo",
77 "show_current_patch"
80 struct rebase_options {
81 enum rebase_type type;
82 enum empty_type empty;
83 const char *default_backend;
84 const char *state_dir;
85 struct commit *upstream;
86 const char *upstream_name;
87 const char *upstream_arg;
88 char *head_name;
89 struct commit *orig_head;
90 struct commit *onto;
91 const char *onto_name;
92 const char *revisions;
93 const char *switch_to;
94 int root, root_with_onto;
95 struct object_id *squash_onto;
96 struct commit *restrict_revision;
97 int dont_finish_rebase;
98 enum {
99 REBASE_NO_QUIET = 1<<0,
100 REBASE_VERBOSE = 1<<1,
101 REBASE_DIFFSTAT = 1<<2,
102 REBASE_FORCE = 1<<3,
103 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
104 } flags;
105 struct strvec git_am_opts;
106 enum action action;
107 char *reflog_action;
108 int signoff;
109 int allow_rerere_autoupdate;
110 int keep_empty;
111 int autosquash;
112 char *gpg_sign_opt;
113 int autostash;
114 int committer_date_is_author_date;
115 int ignore_date;
116 struct string_list exec;
117 int allow_empty_message;
118 int rebase_merges, rebase_cousins;
119 char *strategy, *strategy_opts;
120 struct strbuf git_format_patch_opt;
121 int reschedule_failed_exec;
122 int reapply_cherry_picks;
123 int fork_point;
124 int update_refs;
125 int config_autosquash;
126 int config_update_refs;
129 #define REBASE_OPTIONS_INIT { \
130 .type = REBASE_UNSPECIFIED, \
131 .empty = EMPTY_UNSPECIFIED, \
132 .keep_empty = 1, \
133 .default_backend = "merge", \
134 .flags = REBASE_NO_QUIET, \
135 .git_am_opts = STRVEC_INIT, \
136 .exec = STRING_LIST_INIT_NODUP, \
137 .git_format_patch_opt = STRBUF_INIT, \
138 .fork_point = -1, \
139 .reapply_cherry_picks = -1, \
140 .allow_empty_message = 1, \
141 .autosquash = -1, \
142 .config_autosquash = -1, \
143 .update_refs = -1, \
144 .config_update_refs = -1, \
147 static struct replay_opts get_replay_opts(const struct rebase_options *opts)
149 struct replay_opts replay = REPLAY_OPTS_INIT;
151 replay.action = REPLAY_INTERACTIVE_REBASE;
152 replay.strategy = NULL;
153 sequencer_init_config(&replay);
155 replay.signoff = opts->signoff;
156 replay.allow_ff = !(opts->flags & REBASE_FORCE);
157 if (opts->allow_rerere_autoupdate)
158 replay.allow_rerere_auto = opts->allow_rerere_autoupdate;
159 replay.allow_empty = 1;
160 replay.allow_empty_message = opts->allow_empty_message;
161 replay.drop_redundant_commits = (opts->empty == EMPTY_DROP);
162 replay.keep_redundant_commits = (opts->empty == EMPTY_KEEP);
163 replay.quiet = !(opts->flags & REBASE_NO_QUIET);
164 replay.verbose = opts->flags & REBASE_VERBOSE;
165 replay.reschedule_failed_exec = opts->reschedule_failed_exec;
166 replay.committer_date_is_author_date =
167 opts->committer_date_is_author_date;
168 replay.ignore_date = opts->ignore_date;
169 replay.gpg_sign = xstrdup_or_null(opts->gpg_sign_opt);
170 replay.reflog_action = xstrdup(opts->reflog_action);
171 if (opts->strategy)
172 replay.strategy = xstrdup_or_null(opts->strategy);
173 else if (!replay.strategy && replay.default_strategy) {
174 replay.strategy = replay.default_strategy;
175 replay.default_strategy = NULL;
178 if (opts->strategy_opts)
179 parse_strategy_opts(&replay, opts->strategy_opts);
181 if (opts->squash_onto) {
182 oidcpy(&replay.squash_onto, opts->squash_onto);
183 replay.have_squash_onto = 1;
186 return replay;
189 static int edit_todo_file(unsigned flags)
191 const char *todo_file = rebase_path_todo();
192 struct todo_list todo_list = TODO_LIST_INIT,
193 new_todo = TODO_LIST_INIT;
194 int res = 0;
196 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
197 return error_errno(_("could not read '%s'."), todo_file);
199 strbuf_stripspace(&todo_list.buf, 1);
200 res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
201 if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
202 NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
203 res = error_errno(_("could not write '%s'"), todo_file);
205 todo_list_release(&todo_list);
206 todo_list_release(&new_todo);
208 return res;
211 static int get_revision_ranges(struct commit *upstream, struct commit *onto,
212 struct object_id *orig_head, char **revisions,
213 char **shortrevisions)
215 struct commit *base_rev = upstream ? upstream : onto;
216 const char *shorthead;
218 *revisions = xstrfmt("%s...%s", oid_to_hex(&base_rev->object.oid),
219 oid_to_hex(orig_head));
221 shorthead = find_unique_abbrev(orig_head, DEFAULT_ABBREV);
223 if (upstream) {
224 const char *shortrev;
226 shortrev = find_unique_abbrev(&base_rev->object.oid,
227 DEFAULT_ABBREV);
229 *shortrevisions = xstrfmt("%s..%s", shortrev, shorthead);
230 } else
231 *shortrevisions = xstrdup(shorthead);
233 return 0;
236 static int init_basic_state(struct replay_opts *opts, const char *head_name,
237 struct commit *onto,
238 const struct object_id *orig_head)
240 FILE *interactive;
242 if (!is_directory(merge_dir()) && mkdir_in_gitdir(merge_dir()))
243 return error_errno(_("could not create temporary %s"), merge_dir());
245 delete_reflog("REBASE_HEAD");
247 interactive = fopen(path_interactive(), "w");
248 if (!interactive)
249 return error_errno(_("could not mark as interactive"));
250 fclose(interactive);
252 return write_basic_state(opts, head_name, onto, orig_head);
255 static int do_interactive_rebase(struct rebase_options *opts, unsigned flags)
257 int ret = -1;
258 char *revisions = NULL, *shortrevisions = NULL;
259 struct strvec make_script_args = STRVEC_INIT;
260 struct todo_list todo_list = TODO_LIST_INIT;
261 struct replay_opts replay = get_replay_opts(opts);
263 if (get_revision_ranges(opts->upstream, opts->onto, &opts->orig_head->object.oid,
264 &revisions, &shortrevisions))
265 goto cleanup;
267 if (init_basic_state(&replay,
268 opts->head_name ? opts->head_name : "detached HEAD",
269 opts->onto, &opts->orig_head->object.oid))
270 goto cleanup;
272 if (!opts->upstream && opts->squash_onto)
273 write_file(path_squash_onto(), "%s\n",
274 oid_to_hex(opts->squash_onto));
276 strvec_pushl(&make_script_args, "", revisions, NULL);
277 if (opts->restrict_revision)
278 strvec_pushf(&make_script_args, "^%s",
279 oid_to_hex(&opts->restrict_revision->object.oid));
281 ret = sequencer_make_script(the_repository, &todo_list.buf,
282 make_script_args.nr, make_script_args.v,
283 flags);
285 if (ret)
286 error(_("could not generate todo list"));
287 else {
288 discard_index(&the_index);
289 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
290 &todo_list))
291 BUG("unusable todo list");
293 ret = complete_action(the_repository, &replay, flags,
294 shortrevisions, opts->onto_name, opts->onto,
295 &opts->orig_head->object.oid, &opts->exec,
296 opts->autosquash, opts->update_refs, &todo_list);
299 cleanup:
300 replay_opts_release(&replay);
301 free(revisions);
302 free(shortrevisions);
303 todo_list_release(&todo_list);
304 strvec_clear(&make_script_args);
306 return ret;
309 static int run_sequencer_rebase(struct rebase_options *opts)
311 unsigned flags = 0;
312 int abbreviate_commands = 0, ret = 0;
314 git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands);
316 flags |= opts->keep_empty ? TODO_LIST_KEEP_EMPTY : 0;
317 flags |= abbreviate_commands ? TODO_LIST_ABBREVIATE_CMDS : 0;
318 flags |= opts->rebase_merges ? TODO_LIST_REBASE_MERGES : 0;
319 flags |= opts->rebase_cousins > 0 ? TODO_LIST_REBASE_COUSINS : 0;
320 flags |= opts->root_with_onto ? TODO_LIST_ROOT_WITH_ONTO : 0;
321 flags |= opts->reapply_cherry_picks ? TODO_LIST_REAPPLY_CHERRY_PICKS : 0;
322 flags |= opts->flags & REBASE_NO_QUIET ? TODO_LIST_WARN_SKIPPED_CHERRY_PICKS : 0;
324 switch (opts->action) {
325 case ACTION_NONE: {
326 if (!opts->onto && !opts->upstream)
327 die(_("a base commit must be provided with --upstream or --onto"));
329 ret = do_interactive_rebase(opts, flags);
330 break;
332 case ACTION_SKIP: {
333 struct string_list merge_rr = STRING_LIST_INIT_DUP;
335 rerere_clear(the_repository, &merge_rr);
337 /* fallthrough */
338 case ACTION_CONTINUE: {
339 struct replay_opts replay_opts = get_replay_opts(opts);
341 ret = sequencer_continue(the_repository, &replay_opts);
342 replay_opts_release(&replay_opts);
343 break;
345 case ACTION_EDIT_TODO:
346 ret = edit_todo_file(flags);
347 break;
348 case ACTION_SHOW_CURRENT_PATCH: {
349 struct child_process cmd = CHILD_PROCESS_INIT;
351 cmd.git_cmd = 1;
352 strvec_pushl(&cmd.args, "show", "REBASE_HEAD", "--", NULL);
353 ret = run_command(&cmd);
355 break;
357 default:
358 BUG("invalid command '%d'", opts->action);
361 return ret;
364 static void imply_merge(struct rebase_options *opts, const char *option);
365 static int parse_opt_keep_empty(const struct option *opt, const char *arg,
366 int unset)
368 struct rebase_options *opts = opt->value;
370 BUG_ON_OPT_ARG(arg);
372 imply_merge(opts, unset ? "--no-keep-empty" : "--keep-empty");
373 opts->keep_empty = !unset;
374 opts->type = REBASE_MERGE;
375 return 0;
378 static int is_merge(struct rebase_options *opts)
380 return opts->type == REBASE_MERGE;
383 static void imply_merge(struct rebase_options *opts, const char *option)
385 switch (opts->type) {
386 case REBASE_APPLY:
387 die(_("%s requires the merge backend"), option);
388 break;
389 case REBASE_MERGE:
390 break;
391 default:
392 opts->type = REBASE_MERGE; /* implied */
393 break;
397 /* Returns the filename prefixed by the state_dir */
398 static const char *state_dir_path(const char *filename, struct rebase_options *opts)
400 static struct strbuf path = STRBUF_INIT;
401 static size_t prefix_len;
403 if (!prefix_len) {
404 strbuf_addf(&path, "%s/", opts->state_dir);
405 prefix_len = path.len;
408 strbuf_setlen(&path, prefix_len);
409 strbuf_addstr(&path, filename);
410 return path.buf;
413 /* Initialize the rebase options from the state directory. */
414 static int read_basic_state(struct rebase_options *opts)
416 struct strbuf head_name = STRBUF_INIT;
417 struct strbuf buf = STRBUF_INIT;
418 struct object_id oid;
420 if (!read_oneliner(&head_name, state_dir_path("head-name", opts),
421 READ_ONELINER_WARN_MISSING) ||
422 !read_oneliner(&buf, state_dir_path("onto", opts),
423 READ_ONELINER_WARN_MISSING))
424 return -1;
425 opts->head_name = starts_with(head_name.buf, "refs/") ?
426 xstrdup(head_name.buf) : NULL;
427 strbuf_release(&head_name);
428 if (get_oid_hex(buf.buf, &oid) ||
429 !(opts->onto = lookup_commit_object(the_repository, &oid)))
430 return error(_("invalid onto: '%s'"), buf.buf);
433 * We always write to orig-head, but interactive rebase used to write to
434 * head. Fall back to reading from head to cover for the case that the
435 * user upgraded git with an ongoing interactive rebase.
437 strbuf_reset(&buf);
438 if (file_exists(state_dir_path("orig-head", opts))) {
439 if (!read_oneliner(&buf, state_dir_path("orig-head", opts),
440 READ_ONELINER_WARN_MISSING))
441 return -1;
442 } else if (!read_oneliner(&buf, state_dir_path("head", opts),
443 READ_ONELINER_WARN_MISSING))
444 return -1;
445 if (get_oid_hex(buf.buf, &oid) ||
446 !(opts->orig_head = lookup_commit_object(the_repository, &oid)))
447 return error(_("invalid orig-head: '%s'"), buf.buf);
449 if (file_exists(state_dir_path("quiet", opts)))
450 opts->flags &= ~REBASE_NO_QUIET;
451 else
452 opts->flags |= REBASE_NO_QUIET;
454 if (file_exists(state_dir_path("verbose", opts)))
455 opts->flags |= REBASE_VERBOSE;
457 if (file_exists(state_dir_path("signoff", opts))) {
458 opts->signoff = 1;
459 opts->flags |= REBASE_FORCE;
462 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
463 strbuf_reset(&buf);
464 if (!read_oneliner(&buf, state_dir_path("allow_rerere_autoupdate", opts),
465 READ_ONELINER_WARN_MISSING))
466 return -1;
467 if (!strcmp(buf.buf, "--rerere-autoupdate"))
468 opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
469 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
470 opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
471 else
472 warning(_("ignoring invalid allow_rerere_autoupdate: "
473 "'%s'"), buf.buf);
476 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
477 strbuf_reset(&buf);
478 if (!read_oneliner(&buf, state_dir_path("gpg_sign_opt", opts),
479 READ_ONELINER_WARN_MISSING))
480 return -1;
481 free(opts->gpg_sign_opt);
482 opts->gpg_sign_opt = xstrdup(buf.buf);
485 if (file_exists(state_dir_path("strategy", opts))) {
486 strbuf_reset(&buf);
487 if (!read_oneliner(&buf, state_dir_path("strategy", opts),
488 READ_ONELINER_WARN_MISSING))
489 return -1;
490 free(opts->strategy);
491 opts->strategy = xstrdup(buf.buf);
494 if (file_exists(state_dir_path("strategy_opts", opts))) {
495 strbuf_reset(&buf);
496 if (!read_oneliner(&buf, state_dir_path("strategy_opts", opts),
497 READ_ONELINER_WARN_MISSING))
498 return -1;
499 free(opts->strategy_opts);
500 opts->strategy_opts = xstrdup(buf.buf);
503 strbuf_release(&buf);
505 return 0;
508 static int rebase_write_basic_state(struct rebase_options *opts)
510 write_file(state_dir_path("head-name", opts), "%s",
511 opts->head_name ? opts->head_name : "detached HEAD");
512 write_file(state_dir_path("onto", opts), "%s",
513 opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
514 write_file(state_dir_path("orig-head", opts), "%s",
515 oid_to_hex(&opts->orig_head->object.oid));
516 if (!(opts->flags & REBASE_NO_QUIET))
517 write_file(state_dir_path("quiet", opts), "%s", "");
518 if (opts->flags & REBASE_VERBOSE)
519 write_file(state_dir_path("verbose", opts), "%s", "");
520 if (opts->strategy)
521 write_file(state_dir_path("strategy", opts), "%s",
522 opts->strategy);
523 if (opts->strategy_opts)
524 write_file(state_dir_path("strategy_opts", opts), "%s",
525 opts->strategy_opts);
526 if (opts->allow_rerere_autoupdate > 0)
527 write_file(state_dir_path("allow_rerere_autoupdate", opts),
528 "-%s-rerere-autoupdate",
529 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
530 "" : "-no");
531 if (opts->gpg_sign_opt)
532 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
533 opts->gpg_sign_opt);
534 if (opts->signoff)
535 write_file(state_dir_path("signoff", opts), "--signoff");
537 return 0;
540 static int finish_rebase(struct rebase_options *opts)
542 struct strbuf dir = STRBUF_INIT;
543 int ret = 0;
545 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
546 unlink(git_path_auto_merge(the_repository));
547 apply_autostash(state_dir_path("autostash", opts));
549 * We ignore errors in 'git maintenance run --auto', since the
550 * user should see them.
552 run_auto_maintenance(!(opts->flags & (REBASE_NO_QUIET|REBASE_VERBOSE)));
553 if (opts->type == REBASE_MERGE) {
554 struct replay_opts replay = REPLAY_OPTS_INIT;
556 replay.action = REPLAY_INTERACTIVE_REBASE;
557 ret = sequencer_remove_state(&replay);
558 replay_opts_release(&replay);
559 } else {
560 strbuf_addstr(&dir, opts->state_dir);
561 if (remove_dir_recursively(&dir, 0))
562 ret = error(_("could not remove '%s'"),
563 opts->state_dir);
564 strbuf_release(&dir);
567 return ret;
570 static int move_to_original_branch(struct rebase_options *opts)
572 struct strbuf branch_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
573 struct reset_head_opts ropts = { 0 };
574 int ret;
576 if (!opts->head_name)
577 return 0; /* nothing to move back to */
579 if (!opts->onto)
580 BUG("move_to_original_branch without onto");
582 strbuf_addf(&branch_reflog, "%s (finish): %s onto %s",
583 opts->reflog_action,
584 opts->head_name, oid_to_hex(&opts->onto->object.oid));
585 strbuf_addf(&head_reflog, "%s (finish): returning to %s",
586 opts->reflog_action, opts->head_name);
587 ropts.branch = opts->head_name;
588 ropts.flags = RESET_HEAD_REFS_ONLY;
589 ropts.branch_msg = branch_reflog.buf;
590 ropts.head_msg = head_reflog.buf;
591 ret = reset_head(the_repository, &ropts);
593 strbuf_release(&branch_reflog);
594 strbuf_release(&head_reflog);
595 return ret;
598 static const char *resolvemsg =
599 N_("Resolve all conflicts manually, mark them as resolved with\n"
600 "\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
601 "You can instead skip this commit: run \"git rebase --skip\".\n"
602 "To abort and get back to the state before \"git rebase\", run "
603 "\"git rebase --abort\".");
605 static int run_am(struct rebase_options *opts)
607 struct child_process am = CHILD_PROCESS_INIT;
608 struct child_process format_patch = CHILD_PROCESS_INIT;
609 struct strbuf revisions = STRBUF_INIT;
610 int status;
611 char *rebased_patches;
613 am.git_cmd = 1;
614 strvec_push(&am.args, "am");
615 strvec_pushf(&am.env, GIT_REFLOG_ACTION_ENVIRONMENT "=%s (pick)",
616 opts->reflog_action);
617 if (opts->action == ACTION_CONTINUE) {
618 strvec_push(&am.args, "--resolved");
619 strvec_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
620 if (opts->gpg_sign_opt)
621 strvec_push(&am.args, opts->gpg_sign_opt);
622 status = run_command(&am);
623 if (status)
624 return status;
626 return move_to_original_branch(opts);
628 if (opts->action == ACTION_SKIP) {
629 strvec_push(&am.args, "--skip");
630 strvec_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
631 status = run_command(&am);
632 if (status)
633 return status;
635 return move_to_original_branch(opts);
637 if (opts->action == ACTION_SHOW_CURRENT_PATCH) {
638 strvec_push(&am.args, "--show-current-patch");
639 return run_command(&am);
642 strbuf_addf(&revisions, "%s...%s",
643 oid_to_hex(opts->root ?
644 /* this is now equivalent to !opts->upstream */
645 &opts->onto->object.oid :
646 &opts->upstream->object.oid),
647 oid_to_hex(&opts->orig_head->object.oid));
649 rebased_patches = xstrdup(git_path("rebased-patches"));
650 format_patch.out = open(rebased_patches,
651 O_WRONLY | O_CREAT | O_TRUNC, 0666);
652 if (format_patch.out < 0) {
653 status = error_errno(_("could not open '%s' for writing"),
654 rebased_patches);
655 free(rebased_patches);
656 strvec_clear(&am.args);
657 return status;
660 format_patch.git_cmd = 1;
661 strvec_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
662 "--full-index", "--cherry-pick", "--right-only",
663 "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
664 "--no-cover-letter", "--pretty=mboxrd", "--topo-order",
665 "--no-base", NULL);
666 if (opts->git_format_patch_opt.len)
667 strvec_split(&format_patch.args,
668 opts->git_format_patch_opt.buf);
669 strvec_push(&format_patch.args, revisions.buf);
670 if (opts->restrict_revision)
671 strvec_pushf(&format_patch.args, "^%s",
672 oid_to_hex(&opts->restrict_revision->object.oid));
674 status = run_command(&format_patch);
675 if (status) {
676 struct reset_head_opts ropts = { 0 };
677 unlink(rebased_patches);
678 free(rebased_patches);
679 strvec_clear(&am.args);
681 ropts.oid = &opts->orig_head->object.oid;
682 ropts.branch = opts->head_name;
683 ropts.default_reflog_action = opts->reflog_action;
684 reset_head(the_repository, &ropts);
685 error(_("\ngit encountered an error while preparing the "
686 "patches to replay\n"
687 "these revisions:\n"
688 "\n %s\n\n"
689 "As a result, git cannot rebase them."),
690 opts->revisions);
692 strbuf_release(&revisions);
693 return status;
695 strbuf_release(&revisions);
697 am.in = open(rebased_patches, O_RDONLY);
698 if (am.in < 0) {
699 status = error_errno(_("could not open '%s' for reading"),
700 rebased_patches);
701 free(rebased_patches);
702 strvec_clear(&am.args);
703 return status;
706 strvec_pushv(&am.args, opts->git_am_opts.v);
707 strvec_push(&am.args, "--rebasing");
708 strvec_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
709 strvec_push(&am.args, "--patch-format=mboxrd");
710 if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
711 strvec_push(&am.args, "--rerere-autoupdate");
712 else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
713 strvec_push(&am.args, "--no-rerere-autoupdate");
714 if (opts->gpg_sign_opt)
715 strvec_push(&am.args, opts->gpg_sign_opt);
716 status = run_command(&am);
717 unlink(rebased_patches);
718 free(rebased_patches);
720 if (!status) {
721 return move_to_original_branch(opts);
724 if (is_directory(opts->state_dir))
725 rebase_write_basic_state(opts);
727 return status;
730 static int run_specific_rebase(struct rebase_options *opts)
732 int status;
734 if (opts->type == REBASE_MERGE) {
735 /* Run sequencer-based rebase */
736 setenv("GIT_CHERRY_PICK_HELP", resolvemsg, 1);
737 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
738 setenv("GIT_SEQUENCE_EDITOR", ":", 1);
739 opts->autosquash = 0;
741 if (opts->gpg_sign_opt) {
742 /* remove the leading "-S" */
743 char *tmp = xstrdup(opts->gpg_sign_opt + 2);
744 free(opts->gpg_sign_opt);
745 opts->gpg_sign_opt = tmp;
748 status = run_sequencer_rebase(opts);
749 } else if (opts->type == REBASE_APPLY)
750 status = run_am(opts);
751 else
752 BUG("Unhandled rebase type %d", opts->type);
754 if (opts->dont_finish_rebase)
755 ; /* do nothing */
756 else if (opts->type == REBASE_MERGE)
757 ; /* merge backend cleans up after itself */
758 else if (status == 0) {
759 if (!file_exists(state_dir_path("stopped-sha", opts)))
760 finish_rebase(opts);
761 } else if (status == 2) {
762 struct strbuf dir = STRBUF_INIT;
764 apply_autostash(state_dir_path("autostash", opts));
765 strbuf_addstr(&dir, opts->state_dir);
766 remove_dir_recursively(&dir, 0);
767 strbuf_release(&dir);
768 die("Nothing to do");
771 return status ? -1 : 0;
774 static int rebase_config(const char *var, const char *value, void *data)
776 struct rebase_options *opts = data;
778 if (!strcmp(var, "rebase.stat")) {
779 if (git_config_bool(var, value))
780 opts->flags |= REBASE_DIFFSTAT;
781 else
782 opts->flags &= ~REBASE_DIFFSTAT;
783 return 0;
786 if (!strcmp(var, "rebase.autosquash")) {
787 opts->config_autosquash = git_config_bool(var, value);
788 return 0;
791 if (!strcmp(var, "commit.gpgsign")) {
792 free(opts->gpg_sign_opt);
793 opts->gpg_sign_opt = git_config_bool(var, value) ?
794 xstrdup("-S") : NULL;
795 return 0;
798 if (!strcmp(var, "rebase.autostash")) {
799 opts->autostash = git_config_bool(var, value);
800 return 0;
803 if (!strcmp(var, "rebase.updaterefs")) {
804 opts->config_update_refs = git_config_bool(var, value);
805 return 0;
808 if (!strcmp(var, "rebase.reschedulefailedexec")) {
809 opts->reschedule_failed_exec = git_config_bool(var, value);
810 return 0;
813 if (!strcmp(var, "rebase.forkpoint")) {
814 opts->fork_point = git_config_bool(var, value) ? -1 : 0;
815 return 0;
818 if (!strcmp(var, "rebase.backend")) {
819 return git_config_string(&opts->default_backend, var, value);
822 return git_default_config(var, value, data);
825 static int checkout_up_to_date(struct rebase_options *options)
827 struct strbuf buf = STRBUF_INIT;
828 struct reset_head_opts ropts = { 0 };
829 int ret = 0;
831 strbuf_addf(&buf, "%s: checkout %s",
832 options->reflog_action, options->switch_to);
833 ropts.oid = &options->orig_head->object.oid;
834 ropts.branch = options->head_name;
835 ropts.flags = RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
836 if (!ropts.branch)
837 ropts.flags |= RESET_HEAD_DETACH;
838 ropts.head_msg = buf.buf;
839 if (reset_head(the_repository, &ropts) < 0)
840 ret = error(_("could not switch to %s"), options->switch_to);
841 strbuf_release(&buf);
843 return ret;
847 * Determines whether the commits in from..to are linear, i.e. contain
848 * no merge commits. This function *expects* `from` to be an ancestor of
849 * `to`.
851 static int is_linear_history(struct commit *from, struct commit *to)
853 while (to && to != from) {
854 parse_commit(to);
855 if (!to->parents)
856 return 1;
857 if (to->parents->next)
858 return 0;
859 to = to->parents->item;
861 return 1;
864 static int can_fast_forward(struct commit *onto, struct commit *upstream,
865 struct commit *restrict_revision,
866 struct commit *head, struct object_id *branch_base)
868 struct commit_list *merge_bases = NULL;
869 int res = 0;
871 if (is_null_oid(branch_base))
872 goto done; /* fill_branch_base() found multiple merge bases */
874 if (!oideq(branch_base, &onto->object.oid))
875 goto done;
877 if (restrict_revision && !oideq(&restrict_revision->object.oid, branch_base))
878 goto done;
880 if (!upstream)
881 goto done;
883 merge_bases = get_merge_bases(upstream, head);
884 if (!merge_bases || merge_bases->next)
885 goto done;
887 if (!oideq(&onto->object.oid, &merge_bases->item->object.oid))
888 goto done;
890 res = 1;
892 done:
893 free_commit_list(merge_bases);
894 return res && is_linear_history(onto, head);
897 static void fill_branch_base(struct rebase_options *options,
898 struct object_id *branch_base)
900 struct commit_list *merge_bases = NULL;
902 merge_bases = get_merge_bases(options->onto, options->orig_head);
903 if (!merge_bases || merge_bases->next)
904 oidcpy(branch_base, null_oid());
905 else
906 oidcpy(branch_base, &merge_bases->item->object.oid);
908 free_commit_list(merge_bases);
911 static int parse_opt_am(const struct option *opt, const char *arg, int unset)
913 struct rebase_options *opts = opt->value;
915 BUG_ON_OPT_NEG(unset);
916 BUG_ON_OPT_ARG(arg);
918 if (opts->type != REBASE_UNSPECIFIED && opts->type != REBASE_APPLY)
919 die(_("apply options and merge options cannot be used together"));
921 opts->type = REBASE_APPLY;
923 return 0;
926 /* -i followed by -m is still -i */
927 static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
929 struct rebase_options *opts = opt->value;
931 BUG_ON_OPT_NEG(unset);
932 BUG_ON_OPT_ARG(arg);
934 if (opts->type != REBASE_UNSPECIFIED && opts->type != REBASE_MERGE)
935 die(_("apply options and merge options cannot be used together"));
937 opts->type = REBASE_MERGE;
939 return 0;
942 /* -i followed by -r is still explicitly interactive, but -r alone is not */
943 static int parse_opt_interactive(const struct option *opt, const char *arg,
944 int unset)
946 struct rebase_options *opts = opt->value;
948 BUG_ON_OPT_NEG(unset);
949 BUG_ON_OPT_ARG(arg);
951 if (opts->type != REBASE_UNSPECIFIED && opts->type != REBASE_MERGE)
952 die(_("apply options and merge options cannot be used together"));
954 opts->type = REBASE_MERGE;
955 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
957 return 0;
960 static enum empty_type parse_empty_value(const char *value)
962 if (!strcasecmp(value, "drop"))
963 return EMPTY_DROP;
964 else if (!strcasecmp(value, "keep"))
965 return EMPTY_KEEP;
966 else if (!strcasecmp(value, "ask"))
967 return EMPTY_ASK;
969 die(_("unrecognized empty type '%s'; valid values are \"drop\", \"keep\", and \"ask\"."), value);
972 static int parse_opt_empty(const struct option *opt, const char *arg, int unset)
974 struct rebase_options *options = opt->value;
975 enum empty_type value = parse_empty_value(arg);
977 BUG_ON_OPT_NEG(unset);
979 options->empty = value;
980 return 0;
983 static void NORETURN error_on_missing_default_upstream(void)
985 struct branch *current_branch = branch_get(NULL);
987 printf(_("%s\n"
988 "Please specify which branch you want to rebase against.\n"
989 "See git-rebase(1) for details.\n"
990 "\n"
991 " git rebase '<branch>'\n"
992 "\n"),
993 current_branch ? _("There is no tracking information for "
994 "the current branch.") :
995 _("You are not currently on a branch."));
997 if (current_branch) {
998 const char *remote = current_branch->remote_name;
1000 if (!remote)
1001 remote = _("<remote>");
1003 printf(_("If you wish to set tracking information for this "
1004 "branch you can do so with:\n"
1005 "\n"
1006 " git branch --set-upstream-to=%s/<branch> %s\n"
1007 "\n"),
1008 remote, current_branch->name);
1010 exit(1);
1013 static int check_exec_cmd(const char *cmd)
1015 if (strchr(cmd, '\n'))
1016 return error(_("exec commands cannot contain newlines"));
1018 /* Does the command consist purely of whitespace? */
1019 if (!cmd[strspn(cmd, " \t\r\f\v")])
1020 return error(_("empty exec command"));
1022 return 0;
1025 int cmd_rebase(int argc, const char **argv, const char *prefix)
1027 struct rebase_options options = REBASE_OPTIONS_INIT;
1028 const char *branch_name;
1029 int ret, flags, total_argc, in_progress = 0;
1030 int keep_base = 0;
1031 int ok_to_skip_pre_rebase = 0;
1032 struct strbuf msg = STRBUF_INIT;
1033 struct strbuf revisions = STRBUF_INIT;
1034 struct strbuf buf = STRBUF_INIT;
1035 struct object_id branch_base;
1036 int ignore_whitespace = 0;
1037 const char *gpg_sign = NULL;
1038 const char *rebase_merges = NULL;
1039 struct string_list strategy_options = STRING_LIST_INIT_NODUP;
1040 struct object_id squash_onto;
1041 char *squash_onto_name = NULL;
1042 char *keep_base_onto_name = NULL;
1043 int reschedule_failed_exec = -1;
1044 int allow_preemptive_ff = 1;
1045 int preserve_merges_selected = 0;
1046 struct reset_head_opts ropts = { 0 };
1047 struct option builtin_rebase_options[] = {
1048 OPT_STRING(0, "onto", &options.onto_name,
1049 N_("revision"),
1050 N_("rebase onto given branch instead of upstream")),
1051 OPT_BOOL(0, "keep-base", &keep_base,
1052 N_("use the merge-base of upstream and branch as the current base")),
1053 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1054 N_("allow pre-rebase hook to run")),
1055 OPT_NEGBIT('q', "quiet", &options.flags,
1056 N_("be quiet. implies --no-stat"),
1057 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1058 OPT_BIT('v', "verbose", &options.flags,
1059 N_("display a diffstat of what changed upstream"),
1060 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1061 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1062 N_("do not show diffstat of what changed upstream"),
1063 PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
1064 OPT_BOOL(0, "signoff", &options.signoff,
1065 N_("add a Signed-off-by trailer to each commit")),
1066 OPT_BOOL(0, "committer-date-is-author-date",
1067 &options.committer_date_is_author_date,
1068 N_("make committer date match author date")),
1069 OPT_BOOL(0, "reset-author-date", &options.ignore_date,
1070 N_("ignore author date and use current date")),
1071 OPT_HIDDEN_BOOL(0, "ignore-date", &options.ignore_date,
1072 N_("synonym of --reset-author-date")),
1073 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1074 N_("passed to 'git apply'"), 0),
1075 OPT_BOOL(0, "ignore-whitespace", &ignore_whitespace,
1076 N_("ignore changes in whitespace")),
1077 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1078 N_("action"), N_("passed to 'git apply'"), 0),
1079 OPT_BIT('f', "force-rebase", &options.flags,
1080 N_("cherry-pick all commits, even if unchanged"),
1081 REBASE_FORCE),
1082 OPT_BIT(0, "no-ff", &options.flags,
1083 N_("cherry-pick all commits, even if unchanged"),
1084 REBASE_FORCE),
1085 OPT_CMDMODE(0, "continue", &options.action, N_("continue"),
1086 ACTION_CONTINUE),
1087 OPT_CMDMODE(0, "skip", &options.action,
1088 N_("skip current patch and continue"), ACTION_SKIP),
1089 OPT_CMDMODE(0, "abort", &options.action,
1090 N_("abort and check out the original branch"),
1091 ACTION_ABORT),
1092 OPT_CMDMODE(0, "quit", &options.action,
1093 N_("abort but keep HEAD where it is"), ACTION_QUIT),
1094 OPT_CMDMODE(0, "edit-todo", &options.action, N_("edit the todo list "
1095 "during an interactive rebase"), ACTION_EDIT_TODO),
1096 OPT_CMDMODE(0, "show-current-patch", &options.action,
1097 N_("show the patch file being applied or merged"),
1098 ACTION_SHOW_CURRENT_PATCH),
1099 OPT_CALLBACK_F(0, "apply", &options, NULL,
1100 N_("use apply strategies to rebase"),
1101 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1102 parse_opt_am),
1103 OPT_CALLBACK_F('m', "merge", &options, NULL,
1104 N_("use merging strategies to rebase"),
1105 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1106 parse_opt_merge),
1107 OPT_CALLBACK_F('i', "interactive", &options, NULL,
1108 N_("let the user edit the list of commits to rebase"),
1109 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1110 parse_opt_interactive),
1111 OPT_SET_INT_F('p', "preserve-merges", &preserve_merges_selected,
1112 N_("(REMOVED) was: try to recreate merges "
1113 "instead of ignoring them"),
1114 1, PARSE_OPT_HIDDEN),
1115 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
1116 OPT_CALLBACK_F(0, "empty", &options, "{drop,keep,ask}",
1117 N_("how to handle commits that become empty"),
1118 PARSE_OPT_NONEG, parse_opt_empty),
1119 OPT_CALLBACK_F('k', "keep-empty", &options, NULL,
1120 N_("keep commits which start empty"),
1121 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN,
1122 parse_opt_keep_empty),
1123 OPT_BOOL(0, "autosquash", &options.autosquash,
1124 N_("move commits that begin with "
1125 "squash!/fixup! under -i")),
1126 OPT_BOOL(0, "update-refs", &options.update_refs,
1127 N_("update branches that point to commits "
1128 "that are being rebased")),
1129 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1130 N_("GPG-sign commits"),
1131 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1132 OPT_AUTOSTASH(&options.autostash),
1133 OPT_STRING_LIST('x', "exec", &options.exec, N_("exec"),
1134 N_("add exec lines after each commit of the "
1135 "editable list")),
1136 OPT_BOOL_F(0, "allow-empty-message",
1137 &options.allow_empty_message,
1138 N_("allow rebasing commits with empty messages"),
1139 PARSE_OPT_HIDDEN),
1140 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1141 N_("mode"),
1142 N_("try to rebase merges instead of skipping them"),
1143 PARSE_OPT_OPTARG, NULL, (intptr_t)""},
1144 OPT_BOOL(0, "fork-point", &options.fork_point,
1145 N_("use 'merge-base --fork-point' to refine upstream")),
1146 OPT_STRING('s', "strategy", &options.strategy,
1147 N_("strategy"), N_("use the given merge strategy")),
1148 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1149 N_("option"),
1150 N_("pass the argument through to the merge "
1151 "strategy")),
1152 OPT_BOOL(0, "root", &options.root,
1153 N_("rebase all reachable commits up to the root(s)")),
1154 OPT_BOOL(0, "reschedule-failed-exec",
1155 &reschedule_failed_exec,
1156 N_("automatically re-schedule any `exec` that fails")),
1157 OPT_BOOL(0, "reapply-cherry-picks", &options.reapply_cherry_picks,
1158 N_("apply all changes, even those already present upstream")),
1159 OPT_END(),
1161 int i;
1163 if (argc == 2 && !strcmp(argv[1], "-h"))
1164 usage_with_options(builtin_rebase_usage,
1165 builtin_rebase_options);
1167 prepare_repo_settings(the_repository);
1168 the_repository->settings.command_requires_full_index = 0;
1170 git_config(rebase_config, &options);
1171 /* options.gpg_sign_opt will be either "-S" or NULL */
1172 gpg_sign = options.gpg_sign_opt ? "" : NULL;
1173 FREE_AND_NULL(options.gpg_sign_opt);
1175 strbuf_reset(&buf);
1176 strbuf_addf(&buf, "%s/applying", apply_dir());
1177 if(file_exists(buf.buf))
1178 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1180 if (is_directory(apply_dir())) {
1181 options.type = REBASE_APPLY;
1182 options.state_dir = apply_dir();
1183 } else if (is_directory(merge_dir())) {
1184 strbuf_reset(&buf);
1185 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1186 if (!(options.action == ACTION_ABORT) && is_directory(buf.buf)) {
1187 die(_("`rebase --preserve-merges` (-p) is no longer supported.\n"
1188 "Use `git rebase --abort` to terminate current rebase.\n"
1189 "Or downgrade to v2.33, or earlier, to complete the rebase."));
1190 } else {
1191 strbuf_reset(&buf);
1192 strbuf_addf(&buf, "%s/interactive", merge_dir());
1193 options.type = REBASE_MERGE;
1194 if (file_exists(buf.buf))
1195 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1197 options.state_dir = merge_dir();
1200 if (options.type != REBASE_UNSPECIFIED)
1201 in_progress = 1;
1203 total_argc = argc;
1204 argc = parse_options(argc, argv, prefix,
1205 builtin_rebase_options,
1206 builtin_rebase_usage, 0);
1208 if (preserve_merges_selected)
1209 die(_("--preserve-merges was replaced by --rebase-merges\n"
1210 "Note: Your `pull.rebase` configuration may also be set to 'preserve',\n"
1211 "which is no longer supported; use 'merges' instead"));
1213 if (options.action != ACTION_NONE && total_argc != 2) {
1214 usage_with_options(builtin_rebase_usage,
1215 builtin_rebase_options);
1218 if (argc > 2)
1219 usage_with_options(builtin_rebase_usage,
1220 builtin_rebase_options);
1222 if (keep_base) {
1223 if (options.onto_name)
1224 die(_("options '%s' and '%s' cannot be used together"), "--keep-base", "--onto");
1225 if (options.root)
1226 die(_("options '%s' and '%s' cannot be used together"), "--keep-base", "--root");
1228 * --keep-base defaults to --no-fork-point to keep the
1229 * base the same.
1231 if (options.fork_point < 0)
1232 options.fork_point = 0;
1234 if (options.root && options.fork_point > 0)
1235 die(_("options '%s' and '%s' cannot be used together"), "--root", "--fork-point");
1237 if (options.action != ACTION_NONE && !in_progress)
1238 die(_("No rebase in progress?"));
1240 if (options.action == ACTION_EDIT_TODO && !is_merge(&options))
1241 die(_("The --edit-todo action can only be used during "
1242 "interactive rebase."));
1244 if (trace2_is_enabled()) {
1245 if (is_merge(&options))
1246 trace2_cmd_mode("interactive");
1247 else if (options.exec.nr)
1248 trace2_cmd_mode("interactive-exec");
1249 else
1250 trace2_cmd_mode(action_names[options.action]);
1253 options.reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
1254 options.reflog_action =
1255 xstrdup(options.reflog_action ? options.reflog_action : "rebase");
1257 switch (options.action) {
1258 case ACTION_CONTINUE: {
1259 struct object_id head;
1260 struct lock_file lock_file = LOCK_INIT;
1261 int fd;
1263 /* Sanity check */
1264 if (get_oid("HEAD", &head))
1265 die(_("Cannot read HEAD"));
1267 fd = repo_hold_locked_index(the_repository, &lock_file, 0);
1268 if (repo_read_index(the_repository) < 0)
1269 die(_("could not read index"));
1270 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1271 NULL);
1272 if (0 <= fd)
1273 repo_update_index_if_able(the_repository, &lock_file);
1274 rollback_lock_file(&lock_file);
1276 if (has_unstaged_changes(the_repository, 1)) {
1277 puts(_("You must edit all merge conflicts and then\n"
1278 "mark them as resolved using git add"));
1279 exit(1);
1281 if (read_basic_state(&options))
1282 exit(1);
1283 goto run_rebase;
1285 case ACTION_SKIP: {
1286 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1288 rerere_clear(the_repository, &merge_rr);
1289 string_list_clear(&merge_rr, 1);
1290 ropts.flags = RESET_HEAD_HARD;
1291 if (reset_head(the_repository, &ropts) < 0)
1292 die(_("could not discard worktree changes"));
1293 remove_branch_state(the_repository, 0);
1294 if (read_basic_state(&options))
1295 exit(1);
1296 goto run_rebase;
1298 case ACTION_ABORT: {
1299 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1300 struct strbuf head_msg = STRBUF_INIT;
1302 rerere_clear(the_repository, &merge_rr);
1303 string_list_clear(&merge_rr, 1);
1305 if (read_basic_state(&options))
1306 exit(1);
1308 strbuf_addf(&head_msg, "%s (abort): returning to %s",
1309 options.reflog_action,
1310 options.head_name ? options.head_name
1311 : oid_to_hex(&options.orig_head->object.oid));
1312 ropts.oid = &options.orig_head->object.oid;
1313 ropts.head_msg = head_msg.buf;
1314 ropts.branch = options.head_name;
1315 ropts.flags = RESET_HEAD_HARD;
1316 if (reset_head(the_repository, &ropts) < 0)
1317 die(_("could not move back to %s"),
1318 oid_to_hex(&options.orig_head->object.oid));
1319 strbuf_release(&head_msg);
1320 remove_branch_state(the_repository, 0);
1321 ret = finish_rebase(&options);
1322 goto cleanup;
1324 case ACTION_QUIT: {
1325 save_autostash(state_dir_path("autostash", &options));
1326 if (options.type == REBASE_MERGE) {
1327 struct replay_opts replay = REPLAY_OPTS_INIT;
1329 replay.action = REPLAY_INTERACTIVE_REBASE;
1330 ret = sequencer_remove_state(&replay);
1331 replay_opts_release(&replay);
1332 } else {
1333 strbuf_reset(&buf);
1334 strbuf_addstr(&buf, options.state_dir);
1335 ret = remove_dir_recursively(&buf, 0);
1336 if (ret)
1337 error(_("could not remove '%s'"),
1338 options.state_dir);
1340 goto cleanup;
1342 case ACTION_EDIT_TODO:
1343 options.dont_finish_rebase = 1;
1344 goto run_rebase;
1345 case ACTION_SHOW_CURRENT_PATCH:
1346 options.dont_finish_rebase = 1;
1347 goto run_rebase;
1348 case ACTION_NONE:
1349 break;
1350 default:
1351 BUG("action: %d", options.action);
1354 /* Make sure no rebase is in progress */
1355 if (in_progress) {
1356 const char *last_slash = strrchr(options.state_dir, '/');
1357 const char *state_dir_base =
1358 last_slash ? last_slash + 1 : options.state_dir;
1359 const char *cmd_live_rebase =
1360 "git rebase (--continue | --abort | --skip)";
1361 strbuf_reset(&buf);
1362 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1363 die(_("It seems that there is already a %s directory, and\n"
1364 "I wonder if you are in the middle of another rebase. "
1365 "If that is the\n"
1366 "case, please try\n\t%s\n"
1367 "If that is not the case, please\n\t%s\n"
1368 "and run me again. I am stopping in case you still "
1369 "have something\n"
1370 "valuable there.\n"),
1371 state_dir_base, cmd_live_rebase, buf.buf);
1374 if ((options.flags & REBASE_INTERACTIVE_EXPLICIT) ||
1375 (options.action != ACTION_NONE) ||
1376 (options.exec.nr > 0) ||
1377 (options.autosquash == -1 && options.config_autosquash == 1) ||
1378 options.autosquash == 1) {
1379 allow_preemptive_ff = 0;
1381 if (options.committer_date_is_author_date || options.ignore_date)
1382 options.flags |= REBASE_FORCE;
1384 for (i = 0; i < options.git_am_opts.nr; i++) {
1385 const char *option = options.git_am_opts.v[i], *p;
1386 if (!strcmp(option, "--whitespace=fix") ||
1387 !strcmp(option, "--whitespace=strip"))
1388 allow_preemptive_ff = 0;
1389 else if (skip_prefix(option, "-C", &p)) {
1390 while (*p)
1391 if (!isdigit(*(p++)))
1392 die(_("switch `C' expects a "
1393 "numerical value"));
1394 } else if (skip_prefix(option, "--whitespace=", &p)) {
1395 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1396 strcmp(p, "error") && strcmp(p, "error-all"))
1397 die("Invalid whitespace option: '%s'", p);
1401 for (i = 0; i < options.exec.nr; i++)
1402 if (check_exec_cmd(options.exec.items[i].string))
1403 exit(1);
1405 if (!(options.flags & REBASE_NO_QUIET))
1406 strvec_push(&options.git_am_opts, "-q");
1408 if (options.empty != EMPTY_UNSPECIFIED)
1409 imply_merge(&options, "--empty");
1411 if (options.reapply_cherry_picks < 0)
1413 * We default to --no-reapply-cherry-picks unless
1414 * --keep-base is given; when --keep-base is given, we want
1415 * to default to --reapply-cherry-picks.
1417 options.reapply_cherry_picks = keep_base;
1418 else if (!keep_base)
1420 * The apply backend always searches for and drops cherry
1421 * picks. This is often not wanted with --keep-base, so
1422 * --keep-base allows --reapply-cherry-picks to be
1423 * simulated by altering the upstream such that
1424 * cherry-picks cannot be detected and thus all commits are
1425 * reapplied. Thus, --[no-]reapply-cherry-picks is
1426 * supported when --keep-base is specified, but not when
1427 * --keep-base is left out.
1429 imply_merge(&options, options.reapply_cherry_picks ?
1430 "--reapply-cherry-picks" :
1431 "--no-reapply-cherry-picks");
1433 if (gpg_sign)
1434 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1436 if (options.exec.nr)
1437 imply_merge(&options, "--exec");
1439 if (rebase_merges) {
1440 if (!*rebase_merges)
1441 ; /* default mode; do nothing */
1442 else if (!strcmp("rebase-cousins", rebase_merges))
1443 options.rebase_cousins = 1;
1444 else if (strcmp("no-rebase-cousins", rebase_merges))
1445 die(_("Unknown mode: %s"), rebase_merges);
1446 options.rebase_merges = 1;
1447 imply_merge(&options, "--rebase-merges");
1450 if (options.type == REBASE_APPLY) {
1451 if (ignore_whitespace)
1452 strvec_push(&options.git_am_opts,
1453 "--ignore-whitespace");
1454 if (options.committer_date_is_author_date)
1455 strvec_push(&options.git_am_opts,
1456 "--committer-date-is-author-date");
1457 if (options.ignore_date)
1458 strvec_push(&options.git_am_opts, "--ignore-date");
1459 } else {
1460 /* REBASE_MERGE */
1461 if (ignore_whitespace) {
1462 string_list_append(&strategy_options,
1463 "ignore-space-change");
1467 if (strategy_options.nr) {
1468 int i;
1470 if (!options.strategy)
1471 options.strategy = "ort";
1473 strbuf_reset(&buf);
1474 for (i = 0; i < strategy_options.nr; i++)
1475 strbuf_addf(&buf, " --%s",
1476 strategy_options.items[i].string);
1477 options.strategy_opts = xstrdup(buf.buf);
1480 if (options.strategy) {
1481 options.strategy = xstrdup(options.strategy);
1482 switch (options.type) {
1483 case REBASE_APPLY:
1484 die(_("--strategy requires --merge or --interactive"));
1485 case REBASE_MERGE:
1486 /* compatible */
1487 break;
1488 case REBASE_UNSPECIFIED:
1489 options.type = REBASE_MERGE;
1490 break;
1491 default:
1492 BUG("unhandled rebase type (%d)", options.type);
1496 if (options.type == REBASE_MERGE)
1497 imply_merge(&options, "--merge");
1499 if (options.root && !options.onto_name)
1500 imply_merge(&options, "--root without --onto");
1502 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1503 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1505 if (options.git_am_opts.nr || options.type == REBASE_APPLY) {
1506 /* all am options except -q are compatible only with --apply */
1507 for (i = options.git_am_opts.nr - 1; i >= 0; i--)
1508 if (strcmp(options.git_am_opts.v[i], "-q"))
1509 break;
1511 if (i >= 0 || options.type == REBASE_APPLY) {
1512 if (is_merge(&options))
1513 die(_("apply options and merge options "
1514 "cannot be used together"));
1515 else if (options.autosquash == -1 && options.config_autosquash == 1)
1516 die(_("apply options are incompatible with rebase.autosquash. Consider adding --no-autosquash"));
1517 else if (options.update_refs == -1 && options.config_update_refs == 1)
1518 die(_("apply options are incompatible with rebase.updateRefs. Consider adding --no-update-refs"));
1519 else
1520 options.type = REBASE_APPLY;
1524 if (options.update_refs == 1)
1525 imply_merge(&options, "--update-refs");
1526 options.update_refs = (options.update_refs >= 0) ? options.update_refs :
1527 ((options.config_update_refs >= 0) ? options.config_update_refs : 0);
1529 if (options.autosquash == 1)
1530 imply_merge(&options, "--autosquash");
1531 options.autosquash = (options.autosquash >= 0) ? options.autosquash :
1532 ((options.config_autosquash >= 0) ? options.config_autosquash : 0);
1534 if (options.type == REBASE_UNSPECIFIED) {
1535 if (!strcmp(options.default_backend, "merge"))
1536 imply_merge(&options, "--merge");
1537 else if (!strcmp(options.default_backend, "apply"))
1538 options.type = REBASE_APPLY;
1539 else
1540 die(_("Unknown rebase backend: %s"),
1541 options.default_backend);
1544 if (options.type == REBASE_MERGE &&
1545 !options.strategy &&
1546 getenv("GIT_TEST_MERGE_ALGORITHM"))
1547 options.strategy = xstrdup(getenv("GIT_TEST_MERGE_ALGORITHM"));
1549 switch (options.type) {
1550 case REBASE_MERGE:
1551 options.state_dir = merge_dir();
1552 break;
1553 case REBASE_APPLY:
1554 options.state_dir = apply_dir();
1555 break;
1556 default:
1557 BUG("options.type was just set above; should be unreachable.");
1560 if (options.empty == EMPTY_UNSPECIFIED) {
1561 if (options.flags & REBASE_INTERACTIVE_EXPLICIT)
1562 options.empty = EMPTY_ASK;
1563 else if (options.exec.nr > 0)
1564 options.empty = EMPTY_KEEP;
1565 else
1566 options.empty = EMPTY_DROP;
1568 if (reschedule_failed_exec > 0 && !is_merge(&options))
1569 die(_("--reschedule-failed-exec requires "
1570 "--exec or --interactive"));
1571 if (reschedule_failed_exec >= 0)
1572 options.reschedule_failed_exec = reschedule_failed_exec;
1574 if (options.signoff) {
1575 strvec_push(&options.git_am_opts, "--signoff");
1576 options.flags |= REBASE_FORCE;
1579 if (!options.root) {
1580 if (argc < 1) {
1581 struct branch *branch;
1583 branch = branch_get(NULL);
1584 options.upstream_name = branch_get_upstream(branch,
1585 NULL);
1586 if (!options.upstream_name)
1587 error_on_missing_default_upstream();
1588 if (options.fork_point < 0)
1589 options.fork_point = 1;
1590 } else {
1591 options.upstream_name = argv[0];
1592 argc--;
1593 argv++;
1594 if (!strcmp(options.upstream_name, "-"))
1595 options.upstream_name = "@{-1}";
1597 options.upstream =
1598 lookup_commit_reference_by_name(options.upstream_name);
1599 if (!options.upstream)
1600 die(_("invalid upstream '%s'"), options.upstream_name);
1601 options.upstream_arg = options.upstream_name;
1602 } else {
1603 if (!options.onto_name) {
1604 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1605 &squash_onto, NULL, NULL) < 0)
1606 die(_("Could not create new root commit"));
1607 options.squash_onto = &squash_onto;
1608 options.onto_name = squash_onto_name =
1609 xstrdup(oid_to_hex(&squash_onto));
1610 } else
1611 options.root_with_onto = 1;
1613 options.upstream_name = NULL;
1614 options.upstream = NULL;
1615 if (argc > 1)
1616 usage_with_options(builtin_rebase_usage,
1617 builtin_rebase_options);
1618 options.upstream_arg = "--root";
1622 * If the branch to rebase is given, that is the branch we will rebase
1623 * branch_name -- branch/commit being rebased, or
1624 * HEAD (already detached)
1625 * orig_head -- commit object name of tip of the branch before rebasing
1626 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1628 if (argc == 1) {
1629 /* Is it "rebase other branchname" or "rebase other commit"? */
1630 struct object_id branch_oid;
1631 branch_name = argv[0];
1632 options.switch_to = argv[0];
1634 /* Is it a local branch? */
1635 strbuf_reset(&buf);
1636 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1637 if (!read_ref(buf.buf, &branch_oid)) {
1638 die_if_checked_out(buf.buf, 1);
1639 options.head_name = xstrdup(buf.buf);
1640 options.orig_head =
1641 lookup_commit_object(the_repository,
1642 &branch_oid);
1643 /* If not is it a valid ref (branch or commit)? */
1644 } else {
1645 options.orig_head =
1646 lookup_commit_reference_by_name(branch_name);
1647 options.head_name = NULL;
1649 if (!options.orig_head)
1650 die(_("no such branch/commit '%s'"), branch_name);
1651 } else if (argc == 0) {
1652 /* Do not need to switch branches, we are already on it. */
1653 options.head_name =
1654 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1655 &flags));
1656 if (!options.head_name)
1657 die(_("No such ref: %s"), "HEAD");
1658 if (flags & REF_ISSYMREF) {
1659 if (!skip_prefix(options.head_name,
1660 "refs/heads/", &branch_name))
1661 branch_name = options.head_name;
1663 } else {
1664 FREE_AND_NULL(options.head_name);
1665 branch_name = "HEAD";
1667 options.orig_head = lookup_commit_reference_by_name("HEAD");
1668 if (!options.orig_head)
1669 die(_("Could not resolve HEAD to a commit"));
1670 } else
1671 BUG("unexpected number of arguments left to parse");
1673 /* Make sure the branch to rebase onto is valid. */
1674 if (keep_base) {
1675 strbuf_reset(&buf);
1676 strbuf_addstr(&buf, options.upstream_name);
1677 strbuf_addstr(&buf, "...");
1678 strbuf_addstr(&buf, branch_name);
1679 options.onto_name = keep_base_onto_name = xstrdup(buf.buf);
1680 } else if (!options.onto_name)
1681 options.onto_name = options.upstream_name;
1682 if (strstr(options.onto_name, "...")) {
1683 if (get_oid_mb(options.onto_name, &branch_base) < 0) {
1684 if (keep_base)
1685 die(_("'%s': need exactly one merge base with branch"),
1686 options.upstream_name);
1687 else
1688 die(_("'%s': need exactly one merge base"),
1689 options.onto_name);
1691 options.onto = lookup_commit_or_die(&branch_base,
1692 options.onto_name);
1693 } else {
1694 options.onto =
1695 lookup_commit_reference_by_name(options.onto_name);
1696 if (!options.onto)
1697 die(_("Does not point to a valid commit '%s'"),
1698 options.onto_name);
1699 fill_branch_base(&options, &branch_base);
1702 if (keep_base && options.reapply_cherry_picks)
1703 options.upstream = options.onto;
1705 if (options.fork_point > 0)
1706 options.restrict_revision =
1707 get_fork_point(options.upstream_name, options.orig_head);
1709 if (repo_read_index(the_repository) < 0)
1710 die(_("could not read index"));
1712 if (options.autostash)
1713 create_autostash(the_repository,
1714 state_dir_path("autostash", &options));
1717 if (require_clean_work_tree(the_repository, "rebase",
1718 _("Please commit or stash them."), 1, 1)) {
1719 ret = -1;
1720 goto cleanup;
1724 * Now we are rebasing commits upstream..orig_head (or with --root,
1725 * everything leading up to orig_head) on top of onto.
1729 * Check if we are already based on onto with linear history,
1730 * in which case we could fast-forward without replacing the commits
1731 * with new commits recreated by replaying their changes.
1733 if (allow_preemptive_ff &&
1734 can_fast_forward(options.onto, options.upstream, options.restrict_revision,
1735 options.orig_head, &branch_base)) {
1736 int flag;
1738 if (!(options.flags & REBASE_FORCE)) {
1739 /* Lazily switch to the target branch if needed... */
1740 if (options.switch_to) {
1741 ret = checkout_up_to_date(&options);
1742 if (ret)
1743 goto cleanup;
1746 if (!(options.flags & REBASE_NO_QUIET))
1747 ; /* be quiet */
1748 else if (!strcmp(branch_name, "HEAD") &&
1749 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1750 puts(_("HEAD is up to date."));
1751 else
1752 printf(_("Current branch %s is up to date.\n"),
1753 branch_name);
1754 ret = finish_rebase(&options);
1755 goto cleanup;
1756 } else if (!(options.flags & REBASE_NO_QUIET))
1757 ; /* be quiet */
1758 else if (!strcmp(branch_name, "HEAD") &&
1759 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1760 puts(_("HEAD is up to date, rebase forced."));
1761 else
1762 printf(_("Current branch %s is up to date, rebase "
1763 "forced.\n"), branch_name);
1766 /* If a hook exists, give it a chance to interrupt*/
1767 if (!ok_to_skip_pre_rebase &&
1768 run_hooks_l("pre-rebase", options.upstream_arg,
1769 argc ? argv[0] : NULL, NULL))
1770 die(_("The pre-rebase hook refused to rebase."));
1772 if (options.flags & REBASE_DIFFSTAT) {
1773 struct diff_options opts;
1775 if (options.flags & REBASE_VERBOSE) {
1776 if (is_null_oid(&branch_base))
1777 printf(_("Changes to %s:\n"),
1778 oid_to_hex(&options.onto->object.oid));
1779 else
1780 printf(_("Changes from %s to %s:\n"),
1781 oid_to_hex(&branch_base),
1782 oid_to_hex(&options.onto->object.oid));
1785 /* We want color (if set), but no pager */
1786 diff_setup(&opts);
1787 opts.stat_width = -1; /* use full terminal width */
1788 opts.stat_graph_width = -1; /* respect statGraphWidth config */
1789 opts.output_format |=
1790 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1791 opts.detect_rename = DIFF_DETECT_RENAME;
1792 diff_setup_done(&opts);
1793 diff_tree_oid(is_null_oid(&branch_base) ?
1794 the_hash_algo->empty_tree : &branch_base,
1795 &options.onto->object.oid, "", &opts);
1796 diffcore_std(&opts);
1797 diff_flush(&opts);
1800 if (is_merge(&options))
1801 goto run_rebase;
1803 /* Detach HEAD and reset the tree */
1804 if (options.flags & REBASE_NO_QUIET)
1805 printf(_("First, rewinding head to replay your work on top of "
1806 "it...\n"));
1808 strbuf_addf(&msg, "%s (start): checkout %s",
1809 options.reflog_action, options.onto_name);
1810 ropts.oid = &options.onto->object.oid;
1811 ropts.orig_head = &options.orig_head->object.oid,
1812 ropts.flags = RESET_HEAD_DETACH | RESET_ORIG_HEAD |
1813 RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
1814 ropts.head_msg = msg.buf;
1815 ropts.default_reflog_action = options.reflog_action;
1816 if (reset_head(the_repository, &ropts))
1817 die(_("Could not detach HEAD"));
1818 strbuf_release(&msg);
1821 * If the onto is a proper descendant of the tip of the branch, then
1822 * we just fast-forwarded.
1824 if (oideq(&branch_base, &options.orig_head->object.oid)) {
1825 printf(_("Fast-forwarded %s to %s.\n"),
1826 branch_name, options.onto_name);
1827 move_to_original_branch(&options);
1828 ret = finish_rebase(&options);
1829 goto cleanup;
1832 strbuf_addf(&revisions, "%s..%s",
1833 options.root ? oid_to_hex(&options.onto->object.oid) :
1834 (options.restrict_revision ?
1835 oid_to_hex(&options.restrict_revision->object.oid) :
1836 oid_to_hex(&options.upstream->object.oid)),
1837 oid_to_hex(&options.orig_head->object.oid));
1839 options.revisions = revisions.buf;
1841 run_rebase:
1842 ret = run_specific_rebase(&options);
1844 cleanup:
1845 strbuf_release(&buf);
1846 strbuf_release(&revisions);
1847 free(options.reflog_action);
1848 free(options.head_name);
1849 strvec_clear(&options.git_am_opts);
1850 free(options.gpg_sign_opt);
1851 string_list_clear(&options.exec, 0);
1852 free(options.strategy);
1853 free(options.strategy_opts);
1854 strbuf_release(&options.git_format_patch_opt);
1855 free(squash_onto_name);
1856 free(keep_base_onto_name);
1857 string_list_clear(&strategy_options, 0);
1858 return !!ret;