Merge branch 'sg/index-format-doc-update' into maint
[git/debian.git] / builtin / rebase.c
blob70aa7c842f34b2a8cfbdf2c33d3b699bbda0404c
1 /*
2 * "git rebase" builtin command
4 * Copyright (c) 2018 Pratik Karki
5 */
7 #define USE_THE_INDEX_COMPATIBILITY_MACROS
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 #define DEFAULT_REFLOG_ACTION "rebase"
35 static char const * const builtin_rebase_usage[] = {
36 N_("git rebase [-i] [options] [--exec <cmd>] "
37 "[--onto <newbase> | --keep-base] [<upstream> [<branch>]]"),
38 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
39 "--root [<branch>]"),
40 "git rebase --continue | --abort | --skip | --edit-todo",
41 NULL
44 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
45 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
46 static GIT_PATH_FUNC(apply_dir, "rebase-apply")
47 static GIT_PATH_FUNC(merge_dir, "rebase-merge")
49 enum rebase_type {
50 REBASE_UNSPECIFIED = -1,
51 REBASE_APPLY,
52 REBASE_MERGE
55 enum empty_type {
56 EMPTY_UNSPECIFIED = -1,
57 EMPTY_DROP,
58 EMPTY_KEEP,
59 EMPTY_ASK
62 struct rebase_options {
63 enum rebase_type type;
64 enum empty_type empty;
65 const char *default_backend;
66 const char *state_dir;
67 struct commit *upstream;
68 const char *upstream_name;
69 const char *upstream_arg;
70 char *head_name;
71 struct object_id orig_head;
72 struct commit *onto;
73 const char *onto_name;
74 const char *revisions;
75 const char *switch_to;
76 int root, root_with_onto;
77 struct object_id *squash_onto;
78 struct commit *restrict_revision;
79 int dont_finish_rebase;
80 enum {
81 REBASE_NO_QUIET = 1<<0,
82 REBASE_VERBOSE = 1<<1,
83 REBASE_DIFFSTAT = 1<<2,
84 REBASE_FORCE = 1<<3,
85 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
86 } flags;
87 struct strvec git_am_opts;
88 const char *action;
89 int signoff;
90 int allow_rerere_autoupdate;
91 int keep_empty;
92 int autosquash;
93 char *gpg_sign_opt;
94 int autostash;
95 int committer_date_is_author_date;
96 int ignore_date;
97 char *cmd;
98 int allow_empty_message;
99 int rebase_merges, rebase_cousins;
100 char *strategy, *strategy_opts;
101 struct strbuf git_format_patch_opt;
102 int reschedule_failed_exec;
103 int reapply_cherry_picks;
104 int fork_point;
107 #define REBASE_OPTIONS_INIT { \
108 .type = REBASE_UNSPECIFIED, \
109 .empty = EMPTY_UNSPECIFIED, \
110 .keep_empty = 1, \
111 .default_backend = "merge", \
112 .flags = REBASE_NO_QUIET, \
113 .git_am_opts = STRVEC_INIT, \
114 .git_format_patch_opt = STRBUF_INIT, \
115 .fork_point = -1, \
118 static struct replay_opts get_replay_opts(const struct rebase_options *opts)
120 struct replay_opts replay = REPLAY_OPTS_INIT;
122 replay.action = REPLAY_INTERACTIVE_REBASE;
123 replay.strategy = NULL;
124 sequencer_init_config(&replay);
126 replay.signoff = opts->signoff;
127 replay.allow_ff = !(opts->flags & REBASE_FORCE);
128 if (opts->allow_rerere_autoupdate)
129 replay.allow_rerere_auto = opts->allow_rerere_autoupdate;
130 replay.allow_empty = 1;
131 replay.allow_empty_message = opts->allow_empty_message;
132 replay.drop_redundant_commits = (opts->empty == EMPTY_DROP);
133 replay.keep_redundant_commits = (opts->empty == EMPTY_KEEP);
134 replay.quiet = !(opts->flags & REBASE_NO_QUIET);
135 replay.verbose = opts->flags & REBASE_VERBOSE;
136 replay.reschedule_failed_exec = opts->reschedule_failed_exec;
137 replay.committer_date_is_author_date =
138 opts->committer_date_is_author_date;
139 replay.ignore_date = opts->ignore_date;
140 replay.gpg_sign = xstrdup_or_null(opts->gpg_sign_opt);
141 if (opts->strategy)
142 replay.strategy = xstrdup_or_null(opts->strategy);
143 else if (!replay.strategy && replay.default_strategy) {
144 replay.strategy = replay.default_strategy;
145 replay.default_strategy = NULL;
148 if (opts->strategy_opts)
149 parse_strategy_opts(&replay, opts->strategy_opts);
151 if (opts->squash_onto) {
152 oidcpy(&replay.squash_onto, opts->squash_onto);
153 replay.have_squash_onto = 1;
156 return replay;
159 enum action {
160 ACTION_NONE = 0,
161 ACTION_CONTINUE,
162 ACTION_SKIP,
163 ACTION_ABORT,
164 ACTION_QUIT,
165 ACTION_EDIT_TODO,
166 ACTION_SHOW_CURRENT_PATCH
169 static const char *action_names[] = { "undefined",
170 "continue",
171 "skip",
172 "abort",
173 "quit",
174 "edit_todo",
175 "show_current_patch" };
177 static int edit_todo_file(unsigned flags)
179 const char *todo_file = rebase_path_todo();
180 struct todo_list todo_list = TODO_LIST_INIT,
181 new_todo = TODO_LIST_INIT;
182 int res = 0;
184 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
185 return error_errno(_("could not read '%s'."), todo_file);
187 strbuf_stripspace(&todo_list.buf, 1);
188 res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
189 if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
190 NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
191 res = error_errno(_("could not write '%s'"), todo_file);
193 todo_list_release(&todo_list);
194 todo_list_release(&new_todo);
196 return res;
199 static int get_revision_ranges(struct commit *upstream, struct commit *onto,
200 struct object_id *orig_head, char **revisions,
201 char **shortrevisions)
203 struct commit *base_rev = upstream ? upstream : onto;
204 const char *shorthead;
206 *revisions = xstrfmt("%s...%s", oid_to_hex(&base_rev->object.oid),
207 oid_to_hex(orig_head));
209 shorthead = find_unique_abbrev(orig_head, DEFAULT_ABBREV);
211 if (upstream) {
212 const char *shortrev;
214 shortrev = find_unique_abbrev(&base_rev->object.oid,
215 DEFAULT_ABBREV);
217 *shortrevisions = xstrfmt("%s..%s", shortrev, shorthead);
218 } else
219 *shortrevisions = xstrdup(shorthead);
221 return 0;
224 static int init_basic_state(struct replay_opts *opts, const char *head_name,
225 struct commit *onto,
226 const struct object_id *orig_head)
228 FILE *interactive;
230 if (!is_directory(merge_dir()) && mkdir_in_gitdir(merge_dir()))
231 return error_errno(_("could not create temporary %s"), merge_dir());
233 delete_reflog("REBASE_HEAD");
235 interactive = fopen(path_interactive(), "w");
236 if (!interactive)
237 return error_errno(_("could not mark as interactive"));
238 fclose(interactive);
240 return write_basic_state(opts, head_name, onto, orig_head);
243 static void split_exec_commands(const char *cmd, struct string_list *commands)
245 if (cmd && *cmd) {
246 string_list_split(commands, cmd, '\n', -1);
248 /* rebase.c adds a new line to cmd after every command,
249 * so here the last command is always empty */
250 string_list_remove_empty_items(commands, 0);
254 static int do_interactive_rebase(struct rebase_options *opts, unsigned flags)
256 int ret;
257 char *revisions = NULL, *shortrevisions = NULL;
258 struct strvec make_script_args = STRVEC_INIT;
259 struct todo_list todo_list = TODO_LIST_INIT;
260 struct replay_opts replay = get_replay_opts(opts);
261 struct string_list commands = STRING_LIST_INIT_DUP;
263 if (get_revision_ranges(opts->upstream, opts->onto, &opts->orig_head,
264 &revisions, &shortrevisions))
265 return -1;
267 if (init_basic_state(&replay,
268 opts->head_name ? opts->head_name : "detached HEAD",
269 opts->onto, &opts->orig_head)) {
270 free(revisions);
271 free(shortrevisions);
273 return -1;
276 if (!opts->upstream && opts->squash_onto)
277 write_file(path_squash_onto(), "%s\n",
278 oid_to_hex(opts->squash_onto));
280 strvec_pushl(&make_script_args, "", revisions, NULL);
281 if (opts->restrict_revision)
282 strvec_pushf(&make_script_args, "^%s",
283 oid_to_hex(&opts->restrict_revision->object.oid));
285 ret = sequencer_make_script(the_repository, &todo_list.buf,
286 make_script_args.nr, make_script_args.v,
287 flags);
289 if (ret)
290 error(_("could not generate todo list"));
291 else {
292 discard_cache();
293 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
294 &todo_list))
295 BUG("unusable todo list");
297 split_exec_commands(opts->cmd, &commands);
298 ret = complete_action(the_repository, &replay, flags,
299 shortrevisions, opts->onto_name, opts->onto,
300 &opts->orig_head, &commands, opts->autosquash,
301 &todo_list);
304 string_list_clear(&commands, 0);
305 free(revisions);
306 free(shortrevisions);
307 todo_list_release(&todo_list);
308 strvec_clear(&make_script_args);
310 return ret;
313 static int run_sequencer_rebase(struct rebase_options *opts,
314 enum action command)
316 unsigned flags = 0;
317 int abbreviate_commands = 0, ret = 0;
319 git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands);
321 flags |= opts->keep_empty ? TODO_LIST_KEEP_EMPTY : 0;
322 flags |= abbreviate_commands ? TODO_LIST_ABBREVIATE_CMDS : 0;
323 flags |= opts->rebase_merges ? TODO_LIST_REBASE_MERGES : 0;
324 flags |= opts->rebase_cousins > 0 ? TODO_LIST_REBASE_COUSINS : 0;
325 flags |= opts->root_with_onto ? TODO_LIST_ROOT_WITH_ONTO : 0;
326 flags |= opts->reapply_cherry_picks ? TODO_LIST_REAPPLY_CHERRY_PICKS : 0;
327 flags |= opts->flags & REBASE_NO_QUIET ? TODO_LIST_WARN_SKIPPED_CHERRY_PICKS : 0;
329 switch (command) {
330 case ACTION_NONE: {
331 if (!opts->onto && !opts->upstream)
332 die(_("a base commit must be provided with --upstream or --onto"));
334 ret = do_interactive_rebase(opts, flags);
335 break;
337 case ACTION_SKIP: {
338 struct string_list merge_rr = STRING_LIST_INIT_DUP;
340 rerere_clear(the_repository, &merge_rr);
342 /* fallthrough */
343 case ACTION_CONTINUE: {
344 struct replay_opts replay_opts = get_replay_opts(opts);
346 ret = sequencer_continue(the_repository, &replay_opts);
347 break;
349 case ACTION_EDIT_TODO:
350 ret = edit_todo_file(flags);
351 break;
352 case ACTION_SHOW_CURRENT_PATCH: {
353 struct child_process cmd = CHILD_PROCESS_INIT;
355 cmd.git_cmd = 1;
356 strvec_pushl(&cmd.args, "show", "REBASE_HEAD", "--", NULL);
357 ret = run_command(&cmd);
359 break;
361 default:
362 BUG("invalid command '%d'", command);
365 return ret;
368 static void imply_merge(struct rebase_options *opts, const char *option);
369 static int parse_opt_keep_empty(const struct option *opt, const char *arg,
370 int unset)
372 struct rebase_options *opts = opt->value;
374 BUG_ON_OPT_ARG(arg);
376 imply_merge(opts, unset ? "--no-keep-empty" : "--keep-empty");
377 opts->keep_empty = !unset;
378 opts->type = REBASE_MERGE;
379 return 0;
382 static int is_merge(struct rebase_options *opts)
384 return opts->type == REBASE_MERGE;
387 static void imply_merge(struct rebase_options *opts, const char *option)
389 switch (opts->type) {
390 case REBASE_APPLY:
391 die(_("%s requires the merge backend"), option);
392 break;
393 case REBASE_MERGE:
394 break;
395 default:
396 opts->type = REBASE_MERGE; /* implied */
397 break;
401 /* Returns the filename prefixed by the state_dir */
402 static const char *state_dir_path(const char *filename, struct rebase_options *opts)
404 static struct strbuf path = STRBUF_INIT;
405 static size_t prefix_len;
407 if (!prefix_len) {
408 strbuf_addf(&path, "%s/", opts->state_dir);
409 prefix_len = path.len;
412 strbuf_setlen(&path, prefix_len);
413 strbuf_addstr(&path, filename);
414 return path.buf;
417 /* Initialize the rebase options from the state directory. */
418 static int read_basic_state(struct rebase_options *opts)
420 struct strbuf head_name = STRBUF_INIT;
421 struct strbuf buf = STRBUF_INIT;
422 struct object_id oid;
424 if (!read_oneliner(&head_name, state_dir_path("head-name", opts),
425 READ_ONELINER_WARN_MISSING) ||
426 !read_oneliner(&buf, state_dir_path("onto", opts),
427 READ_ONELINER_WARN_MISSING))
428 return -1;
429 opts->head_name = starts_with(head_name.buf, "refs/") ?
430 xstrdup(head_name.buf) : NULL;
431 strbuf_release(&head_name);
432 if (get_oid(buf.buf, &oid))
433 return error(_("could not get 'onto': '%s'"), buf.buf);
434 opts->onto = lookup_commit_or_die(&oid, buf.buf);
437 * We always write to orig-head, but interactive rebase used to write to
438 * head. Fall back to reading from head to cover for the case that the
439 * user upgraded git with an ongoing interactive rebase.
441 strbuf_reset(&buf);
442 if (file_exists(state_dir_path("orig-head", opts))) {
443 if (!read_oneliner(&buf, state_dir_path("orig-head", opts),
444 READ_ONELINER_WARN_MISSING))
445 return -1;
446 } else if (!read_oneliner(&buf, state_dir_path("head", opts),
447 READ_ONELINER_WARN_MISSING))
448 return -1;
449 if (get_oid(buf.buf, &opts->orig_head))
450 return error(_("invalid orig-head: '%s'"), buf.buf);
452 if (file_exists(state_dir_path("quiet", opts)))
453 opts->flags &= ~REBASE_NO_QUIET;
454 else
455 opts->flags |= REBASE_NO_QUIET;
457 if (file_exists(state_dir_path("verbose", opts)))
458 opts->flags |= REBASE_VERBOSE;
460 if (file_exists(state_dir_path("signoff", opts))) {
461 opts->signoff = 1;
462 opts->flags |= REBASE_FORCE;
465 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
466 strbuf_reset(&buf);
467 if (!read_oneliner(&buf, state_dir_path("allow_rerere_autoupdate", opts),
468 READ_ONELINER_WARN_MISSING))
469 return -1;
470 if (!strcmp(buf.buf, "--rerere-autoupdate"))
471 opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
472 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
473 opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
474 else
475 warning(_("ignoring invalid allow_rerere_autoupdate: "
476 "'%s'"), buf.buf);
479 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
480 strbuf_reset(&buf);
481 if (!read_oneliner(&buf, state_dir_path("gpg_sign_opt", opts),
482 READ_ONELINER_WARN_MISSING))
483 return -1;
484 free(opts->gpg_sign_opt);
485 opts->gpg_sign_opt = xstrdup(buf.buf);
488 if (file_exists(state_dir_path("strategy", opts))) {
489 strbuf_reset(&buf);
490 if (!read_oneliner(&buf, state_dir_path("strategy", opts),
491 READ_ONELINER_WARN_MISSING))
492 return -1;
493 free(opts->strategy);
494 opts->strategy = xstrdup(buf.buf);
497 if (file_exists(state_dir_path("strategy_opts", opts))) {
498 strbuf_reset(&buf);
499 if (!read_oneliner(&buf, state_dir_path("strategy_opts", opts),
500 READ_ONELINER_WARN_MISSING))
501 return -1;
502 free(opts->strategy_opts);
503 opts->strategy_opts = xstrdup(buf.buf);
506 strbuf_release(&buf);
508 return 0;
511 static int rebase_write_basic_state(struct rebase_options *opts)
513 write_file(state_dir_path("head-name", opts), "%s",
514 opts->head_name ? opts->head_name : "detached HEAD");
515 write_file(state_dir_path("onto", opts), "%s",
516 opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
517 write_file(state_dir_path("orig-head", opts), "%s",
518 oid_to_hex(&opts->orig_head));
519 if (!(opts->flags & REBASE_NO_QUIET))
520 write_file(state_dir_path("quiet", opts), "%s", "");
521 if (opts->flags & REBASE_VERBOSE)
522 write_file(state_dir_path("verbose", opts), "%s", "");
523 if (opts->strategy)
524 write_file(state_dir_path("strategy", opts), "%s",
525 opts->strategy);
526 if (opts->strategy_opts)
527 write_file(state_dir_path("strategy_opts", opts), "%s",
528 opts->strategy_opts);
529 if (opts->allow_rerere_autoupdate > 0)
530 write_file(state_dir_path("allow_rerere_autoupdate", opts),
531 "-%s-rerere-autoupdate",
532 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
533 "" : "-no");
534 if (opts->gpg_sign_opt)
535 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
536 opts->gpg_sign_opt);
537 if (opts->signoff)
538 write_file(state_dir_path("signoff", opts), "--signoff");
540 return 0;
543 static int finish_rebase(struct rebase_options *opts)
545 struct strbuf dir = STRBUF_INIT;
546 int ret = 0;
548 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
549 unlink(git_path_auto_merge(the_repository));
550 apply_autostash(state_dir_path("autostash", opts));
552 * We ignore errors in 'git maintenance run --auto', since the
553 * user should see them.
555 run_auto_maintenance(!(opts->flags & (REBASE_NO_QUIET|REBASE_VERBOSE)));
556 if (opts->type == REBASE_MERGE) {
557 struct replay_opts replay = REPLAY_OPTS_INIT;
559 replay.action = REPLAY_INTERACTIVE_REBASE;
560 ret = sequencer_remove_state(&replay);
561 } else {
562 strbuf_addstr(&dir, opts->state_dir);
563 if (remove_dir_recursively(&dir, 0))
564 ret = error(_("could not remove '%s'"),
565 opts->state_dir);
566 strbuf_release(&dir);
569 return ret;
572 static int move_to_original_branch(struct rebase_options *opts)
574 struct strbuf branch_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
575 struct reset_head_opts ropts = { 0 };
576 int ret;
578 if (!opts->head_name)
579 return 0; /* nothing to move back to */
581 if (!opts->onto)
582 BUG("move_to_original_branch without onto");
584 strbuf_addf(&branch_reflog, "rebase finished: %s onto %s",
585 opts->head_name, oid_to_hex(&opts->onto->object.oid));
586 strbuf_addf(&head_reflog, "rebase finished: returning to %s",
587 opts->head_name);
588 ropts.branch = opts->head_name;
589 ropts.flags = RESET_HEAD_REFS_ONLY;
590 ropts.branch_msg = branch_reflog.buf;
591 ropts.head_msg = head_reflog.buf;
592 ret = reset_head(the_repository, &ropts);
594 strbuf_release(&branch_reflog);
595 strbuf_release(&head_reflog);
596 return ret;
599 static const char *resolvemsg =
600 N_("Resolve all conflicts manually, mark them as resolved with\n"
601 "\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
602 "You can instead skip this commit: run \"git rebase --skip\".\n"
603 "To abort and get back to the state before \"git rebase\", run "
604 "\"git rebase --abort\".");
606 static int run_am(struct rebase_options *opts)
608 struct child_process am = CHILD_PROCESS_INIT;
609 struct child_process format_patch = CHILD_PROCESS_INIT;
610 struct strbuf revisions = STRBUF_INIT;
611 int status;
612 char *rebased_patches;
614 am.git_cmd = 1;
615 strvec_push(&am.args, "am");
617 if (opts->action && !strcmp("continue", opts->action)) {
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 && !strcmp("skip", opts->action)) {
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 && !strcmp("show-current-patch", opts->action)) {
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));
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;
682 ropts.branch = opts->head_name;
683 ropts.default_reflog_action = DEFAULT_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, enum action action)
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, action);
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->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.reschedulefailedexec")) {
804 opts->reschedule_failed_exec = git_config_bool(var, value);
805 return 0;
808 if (!strcmp(var, "rebase.forkpoint")) {
809 opts->fork_point = git_config_bool(var, value) ? -1 : 0;
810 return 0;
813 if (!strcmp(var, "rebase.backend")) {
814 return git_config_string(&opts->default_backend, var, value);
817 return git_default_config(var, value, data);
820 static int checkout_up_to_date(struct rebase_options *options)
822 struct strbuf buf = STRBUF_INIT;
823 struct reset_head_opts ropts = { 0 };
824 int ret = 0;
826 strbuf_addf(&buf, "%s: checkout %s",
827 getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
828 options->switch_to);
829 ropts.oid = &options->orig_head;
830 ropts.branch = options->head_name;
831 ropts.flags = RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
832 if (!ropts.branch)
833 ropts.flags |= RESET_HEAD_DETACH;
834 ropts.head_msg = buf.buf;
835 if (reset_head(the_repository, &ropts) < 0)
836 ret = error(_("could not switch to %s"), options->switch_to);
837 strbuf_release(&buf);
839 return ret;
843 * Determines whether the commits in from..to are linear, i.e. contain
844 * no merge commits. This function *expects* `from` to be an ancestor of
845 * `to`.
847 static int is_linear_history(struct commit *from, struct commit *to)
849 while (to && to != from) {
850 parse_commit(to);
851 if (!to->parents)
852 return 1;
853 if (to->parents->next)
854 return 0;
855 to = to->parents->item;
857 return 1;
860 static int can_fast_forward(struct commit *onto, struct commit *upstream,
861 struct commit *restrict_revision,
862 struct object_id *head_oid, struct object_id *merge_base)
864 struct commit *head = lookup_commit(the_repository, head_oid);
865 struct commit_list *merge_bases = NULL;
866 int res = 0;
868 if (!head)
869 goto done;
871 merge_bases = get_merge_bases(onto, head);
872 if (!merge_bases || merge_bases->next) {
873 oidcpy(merge_base, null_oid());
874 goto done;
877 oidcpy(merge_base, &merge_bases->item->object.oid);
878 if (!oideq(merge_base, &onto->object.oid))
879 goto done;
881 if (restrict_revision && !oideq(&restrict_revision->object.oid, merge_base))
882 goto done;
884 if (!upstream)
885 goto done;
887 free_commit_list(merge_bases);
888 merge_bases = get_merge_bases(upstream, head);
889 if (!merge_bases || merge_bases->next)
890 goto done;
892 if (!oideq(&onto->object.oid, &merge_bases->item->object.oid))
893 goto done;
895 res = 1;
897 done:
898 free_commit_list(merge_bases);
899 return res && is_linear_history(onto, head);
902 static int parse_opt_am(const struct option *opt, const char *arg, int unset)
904 struct rebase_options *opts = opt->value;
906 BUG_ON_OPT_NEG(unset);
907 BUG_ON_OPT_ARG(arg);
909 opts->type = REBASE_APPLY;
911 return 0;
914 /* -i followed by -m is still -i */
915 static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
917 struct rebase_options *opts = opt->value;
919 BUG_ON_OPT_NEG(unset);
920 BUG_ON_OPT_ARG(arg);
922 if (!is_merge(opts))
923 opts->type = REBASE_MERGE;
925 return 0;
928 /* -i followed by -r is still explicitly interactive, but -r alone is not */
929 static int parse_opt_interactive(const struct option *opt, const char *arg,
930 int unset)
932 struct rebase_options *opts = opt->value;
934 BUG_ON_OPT_NEG(unset);
935 BUG_ON_OPT_ARG(arg);
937 opts->type = REBASE_MERGE;
938 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
940 return 0;
943 static enum empty_type parse_empty_value(const char *value)
945 if (!strcasecmp(value, "drop"))
946 return EMPTY_DROP;
947 else if (!strcasecmp(value, "keep"))
948 return EMPTY_KEEP;
949 else if (!strcasecmp(value, "ask"))
950 return EMPTY_ASK;
952 die(_("unrecognized empty type '%s'; valid values are \"drop\", \"keep\", and \"ask\"."), value);
955 static int parse_opt_empty(const struct option *opt, const char *arg, int unset)
957 struct rebase_options *options = opt->value;
958 enum empty_type value = parse_empty_value(arg);
960 BUG_ON_OPT_NEG(unset);
962 options->empty = value;
963 return 0;
966 static void NORETURN error_on_missing_default_upstream(void)
968 struct branch *current_branch = branch_get(NULL);
970 printf(_("%s\n"
971 "Please specify which branch you want to rebase against.\n"
972 "See git-rebase(1) for details.\n"
973 "\n"
974 " git rebase '<branch>'\n"
975 "\n"),
976 current_branch ? _("There is no tracking information for "
977 "the current branch.") :
978 _("You are not currently on a branch."));
980 if (current_branch) {
981 const char *remote = current_branch->remote_name;
983 if (!remote)
984 remote = _("<remote>");
986 printf(_("If you wish to set tracking information for this "
987 "branch you can do so with:\n"
988 "\n"
989 " git branch --set-upstream-to=%s/<branch> %s\n"
990 "\n"),
991 remote, current_branch->name);
993 exit(1);
996 static void set_reflog_action(struct rebase_options *options)
998 const char *env;
999 struct strbuf buf = STRBUF_INIT;
1001 if (!is_merge(options))
1002 return;
1004 env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
1005 if (env && strcmp("rebase", env))
1006 return; /* only override it if it is "rebase" */
1008 strbuf_addf(&buf, "rebase (%s)", options->action);
1009 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
1010 strbuf_release(&buf);
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 merge_base;
1036 int ignore_whitespace = 0;
1037 enum action action = ACTION_NONE;
1038 const char *gpg_sign = NULL;
1039 struct string_list exec = STRING_LIST_INIT_NODUP;
1040 const char *rebase_merges = NULL;
1041 struct string_list strategy_options = STRING_LIST_INIT_NODUP;
1042 struct object_id squash_onto;
1043 char *squash_onto_name = NULL;
1044 int reschedule_failed_exec = -1;
1045 int allow_preemptive_ff = 1;
1046 int preserve_merges_selected = 0;
1047 struct reset_head_opts ropts = { 0 };
1048 struct option builtin_rebase_options[] = {
1049 OPT_STRING(0, "onto", &options.onto_name,
1050 N_("revision"),
1051 N_("rebase onto given branch instead of upstream")),
1052 OPT_BOOL(0, "keep-base", &keep_base,
1053 N_("use the merge-base of upstream and branch as the current base")),
1054 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1055 N_("allow pre-rebase hook to run")),
1056 OPT_NEGBIT('q', "quiet", &options.flags,
1057 N_("be quiet. implies --no-stat"),
1058 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1059 OPT_BIT('v', "verbose", &options.flags,
1060 N_("display a diffstat of what changed upstream"),
1061 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1062 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1063 N_("do not show diffstat of what changed upstream"),
1064 PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
1065 OPT_BOOL(0, "signoff", &options.signoff,
1066 N_("add a Signed-off-by trailer to each commit")),
1067 OPT_BOOL(0, "committer-date-is-author-date",
1068 &options.committer_date_is_author_date,
1069 N_("make committer date match author date")),
1070 OPT_BOOL(0, "reset-author-date", &options.ignore_date,
1071 N_("ignore author date and use current date")),
1072 OPT_HIDDEN_BOOL(0, "ignore-date", &options.ignore_date,
1073 N_("synonym of --reset-author-date")),
1074 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1075 N_("passed to 'git apply'"), 0),
1076 OPT_BOOL(0, "ignore-whitespace", &ignore_whitespace,
1077 N_("ignore changes in whitespace")),
1078 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1079 N_("action"), N_("passed to 'git apply'"), 0),
1080 OPT_BIT('f', "force-rebase", &options.flags,
1081 N_("cherry-pick all commits, even if unchanged"),
1082 REBASE_FORCE),
1083 OPT_BIT(0, "no-ff", &options.flags,
1084 N_("cherry-pick all commits, even if unchanged"),
1085 REBASE_FORCE),
1086 OPT_CMDMODE(0, "continue", &action, N_("continue"),
1087 ACTION_CONTINUE),
1088 OPT_CMDMODE(0, "skip", &action,
1089 N_("skip current patch and continue"), ACTION_SKIP),
1090 OPT_CMDMODE(0, "abort", &action,
1091 N_("abort and check out the original branch"),
1092 ACTION_ABORT),
1093 OPT_CMDMODE(0, "quit", &action,
1094 N_("abort but keep HEAD where it is"), ACTION_QUIT),
1095 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
1096 "during an interactive rebase"), ACTION_EDIT_TODO),
1097 OPT_CMDMODE(0, "show-current-patch", &action,
1098 N_("show the patch file being applied or merged"),
1099 ACTION_SHOW_CURRENT_PATCH),
1100 OPT_CALLBACK_F(0, "apply", &options, NULL,
1101 N_("use apply strategies to rebase"),
1102 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1103 parse_opt_am),
1104 OPT_CALLBACK_F('m', "merge", &options, NULL,
1105 N_("use merging strategies to rebase"),
1106 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1107 parse_opt_merge),
1108 OPT_CALLBACK_F('i', "interactive", &options, NULL,
1109 N_("let the user edit the list of commits to rebase"),
1110 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1111 parse_opt_interactive),
1112 OPT_SET_INT_F('p', "preserve-merges", &preserve_merges_selected,
1113 N_("(REMOVED) was: try to recreate merges "
1114 "instead of ignoring them"),
1115 1, PARSE_OPT_HIDDEN),
1116 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
1117 OPT_CALLBACK_F(0, "empty", &options, "{drop,keep,ask}",
1118 N_("how to handle commits that become empty"),
1119 PARSE_OPT_NONEG, parse_opt_empty),
1120 OPT_CALLBACK_F('k', "keep-empty", &options, NULL,
1121 N_("keep commits which start empty"),
1122 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN,
1123 parse_opt_keep_empty),
1124 OPT_BOOL(0, "autosquash", &options.autosquash,
1125 N_("move commits that begin with "
1126 "squash!/fixup! under -i")),
1127 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1128 N_("GPG-sign commits"),
1129 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1130 OPT_AUTOSTASH(&options.autostash),
1131 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
1132 N_("add exec lines after each commit of the "
1133 "editable list")),
1134 OPT_BOOL_F(0, "allow-empty-message",
1135 &options.allow_empty_message,
1136 N_("allow rebasing commits with empty messages"),
1137 PARSE_OPT_HIDDEN),
1138 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1139 N_("mode"),
1140 N_("try to rebase merges instead of skipping them"),
1141 PARSE_OPT_OPTARG, NULL, (intptr_t)""},
1142 OPT_BOOL(0, "fork-point", &options.fork_point,
1143 N_("use 'merge-base --fork-point' to refine upstream")),
1144 OPT_STRING('s', "strategy", &options.strategy,
1145 N_("strategy"), N_("use the given merge strategy")),
1146 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1147 N_("option"),
1148 N_("pass the argument through to the merge "
1149 "strategy")),
1150 OPT_BOOL(0, "root", &options.root,
1151 N_("rebase all reachable commits up to the root(s)")),
1152 OPT_BOOL(0, "reschedule-failed-exec",
1153 &reschedule_failed_exec,
1154 N_("automatically re-schedule any `exec` that fails")),
1155 OPT_BOOL(0, "reapply-cherry-picks", &options.reapply_cherry_picks,
1156 N_("apply all changes, even those already present upstream")),
1157 OPT_END(),
1159 int i;
1161 if (argc == 2 && !strcmp(argv[1], "-h"))
1162 usage_with_options(builtin_rebase_usage,
1163 builtin_rebase_options);
1165 prepare_repo_settings(the_repository);
1166 the_repository->settings.command_requires_full_index = 0;
1168 options.allow_empty_message = 1;
1169 git_config(rebase_config, &options);
1170 /* options.gpg_sign_opt will be either "-S" or NULL */
1171 gpg_sign = options.gpg_sign_opt ? "" : NULL;
1172 FREE_AND_NULL(options.gpg_sign_opt);
1174 strbuf_reset(&buf);
1175 strbuf_addf(&buf, "%s/applying", apply_dir());
1176 if(file_exists(buf.buf))
1177 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1179 if (is_directory(apply_dir())) {
1180 options.type = REBASE_APPLY;
1181 options.state_dir = apply_dir();
1182 } else if (is_directory(merge_dir())) {
1183 strbuf_reset(&buf);
1184 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1185 if (!(action == ACTION_ABORT) && is_directory(buf.buf)) {
1186 die(_("`rebase --preserve-merges` (-p) is no longer supported.\n"
1187 "Use `git rebase --abort` to terminate current rebase.\n"
1188 "Or downgrade to v2.33, or earlier, to complete the rebase."));
1189 } else {
1190 strbuf_reset(&buf);
1191 strbuf_addf(&buf, "%s/interactive", merge_dir());
1192 options.type = REBASE_MERGE;
1193 if (file_exists(buf.buf))
1194 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1196 options.state_dir = merge_dir();
1199 if (options.type != REBASE_UNSPECIFIED)
1200 in_progress = 1;
1202 total_argc = argc;
1203 argc = parse_options(argc, argv, prefix,
1204 builtin_rebase_options,
1205 builtin_rebase_usage, 0);
1207 if (preserve_merges_selected)
1208 die(_("--preserve-merges was replaced by --rebase-merges\n"
1209 "Note: Your `pull.rebase` configuration may also be set to 'preserve',\n"
1210 "which is no longer supported; use 'merges' instead"));
1212 if (action != ACTION_NONE && total_argc != 2) {
1213 usage_with_options(builtin_rebase_usage,
1214 builtin_rebase_options);
1217 if (argc > 2)
1218 usage_with_options(builtin_rebase_usage,
1219 builtin_rebase_options);
1221 if (keep_base) {
1222 if (options.onto_name)
1223 die(_("options '%s' and '%s' cannot be used together"), "--keep-base", "--onto");
1224 if (options.root)
1225 die(_("options '%s' and '%s' cannot be used together"), "--keep-base", "--root");
1228 if (options.root && options.fork_point > 0)
1229 die(_("options '%s' and '%s' cannot be used together"), "--root", "--fork-point");
1231 if (action != ACTION_NONE && !in_progress)
1232 die(_("No rebase in progress?"));
1233 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
1235 if (action == ACTION_EDIT_TODO && !is_merge(&options))
1236 die(_("The --edit-todo action can only be used during "
1237 "interactive rebase."));
1239 if (trace2_is_enabled()) {
1240 if (is_merge(&options))
1241 trace2_cmd_mode("interactive");
1242 else if (exec.nr)
1243 trace2_cmd_mode("interactive-exec");
1244 else
1245 trace2_cmd_mode(action_names[action]);
1248 switch (action) {
1249 case ACTION_CONTINUE: {
1250 struct object_id head;
1251 struct lock_file lock_file = LOCK_INIT;
1252 int fd;
1254 options.action = "continue";
1255 set_reflog_action(&options);
1257 /* Sanity check */
1258 if (get_oid("HEAD", &head))
1259 die(_("Cannot read HEAD"));
1261 fd = hold_locked_index(&lock_file, 0);
1262 if (repo_read_index(the_repository) < 0)
1263 die(_("could not read index"));
1264 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1265 NULL);
1266 if (0 <= fd)
1267 repo_update_index_if_able(the_repository, &lock_file);
1268 rollback_lock_file(&lock_file);
1270 if (has_unstaged_changes(the_repository, 1)) {
1271 puts(_("You must edit all merge conflicts and then\n"
1272 "mark them as resolved using git add"));
1273 exit(1);
1275 if (read_basic_state(&options))
1276 exit(1);
1277 goto run_rebase;
1279 case ACTION_SKIP: {
1280 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1282 options.action = "skip";
1283 set_reflog_action(&options);
1285 rerere_clear(the_repository, &merge_rr);
1286 string_list_clear(&merge_rr, 1);
1287 ropts.flags = RESET_HEAD_HARD;
1288 if (reset_head(the_repository, &ropts) < 0)
1289 die(_("could not discard worktree changes"));
1290 remove_branch_state(the_repository, 0);
1291 if (read_basic_state(&options))
1292 exit(1);
1293 goto run_rebase;
1295 case ACTION_ABORT: {
1296 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1297 options.action = "abort";
1298 set_reflog_action(&options);
1300 rerere_clear(the_repository, &merge_rr);
1301 string_list_clear(&merge_rr, 1);
1303 if (read_basic_state(&options))
1304 exit(1);
1305 ropts.oid = &options.orig_head;
1306 ropts.branch = options.head_name;
1307 ropts.flags = RESET_HEAD_HARD;
1308 ropts.default_reflog_action = DEFAULT_REFLOG_ACTION;
1309 if (reset_head(the_repository, &ropts) < 0)
1310 die(_("could not move back to %s"),
1311 oid_to_hex(&options.orig_head));
1312 remove_branch_state(the_repository, 0);
1313 ret = finish_rebase(&options);
1314 goto cleanup;
1316 case ACTION_QUIT: {
1317 save_autostash(state_dir_path("autostash", &options));
1318 if (options.type == REBASE_MERGE) {
1319 struct replay_opts replay = REPLAY_OPTS_INIT;
1321 replay.action = REPLAY_INTERACTIVE_REBASE;
1322 ret = sequencer_remove_state(&replay);
1323 } else {
1324 strbuf_reset(&buf);
1325 strbuf_addstr(&buf, options.state_dir);
1326 ret = remove_dir_recursively(&buf, 0);
1327 if (ret)
1328 error(_("could not remove '%s'"),
1329 options.state_dir);
1331 goto cleanup;
1333 case ACTION_EDIT_TODO:
1334 options.action = "edit-todo";
1335 options.dont_finish_rebase = 1;
1336 goto run_rebase;
1337 case ACTION_SHOW_CURRENT_PATCH:
1338 options.action = "show-current-patch";
1339 options.dont_finish_rebase = 1;
1340 goto run_rebase;
1341 case ACTION_NONE:
1342 break;
1343 default:
1344 BUG("action: %d", action);
1347 /* Make sure no rebase is in progress */
1348 if (in_progress) {
1349 const char *last_slash = strrchr(options.state_dir, '/');
1350 const char *state_dir_base =
1351 last_slash ? last_slash + 1 : options.state_dir;
1352 const char *cmd_live_rebase =
1353 "git rebase (--continue | --abort | --skip)";
1354 strbuf_reset(&buf);
1355 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1356 die(_("It seems that there is already a %s directory, and\n"
1357 "I wonder if you are in the middle of another rebase. "
1358 "If that is the\n"
1359 "case, please try\n\t%s\n"
1360 "If that is not the case, please\n\t%s\n"
1361 "and run me again. I am stopping in case you still "
1362 "have something\n"
1363 "valuable there.\n"),
1364 state_dir_base, cmd_live_rebase, buf.buf);
1367 if ((options.flags & REBASE_INTERACTIVE_EXPLICIT) ||
1368 (action != ACTION_NONE) ||
1369 (exec.nr > 0) ||
1370 options.autosquash) {
1371 allow_preemptive_ff = 0;
1373 if (options.committer_date_is_author_date || options.ignore_date)
1374 options.flags |= REBASE_FORCE;
1376 for (i = 0; i < options.git_am_opts.nr; i++) {
1377 const char *option = options.git_am_opts.v[i], *p;
1378 if (!strcmp(option, "--whitespace=fix") ||
1379 !strcmp(option, "--whitespace=strip"))
1380 allow_preemptive_ff = 0;
1381 else if (skip_prefix(option, "-C", &p)) {
1382 while (*p)
1383 if (!isdigit(*(p++)))
1384 die(_("switch `C' expects a "
1385 "numerical value"));
1386 } else if (skip_prefix(option, "--whitespace=", &p)) {
1387 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1388 strcmp(p, "error") && strcmp(p, "error-all"))
1389 die("Invalid whitespace option: '%s'", p);
1393 for (i = 0; i < exec.nr; i++)
1394 if (check_exec_cmd(exec.items[i].string))
1395 exit(1);
1397 if (!(options.flags & REBASE_NO_QUIET))
1398 strvec_push(&options.git_am_opts, "-q");
1400 if (options.empty != EMPTY_UNSPECIFIED)
1401 imply_merge(&options, "--empty");
1403 if (options.reapply_cherry_picks)
1404 imply_merge(&options, "--reapply-cherry-picks");
1406 if (gpg_sign)
1407 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1409 if (exec.nr) {
1410 int i;
1412 imply_merge(&options, "--exec");
1414 strbuf_reset(&buf);
1415 for (i = 0; i < exec.nr; i++)
1416 strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1417 options.cmd = xstrdup(buf.buf);
1420 if (rebase_merges) {
1421 if (!*rebase_merges)
1422 ; /* default mode; do nothing */
1423 else if (!strcmp("rebase-cousins", rebase_merges))
1424 options.rebase_cousins = 1;
1425 else if (strcmp("no-rebase-cousins", rebase_merges))
1426 die(_("Unknown mode: %s"), rebase_merges);
1427 options.rebase_merges = 1;
1428 imply_merge(&options, "--rebase-merges");
1431 if (options.type == REBASE_APPLY) {
1432 if (ignore_whitespace)
1433 strvec_push(&options.git_am_opts,
1434 "--ignore-whitespace");
1435 if (options.committer_date_is_author_date)
1436 strvec_push(&options.git_am_opts,
1437 "--committer-date-is-author-date");
1438 if (options.ignore_date)
1439 strvec_push(&options.git_am_opts, "--ignore-date");
1440 } else {
1441 /* REBASE_MERGE */
1442 if (ignore_whitespace) {
1443 string_list_append(&strategy_options,
1444 "ignore-space-change");
1448 if (strategy_options.nr) {
1449 int i;
1451 if (!options.strategy)
1452 options.strategy = "ort";
1454 strbuf_reset(&buf);
1455 for (i = 0; i < strategy_options.nr; i++)
1456 strbuf_addf(&buf, " --%s",
1457 strategy_options.items[i].string);
1458 options.strategy_opts = xstrdup(buf.buf);
1461 if (options.strategy) {
1462 options.strategy = xstrdup(options.strategy);
1463 switch (options.type) {
1464 case REBASE_APPLY:
1465 die(_("--strategy requires --merge or --interactive"));
1466 case REBASE_MERGE:
1467 /* compatible */
1468 break;
1469 case REBASE_UNSPECIFIED:
1470 options.type = REBASE_MERGE;
1471 break;
1472 default:
1473 BUG("unhandled rebase type (%d)", options.type);
1477 if (options.type == REBASE_MERGE)
1478 imply_merge(&options, "--merge");
1480 if (options.root && !options.onto_name)
1481 imply_merge(&options, "--root without --onto");
1483 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1484 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1486 if (options.git_am_opts.nr || options.type == REBASE_APPLY) {
1487 /* all am options except -q are compatible only with --apply */
1488 for (i = options.git_am_opts.nr - 1; i >= 0; i--)
1489 if (strcmp(options.git_am_opts.v[i], "-q"))
1490 break;
1492 if (i >= 0) {
1493 if (is_merge(&options))
1494 die(_("apply options and merge options "
1495 "cannot be used together"));
1496 else
1497 options.type = REBASE_APPLY;
1501 if (options.type == REBASE_UNSPECIFIED) {
1502 if (!strcmp(options.default_backend, "merge"))
1503 imply_merge(&options, "--merge");
1504 else if (!strcmp(options.default_backend, "apply"))
1505 options.type = REBASE_APPLY;
1506 else
1507 die(_("Unknown rebase backend: %s"),
1508 options.default_backend);
1511 if (options.type == REBASE_MERGE &&
1512 !options.strategy &&
1513 getenv("GIT_TEST_MERGE_ALGORITHM"))
1514 options.strategy = xstrdup(getenv("GIT_TEST_MERGE_ALGORITHM"));
1516 switch (options.type) {
1517 case REBASE_MERGE:
1518 options.state_dir = merge_dir();
1519 break;
1520 case REBASE_APPLY:
1521 options.state_dir = apply_dir();
1522 break;
1523 default:
1524 BUG("options.type was just set above; should be unreachable.");
1527 if (options.empty == EMPTY_UNSPECIFIED) {
1528 if (options.flags & REBASE_INTERACTIVE_EXPLICIT)
1529 options.empty = EMPTY_ASK;
1530 else if (exec.nr > 0)
1531 options.empty = EMPTY_KEEP;
1532 else
1533 options.empty = EMPTY_DROP;
1535 if (reschedule_failed_exec > 0 && !is_merge(&options))
1536 die(_("--reschedule-failed-exec requires "
1537 "--exec or --interactive"));
1538 if (reschedule_failed_exec >= 0)
1539 options.reschedule_failed_exec = reschedule_failed_exec;
1541 if (options.signoff) {
1542 strvec_push(&options.git_am_opts, "--signoff");
1543 options.flags |= REBASE_FORCE;
1546 if (!options.root) {
1547 if (argc < 1) {
1548 struct branch *branch;
1550 branch = branch_get(NULL);
1551 options.upstream_name = branch_get_upstream(branch,
1552 NULL);
1553 if (!options.upstream_name)
1554 error_on_missing_default_upstream();
1555 if (options.fork_point < 0)
1556 options.fork_point = 1;
1557 } else {
1558 options.upstream_name = argv[0];
1559 argc--;
1560 argv++;
1561 if (!strcmp(options.upstream_name, "-"))
1562 options.upstream_name = "@{-1}";
1564 options.upstream =
1565 lookup_commit_reference_by_name(options.upstream_name);
1566 if (!options.upstream)
1567 die(_("invalid upstream '%s'"), options.upstream_name);
1568 options.upstream_arg = options.upstream_name;
1569 } else {
1570 if (!options.onto_name) {
1571 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1572 &squash_onto, NULL, NULL) < 0)
1573 die(_("Could not create new root commit"));
1574 options.squash_onto = &squash_onto;
1575 options.onto_name = squash_onto_name =
1576 xstrdup(oid_to_hex(&squash_onto));
1577 } else
1578 options.root_with_onto = 1;
1580 options.upstream_name = NULL;
1581 options.upstream = NULL;
1582 if (argc > 1)
1583 usage_with_options(builtin_rebase_usage,
1584 builtin_rebase_options);
1585 options.upstream_arg = "--root";
1589 * If the branch to rebase is given, that is the branch we will rebase
1590 * branch_name -- branch/commit being rebased, or
1591 * HEAD (already detached)
1592 * orig_head -- commit object name of tip of the branch before rebasing
1593 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1595 if (argc == 1) {
1596 /* Is it "rebase other branchname" or "rebase other commit"? */
1597 branch_name = argv[0];
1598 options.switch_to = argv[0];
1600 /* Is it a local branch? */
1601 strbuf_reset(&buf);
1602 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1603 if (!read_ref(buf.buf, &options.orig_head)) {
1604 die_if_checked_out(buf.buf, 1);
1605 options.head_name = xstrdup(buf.buf);
1606 /* If not is it a valid ref (branch or commit)? */
1607 } else {
1608 struct commit *commit =
1609 lookup_commit_reference_by_name(branch_name);
1610 if (!commit)
1611 die(_("no such branch/commit '%s'"),
1612 branch_name);
1613 oidcpy(&options.orig_head, &commit->object.oid);
1614 options.head_name = NULL;
1616 } else if (argc == 0) {
1617 /* Do not need to switch branches, we are already on it. */
1618 options.head_name =
1619 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1620 &flags));
1621 if (!options.head_name)
1622 die(_("No such ref: %s"), "HEAD");
1623 if (flags & REF_ISSYMREF) {
1624 if (!skip_prefix(options.head_name,
1625 "refs/heads/", &branch_name))
1626 branch_name = options.head_name;
1628 } else {
1629 FREE_AND_NULL(options.head_name);
1630 branch_name = "HEAD";
1632 if (get_oid("HEAD", &options.orig_head))
1633 die(_("Could not resolve HEAD to a revision"));
1634 } else
1635 BUG("unexpected number of arguments left to parse");
1637 /* Make sure the branch to rebase onto is valid. */
1638 if (keep_base) {
1639 strbuf_reset(&buf);
1640 strbuf_addstr(&buf, options.upstream_name);
1641 strbuf_addstr(&buf, "...");
1642 strbuf_addstr(&buf, branch_name);
1643 options.onto_name = xstrdup(buf.buf);
1644 } else if (!options.onto_name)
1645 options.onto_name = options.upstream_name;
1646 if (strstr(options.onto_name, "...")) {
1647 if (get_oid_mb(options.onto_name, &merge_base) < 0) {
1648 if (keep_base)
1649 die(_("'%s': need exactly one merge base with branch"),
1650 options.upstream_name);
1651 else
1652 die(_("'%s': need exactly one merge base"),
1653 options.onto_name);
1655 options.onto = lookup_commit_or_die(&merge_base,
1656 options.onto_name);
1657 } else {
1658 options.onto =
1659 lookup_commit_reference_by_name(options.onto_name);
1660 if (!options.onto)
1661 die(_("Does not point to a valid commit '%s'"),
1662 options.onto_name);
1665 if (options.fork_point > 0) {
1666 struct commit *head =
1667 lookup_commit_reference(the_repository,
1668 &options.orig_head);
1669 options.restrict_revision =
1670 get_fork_point(options.upstream_name, head);
1673 if (repo_read_index(the_repository) < 0)
1674 die(_("could not read index"));
1676 if (options.autostash)
1677 create_autostash(the_repository,
1678 state_dir_path("autostash", &options));
1681 if (require_clean_work_tree(the_repository, "rebase",
1682 _("Please commit or stash them."), 1, 1)) {
1683 ret = -1;
1684 goto cleanup;
1688 * Now we are rebasing commits upstream..orig_head (or with --root,
1689 * everything leading up to orig_head) on top of onto.
1693 * Check if we are already based on onto with linear history,
1694 * in which case we could fast-forward without replacing the commits
1695 * with new commits recreated by replaying their changes.
1697 * Note that can_fast_forward() initializes merge_base, so we have to
1698 * call it before checking allow_preemptive_ff.
1700 if (can_fast_forward(options.onto, options.upstream, options.restrict_revision,
1701 &options.orig_head, &merge_base) &&
1702 allow_preemptive_ff) {
1703 int flag;
1705 if (!(options.flags & REBASE_FORCE)) {
1706 /* Lazily switch to the target branch if needed... */
1707 if (options.switch_to) {
1708 ret = checkout_up_to_date(&options);
1709 if (ret)
1710 goto cleanup;
1713 if (!(options.flags & REBASE_NO_QUIET))
1714 ; /* be quiet */
1715 else if (!strcmp(branch_name, "HEAD") &&
1716 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1717 puts(_("HEAD is up to date."));
1718 else
1719 printf(_("Current branch %s is up to date.\n"),
1720 branch_name);
1721 ret = finish_rebase(&options);
1722 goto cleanup;
1723 } else if (!(options.flags & REBASE_NO_QUIET))
1724 ; /* be quiet */
1725 else if (!strcmp(branch_name, "HEAD") &&
1726 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1727 puts(_("HEAD is up to date, rebase forced."));
1728 else
1729 printf(_("Current branch %s is up to date, rebase "
1730 "forced.\n"), branch_name);
1733 /* If a hook exists, give it a chance to interrupt*/
1734 if (!ok_to_skip_pre_rebase &&
1735 run_hooks_l("pre-rebase", options.upstream_arg,
1736 argc ? argv[0] : NULL, NULL))
1737 die(_("The pre-rebase hook refused to rebase."));
1739 if (options.flags & REBASE_DIFFSTAT) {
1740 struct diff_options opts;
1742 if (options.flags & REBASE_VERBOSE) {
1743 if (is_null_oid(&merge_base))
1744 printf(_("Changes to %s:\n"),
1745 oid_to_hex(&options.onto->object.oid));
1746 else
1747 printf(_("Changes from %s to %s:\n"),
1748 oid_to_hex(&merge_base),
1749 oid_to_hex(&options.onto->object.oid));
1752 /* We want color (if set), but no pager */
1753 diff_setup(&opts);
1754 opts.stat_width = -1; /* use full terminal width */
1755 opts.stat_graph_width = -1; /* respect statGraphWidth config */
1756 opts.output_format |=
1757 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1758 opts.detect_rename = DIFF_DETECT_RENAME;
1759 diff_setup_done(&opts);
1760 diff_tree_oid(is_null_oid(&merge_base) ?
1761 the_hash_algo->empty_tree : &merge_base,
1762 &options.onto->object.oid, "", &opts);
1763 diffcore_std(&opts);
1764 diff_flush(&opts);
1767 if (is_merge(&options))
1768 goto run_rebase;
1770 /* Detach HEAD and reset the tree */
1771 if (options.flags & REBASE_NO_QUIET)
1772 printf(_("First, rewinding head to replay your work on top of "
1773 "it...\n"));
1775 strbuf_addf(&msg, "%s: checkout %s",
1776 getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
1777 ropts.oid = &options.onto->object.oid;
1778 ropts.orig_head = &options.orig_head,
1779 ropts.flags = RESET_HEAD_DETACH | RESET_ORIG_HEAD |
1780 RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
1781 ropts.head_msg = msg.buf;
1782 ropts.default_reflog_action = DEFAULT_REFLOG_ACTION;
1783 if (reset_head(the_repository, &ropts))
1784 die(_("Could not detach HEAD"));
1785 strbuf_release(&msg);
1788 * If the onto is a proper descendant of the tip of the branch, then
1789 * we just fast-forwarded.
1791 strbuf_reset(&msg);
1792 if (oideq(&merge_base, &options.orig_head)) {
1793 printf(_("Fast-forwarded %s to %s.\n"),
1794 branch_name, options.onto_name);
1795 strbuf_addf(&msg, "rebase finished: %s onto %s",
1796 options.head_name ? options.head_name : "detached HEAD",
1797 oid_to_hex(&options.onto->object.oid));
1798 memset(&ropts, 0, sizeof(ropts));
1799 ropts.branch = options.head_name;
1800 ropts.flags = RESET_HEAD_REFS_ONLY;
1801 ropts.head_msg = msg.buf;
1802 reset_head(the_repository, &ropts);
1803 strbuf_release(&msg);
1804 ret = finish_rebase(&options);
1805 goto cleanup;
1808 strbuf_addf(&revisions, "%s..%s",
1809 options.root ? oid_to_hex(&options.onto->object.oid) :
1810 (options.restrict_revision ?
1811 oid_to_hex(&options.restrict_revision->object.oid) :
1812 oid_to_hex(&options.upstream->object.oid)),
1813 oid_to_hex(&options.orig_head));
1815 options.revisions = revisions.buf;
1817 run_rebase:
1818 ret = run_specific_rebase(&options, action);
1820 cleanup:
1821 strbuf_release(&buf);
1822 strbuf_release(&revisions);
1823 free(options.head_name);
1824 free(options.gpg_sign_opt);
1825 free(options.cmd);
1826 free(options.strategy);
1827 strbuf_release(&options.git_format_patch_opt);
1828 free(squash_onto_name);
1829 return !!ret;