reset: extract reset_head() from rebase
[git/debian.git] / builtin / rebase.c
blob48ef36bd109a00e54f4512d028cc7caccdb271a7
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 "argv-array.h"
12 #include "dir.h"
13 #include "packfile.h"
14 #include "refs.h"
15 #include "quote.h"
16 #include "config.h"
17 #include "cache-tree.h"
18 #include "unpack-trees.h"
19 #include "lockfile.h"
20 #include "parse-options.h"
21 #include "commit.h"
22 #include "diff.h"
23 #include "wt-status.h"
24 #include "revision.h"
25 #include "commit-reach.h"
26 #include "rerere.h"
27 #include "branch.h"
28 #include "sequencer.h"
29 #include "rebase-interactive.h"
30 #include "reset.h"
32 #define DEFAULT_REFLOG_ACTION "rebase"
34 static char const * const builtin_rebase_usage[] = {
35 N_("git rebase [-i] [options] [--exec <cmd>] "
36 "[--onto <newbase> | --keep-base] [<upstream> [<branch>]]"),
37 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
38 "--root [<branch>]"),
39 N_("git rebase --continue | --abort | --skip | --edit-todo"),
40 NULL
43 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
44 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
45 static GIT_PATH_FUNC(apply_dir, "rebase-apply")
46 static GIT_PATH_FUNC(merge_dir, "rebase-merge")
48 enum rebase_type {
49 REBASE_UNSPECIFIED = -1,
50 REBASE_APPLY,
51 REBASE_MERGE,
52 REBASE_PRESERVE_MERGES
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 argv_array git_am_opts;
88 const char *action;
89 int signoff;
90 int allow_rerere_autoupdate;
91 int autosquash;
92 char *gpg_sign_opt;
93 int autostash;
94 char *cmd;
95 int allow_empty_message;
96 int rebase_merges, rebase_cousins;
97 char *strategy, *strategy_opts;
98 struct strbuf git_format_patch_opt;
99 int reschedule_failed_exec;
100 int use_legacy_rebase;
103 #define REBASE_OPTIONS_INIT { \
104 .type = REBASE_UNSPECIFIED, \
105 .empty = EMPTY_UNSPECIFIED, \
106 .default_backend = "merge", \
107 .flags = REBASE_NO_QUIET, \
108 .git_am_opts = ARGV_ARRAY_INIT, \
109 .git_format_patch_opt = STRBUF_INIT \
112 static struct replay_opts get_replay_opts(const struct rebase_options *opts)
114 struct replay_opts replay = REPLAY_OPTS_INIT;
116 replay.action = REPLAY_INTERACTIVE_REBASE;
117 sequencer_init_config(&replay);
119 replay.signoff = opts->signoff;
120 replay.allow_ff = !(opts->flags & REBASE_FORCE);
121 if (opts->allow_rerere_autoupdate)
122 replay.allow_rerere_auto = opts->allow_rerere_autoupdate;
123 replay.allow_empty = 1;
124 replay.allow_empty_message = opts->allow_empty_message;
125 replay.drop_redundant_commits = (opts->empty == EMPTY_DROP);
126 replay.keep_redundant_commits = (opts->empty == EMPTY_KEEP);
127 replay.quiet = !(opts->flags & REBASE_NO_QUIET);
128 replay.verbose = opts->flags & REBASE_VERBOSE;
129 replay.reschedule_failed_exec = opts->reschedule_failed_exec;
130 replay.gpg_sign = xstrdup_or_null(opts->gpg_sign_opt);
131 replay.strategy = opts->strategy;
132 if (opts->strategy_opts)
133 parse_strategy_opts(&replay, opts->strategy_opts);
135 if (opts->squash_onto) {
136 oidcpy(&replay.squash_onto, opts->squash_onto);
137 replay.have_squash_onto = 1;
140 return replay;
143 enum action {
144 ACTION_NONE = 0,
145 ACTION_CONTINUE,
146 ACTION_SKIP,
147 ACTION_ABORT,
148 ACTION_QUIT,
149 ACTION_EDIT_TODO,
150 ACTION_SHOW_CURRENT_PATCH,
151 ACTION_SHORTEN_OIDS,
152 ACTION_EXPAND_OIDS,
153 ACTION_CHECK_TODO_LIST,
154 ACTION_REARRANGE_SQUASH,
155 ACTION_ADD_EXEC
158 static const char *action_names[] = { "undefined",
159 "continue",
160 "skip",
161 "abort",
162 "quit",
163 "edit_todo",
164 "show_current_patch" };
166 static int add_exec_commands(struct string_list *commands)
168 const char *todo_file = rebase_path_todo();
169 struct todo_list todo_list = TODO_LIST_INIT;
170 int res;
172 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
173 return error_errno(_("could not read '%s'."), todo_file);
175 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
176 &todo_list)) {
177 todo_list_release(&todo_list);
178 return error(_("unusable todo list: '%s'"), todo_file);
181 todo_list_add_exec_commands(&todo_list, commands);
182 res = todo_list_write_to_file(the_repository, &todo_list,
183 todo_file, NULL, NULL, -1, 0);
184 todo_list_release(&todo_list);
186 if (res)
187 return error_errno(_("could not write '%s'."), todo_file);
188 return 0;
191 static int rearrange_squash_in_todo_file(void)
193 const char *todo_file = rebase_path_todo();
194 struct todo_list todo_list = TODO_LIST_INIT;
195 int res = 0;
197 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
198 return error_errno(_("could not read '%s'."), todo_file);
199 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
200 &todo_list)) {
201 todo_list_release(&todo_list);
202 return error(_("unusable todo list: '%s'"), todo_file);
205 res = todo_list_rearrange_squash(&todo_list);
206 if (!res)
207 res = todo_list_write_to_file(the_repository, &todo_list,
208 todo_file, NULL, NULL, -1, 0);
210 todo_list_release(&todo_list);
212 if (res)
213 return error_errno(_("could not write '%s'."), todo_file);
214 return 0;
217 static int transform_todo_file(unsigned flags)
219 const char *todo_file = rebase_path_todo();
220 struct todo_list todo_list = TODO_LIST_INIT;
221 int res;
223 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
224 return error_errno(_("could not read '%s'."), todo_file);
226 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
227 &todo_list)) {
228 todo_list_release(&todo_list);
229 return error(_("unusable todo list: '%s'"), todo_file);
232 res = todo_list_write_to_file(the_repository, &todo_list, todo_file,
233 NULL, NULL, -1, flags);
234 todo_list_release(&todo_list);
236 if (res)
237 return error_errno(_("could not write '%s'."), todo_file);
238 return 0;
241 static int edit_todo_file(unsigned flags)
243 const char *todo_file = rebase_path_todo();
244 struct todo_list todo_list = TODO_LIST_INIT,
245 new_todo = TODO_LIST_INIT;
246 int res = 0;
248 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
249 return error_errno(_("could not read '%s'."), todo_file);
251 strbuf_stripspace(&todo_list.buf, 1);
252 res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
253 if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
254 NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
255 res = error_errno(_("could not write '%s'"), todo_file);
257 todo_list_release(&todo_list);
258 todo_list_release(&new_todo);
260 return res;
263 static int get_revision_ranges(struct commit *upstream, struct commit *onto,
264 struct object_id *orig_head, const char **head_hash,
265 char **revisions, char **shortrevisions)
267 struct commit *base_rev = upstream ? upstream : onto;
268 const char *shorthead;
270 *head_hash = find_unique_abbrev(orig_head, GIT_MAX_HEXSZ);
271 *revisions = xstrfmt("%s...%s", oid_to_hex(&base_rev->object.oid),
272 *head_hash);
274 shorthead = find_unique_abbrev(orig_head, DEFAULT_ABBREV);
276 if (upstream) {
277 const char *shortrev;
279 shortrev = find_unique_abbrev(&base_rev->object.oid,
280 DEFAULT_ABBREV);
282 *shortrevisions = xstrfmt("%s..%s", shortrev, shorthead);
283 } else
284 *shortrevisions = xstrdup(shorthead);
286 return 0;
289 static int init_basic_state(struct replay_opts *opts, const char *head_name,
290 struct commit *onto, const char *orig_head)
292 FILE *interactive;
294 if (!is_directory(merge_dir()) && mkdir_in_gitdir(merge_dir()))
295 return error_errno(_("could not create temporary %s"), merge_dir());
297 delete_reflog("REBASE_HEAD");
299 interactive = fopen(path_interactive(), "w");
300 if (!interactive)
301 return error_errno(_("could not mark as interactive"));
302 fclose(interactive);
304 return write_basic_state(opts, head_name, onto, orig_head);
307 static void split_exec_commands(const char *cmd, struct string_list *commands)
309 if (cmd && *cmd) {
310 string_list_split(commands, cmd, '\n', -1);
312 /* rebase.c adds a new line to cmd after every command,
313 * so here the last command is always empty */
314 string_list_remove_empty_items(commands, 0);
318 static int do_interactive_rebase(struct rebase_options *opts, unsigned flags)
320 int ret;
321 const char *head_hash = NULL;
322 char *revisions = NULL, *shortrevisions = NULL;
323 struct argv_array make_script_args = ARGV_ARRAY_INIT;
324 struct todo_list todo_list = TODO_LIST_INIT;
325 struct replay_opts replay = get_replay_opts(opts);
326 struct string_list commands = STRING_LIST_INIT_DUP;
328 if (get_revision_ranges(opts->upstream, opts->onto, &opts->orig_head,
329 &head_hash, &revisions, &shortrevisions))
330 return -1;
332 if (init_basic_state(&replay,
333 opts->head_name ? opts->head_name : "detached HEAD",
334 opts->onto, head_hash)) {
335 free(revisions);
336 free(shortrevisions);
338 return -1;
341 if (!opts->upstream && opts->squash_onto)
342 write_file(path_squash_onto(), "%s\n",
343 oid_to_hex(opts->squash_onto));
345 argv_array_pushl(&make_script_args, "", revisions, NULL);
346 if (opts->restrict_revision)
347 argv_array_pushf(&make_script_args, "^%s",
348 oid_to_hex(&opts->restrict_revision->object.oid));
350 ret = sequencer_make_script(the_repository, &todo_list.buf,
351 make_script_args.argc, make_script_args.argv,
352 flags);
354 if (ret)
355 error(_("could not generate todo list"));
356 else {
357 discard_cache();
358 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
359 &todo_list))
360 BUG("unusable todo list");
362 split_exec_commands(opts->cmd, &commands);
363 ret = complete_action(the_repository, &replay, flags,
364 shortrevisions, opts->onto_name, opts->onto, head_hash,
365 &commands, opts->autosquash, &todo_list);
368 string_list_clear(&commands, 0);
369 free(revisions);
370 free(shortrevisions);
371 todo_list_release(&todo_list);
372 argv_array_clear(&make_script_args);
374 return ret;
377 static int run_sequencer_rebase(struct rebase_options *opts,
378 enum action command)
380 unsigned flags = 0;
381 int abbreviate_commands = 0, ret = 0;
383 git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands);
385 flags |= abbreviate_commands ? TODO_LIST_ABBREVIATE_CMDS : 0;
386 flags |= opts->rebase_merges ? TODO_LIST_REBASE_MERGES : 0;
387 flags |= opts->rebase_cousins > 0 ? TODO_LIST_REBASE_COUSINS : 0;
388 flags |= opts->root_with_onto ? TODO_LIST_ROOT_WITH_ONTO : 0;
389 flags |= command == ACTION_SHORTEN_OIDS ? TODO_LIST_SHORTEN_IDS : 0;
391 switch (command) {
392 case ACTION_NONE: {
393 if (!opts->onto && !opts->upstream)
394 die(_("a base commit must be provided with --upstream or --onto"));
396 ret = do_interactive_rebase(opts, flags);
397 break;
399 case ACTION_SKIP: {
400 struct string_list merge_rr = STRING_LIST_INIT_DUP;
402 rerere_clear(the_repository, &merge_rr);
404 /* fallthrough */
405 case ACTION_CONTINUE: {
406 struct replay_opts replay_opts = get_replay_opts(opts);
408 ret = sequencer_continue(the_repository, &replay_opts);
409 break;
411 case ACTION_EDIT_TODO:
412 ret = edit_todo_file(flags);
413 break;
414 case ACTION_SHOW_CURRENT_PATCH: {
415 struct child_process cmd = CHILD_PROCESS_INIT;
417 cmd.git_cmd = 1;
418 argv_array_pushl(&cmd.args, "show", "REBASE_HEAD", "--", NULL);
419 ret = run_command(&cmd);
421 break;
423 case ACTION_SHORTEN_OIDS:
424 case ACTION_EXPAND_OIDS:
425 ret = transform_todo_file(flags);
426 break;
427 case ACTION_CHECK_TODO_LIST:
428 ret = check_todo_list_from_file(the_repository);
429 break;
430 case ACTION_REARRANGE_SQUASH:
431 ret = rearrange_squash_in_todo_file();
432 break;
433 case ACTION_ADD_EXEC: {
434 struct string_list commands = STRING_LIST_INIT_DUP;
436 split_exec_commands(opts->cmd, &commands);
437 ret = add_exec_commands(&commands);
438 string_list_clear(&commands, 0);
439 break;
441 default:
442 BUG("invalid command '%d'", command);
445 return ret;
448 static int parse_opt_keep_empty(const struct option *opt, const char *arg,
449 int unset)
451 struct rebase_options *opts = opt->value;
453 BUG_ON_OPT_ARG(arg);
456 * If we ever want to remap --keep-empty to --empty=keep, insert:
457 * opts->empty = unset ? EMPTY_UNSPECIFIED : EMPTY_KEEP;
459 opts->type = REBASE_MERGE;
460 return 0;
463 static const char * const builtin_rebase_interactive_usage[] = {
464 N_("git rebase--interactive [<options>]"),
465 NULL
468 int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
470 struct rebase_options opts = REBASE_OPTIONS_INIT;
471 struct object_id squash_onto = null_oid;
472 enum action command = ACTION_NONE;
473 struct option options[] = {
474 OPT_NEGBIT(0, "ff", &opts.flags, N_("allow fast-forward"),
475 REBASE_FORCE),
476 { OPTION_CALLBACK, 'k', "keep-empty", &options, NULL,
477 N_("(DEPRECATED) keep empty commits"),
478 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN,
479 parse_opt_keep_empty },
480 OPT_BOOL_F(0, "allow-empty-message", &opts.allow_empty_message,
481 N_("allow commits with empty messages"),
482 PARSE_OPT_HIDDEN),
483 OPT_BOOL(0, "rebase-merges", &opts.rebase_merges, N_("rebase merge commits")),
484 OPT_BOOL(0, "rebase-cousins", &opts.rebase_cousins,
485 N_("keep original branch points of cousins")),
486 OPT_BOOL(0, "autosquash", &opts.autosquash,
487 N_("move commits that begin with squash!/fixup!")),
488 OPT_BOOL(0, "signoff", &opts.signoff, N_("sign commits")),
489 OPT_BIT('v', "verbose", &opts.flags,
490 N_("display a diffstat of what changed upstream"),
491 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
492 OPT_CMDMODE(0, "continue", &command, N_("continue rebase"),
493 ACTION_CONTINUE),
494 OPT_CMDMODE(0, "skip", &command, N_("skip commit"), ACTION_SKIP),
495 OPT_CMDMODE(0, "edit-todo", &command, N_("edit the todo list"),
496 ACTION_EDIT_TODO),
497 OPT_CMDMODE(0, "show-current-patch", &command, N_("show the current patch"),
498 ACTION_SHOW_CURRENT_PATCH),
499 OPT_CMDMODE(0, "shorten-ids", &command,
500 N_("shorten commit ids in the todo list"), ACTION_SHORTEN_OIDS),
501 OPT_CMDMODE(0, "expand-ids", &command,
502 N_("expand commit ids in the todo list"), ACTION_EXPAND_OIDS),
503 OPT_CMDMODE(0, "check-todo-list", &command,
504 N_("check the todo list"), ACTION_CHECK_TODO_LIST),
505 OPT_CMDMODE(0, "rearrange-squash", &command,
506 N_("rearrange fixup/squash lines"), ACTION_REARRANGE_SQUASH),
507 OPT_CMDMODE(0, "add-exec-commands", &command,
508 N_("insert exec commands in todo list"), ACTION_ADD_EXEC),
509 { OPTION_CALLBACK, 0, "onto", &opts.onto, N_("onto"), N_("onto"),
510 PARSE_OPT_NONEG, parse_opt_commit, 0 },
511 { OPTION_CALLBACK, 0, "restrict-revision", &opts.restrict_revision,
512 N_("restrict-revision"), N_("restrict revision"),
513 PARSE_OPT_NONEG, parse_opt_commit, 0 },
514 { OPTION_CALLBACK, 0, "squash-onto", &squash_onto, N_("squash-onto"),
515 N_("squash onto"), PARSE_OPT_NONEG, parse_opt_object_id, 0 },
516 { OPTION_CALLBACK, 0, "upstream", &opts.upstream, N_("upstream"),
517 N_("the upstream commit"), PARSE_OPT_NONEG, parse_opt_commit,
518 0 },
519 OPT_STRING(0, "head-name", &opts.head_name, N_("head-name"), N_("head name")),
520 { OPTION_STRING, 'S', "gpg-sign", &opts.gpg_sign_opt, N_("key-id"),
521 N_("GPG-sign commits"),
522 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
523 OPT_STRING(0, "strategy", &opts.strategy, N_("strategy"),
524 N_("rebase strategy")),
525 OPT_STRING(0, "strategy-opts", &opts.strategy_opts, N_("strategy-opts"),
526 N_("strategy options")),
527 OPT_STRING(0, "switch-to", &opts.switch_to, N_("switch-to"),
528 N_("the branch or commit to checkout")),
529 OPT_STRING(0, "onto-name", &opts.onto_name, N_("onto-name"), N_("onto name")),
530 OPT_STRING(0, "cmd", &opts.cmd, N_("cmd"), N_("the command to run")),
531 OPT_RERERE_AUTOUPDATE(&opts.allow_rerere_autoupdate),
532 OPT_BOOL(0, "reschedule-failed-exec", &opts.reschedule_failed_exec,
533 N_("automatically re-schedule any `exec` that fails")),
534 OPT_END()
537 opts.rebase_cousins = -1;
539 if (argc == 1)
540 usage_with_options(builtin_rebase_interactive_usage, options);
542 argc = parse_options(argc, argv, prefix, options,
543 builtin_rebase_interactive_usage, PARSE_OPT_KEEP_ARGV0);
545 if (!is_null_oid(&squash_onto))
546 opts.squash_onto = &squash_onto;
548 if (opts.rebase_cousins >= 0 && !opts.rebase_merges)
549 warning(_("--[no-]rebase-cousins has no effect without "
550 "--rebase-merges"));
552 return !!run_sequencer_rebase(&opts, command);
555 static int is_merge(struct rebase_options *opts)
557 return opts->type == REBASE_MERGE ||
558 opts->type == REBASE_PRESERVE_MERGES;
561 static void imply_merge(struct rebase_options *opts, const char *option)
563 switch (opts->type) {
564 case REBASE_APPLY:
565 die(_("%s requires an interactive rebase"), option);
566 break;
567 case REBASE_MERGE:
568 case REBASE_PRESERVE_MERGES:
569 break;
570 default:
571 opts->type = REBASE_MERGE; /* implied */
572 break;
576 /* Returns the filename prefixed by the state_dir */
577 static const char *state_dir_path(const char *filename, struct rebase_options *opts)
579 static struct strbuf path = STRBUF_INIT;
580 static size_t prefix_len;
582 if (!prefix_len) {
583 strbuf_addf(&path, "%s/", opts->state_dir);
584 prefix_len = path.len;
587 strbuf_setlen(&path, prefix_len);
588 strbuf_addstr(&path, filename);
589 return path.buf;
592 /* Initialize the rebase options from the state directory. */
593 static int read_basic_state(struct rebase_options *opts)
595 struct strbuf head_name = STRBUF_INIT;
596 struct strbuf buf = STRBUF_INIT;
597 struct object_id oid;
599 if (!read_oneliner(&head_name, state_dir_path("head-name", opts),
600 READ_ONELINER_WARN_MISSING) ||
601 !read_oneliner(&buf, state_dir_path("onto", opts),
602 READ_ONELINER_WARN_MISSING))
603 return -1;
604 opts->head_name = starts_with(head_name.buf, "refs/") ?
605 xstrdup(head_name.buf) : NULL;
606 strbuf_release(&head_name);
607 if (get_oid(buf.buf, &oid))
608 return error(_("could not get 'onto': '%s'"), buf.buf);
609 opts->onto = lookup_commit_or_die(&oid, buf.buf);
612 * We always write to orig-head, but interactive rebase used to write to
613 * head. Fall back to reading from head to cover for the case that the
614 * user upgraded git with an ongoing interactive rebase.
616 strbuf_reset(&buf);
617 if (file_exists(state_dir_path("orig-head", opts))) {
618 if (!read_oneliner(&buf, state_dir_path("orig-head", opts),
619 READ_ONELINER_WARN_MISSING))
620 return -1;
621 } else if (!read_oneliner(&buf, state_dir_path("head", opts),
622 READ_ONELINER_WARN_MISSING))
623 return -1;
624 if (get_oid(buf.buf, &opts->orig_head))
625 return error(_("invalid orig-head: '%s'"), buf.buf);
627 if (file_exists(state_dir_path("quiet", opts)))
628 opts->flags &= ~REBASE_NO_QUIET;
629 else
630 opts->flags |= REBASE_NO_QUIET;
632 if (file_exists(state_dir_path("verbose", opts)))
633 opts->flags |= REBASE_VERBOSE;
635 if (file_exists(state_dir_path("signoff", opts))) {
636 opts->signoff = 1;
637 opts->flags |= REBASE_FORCE;
640 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
641 strbuf_reset(&buf);
642 if (!read_oneliner(&buf, state_dir_path("allow_rerere_autoupdate", opts),
643 READ_ONELINER_WARN_MISSING))
644 return -1;
645 if (!strcmp(buf.buf, "--rerere-autoupdate"))
646 opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
647 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
648 opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
649 else
650 warning(_("ignoring invalid allow_rerere_autoupdate: "
651 "'%s'"), buf.buf);
654 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
655 strbuf_reset(&buf);
656 if (!read_oneliner(&buf, state_dir_path("gpg_sign_opt", opts),
657 READ_ONELINER_WARN_MISSING))
658 return -1;
659 free(opts->gpg_sign_opt);
660 opts->gpg_sign_opt = xstrdup(buf.buf);
663 if (file_exists(state_dir_path("strategy", opts))) {
664 strbuf_reset(&buf);
665 if (!read_oneliner(&buf, state_dir_path("strategy", opts),
666 READ_ONELINER_WARN_MISSING))
667 return -1;
668 free(opts->strategy);
669 opts->strategy = xstrdup(buf.buf);
672 if (file_exists(state_dir_path("strategy_opts", opts))) {
673 strbuf_reset(&buf);
674 if (!read_oneliner(&buf, state_dir_path("strategy_opts", opts),
675 READ_ONELINER_WARN_MISSING))
676 return -1;
677 free(opts->strategy_opts);
678 opts->strategy_opts = xstrdup(buf.buf);
681 strbuf_release(&buf);
683 return 0;
686 static int rebase_write_basic_state(struct rebase_options *opts)
688 write_file(state_dir_path("head-name", opts), "%s",
689 opts->head_name ? opts->head_name : "detached HEAD");
690 write_file(state_dir_path("onto", opts), "%s",
691 opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
692 write_file(state_dir_path("orig-head", opts), "%s",
693 oid_to_hex(&opts->orig_head));
694 if (!(opts->flags & REBASE_NO_QUIET))
695 write_file(state_dir_path("quiet", opts), "%s", "");
696 if (opts->flags & REBASE_VERBOSE)
697 write_file(state_dir_path("verbose", opts), "%s", "");
698 if (opts->strategy)
699 write_file(state_dir_path("strategy", opts), "%s",
700 opts->strategy);
701 if (opts->strategy_opts)
702 write_file(state_dir_path("strategy_opts", opts), "%s",
703 opts->strategy_opts);
704 if (opts->allow_rerere_autoupdate > 0)
705 write_file(state_dir_path("allow_rerere_autoupdate", opts),
706 "-%s-rerere-autoupdate",
707 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
708 "" : "-no");
709 if (opts->gpg_sign_opt)
710 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
711 opts->gpg_sign_opt);
712 if (opts->signoff)
713 write_file(state_dir_path("signoff", opts), "--signoff");
715 return 0;
718 static int finish_rebase(struct rebase_options *opts)
720 struct strbuf dir = STRBUF_INIT;
721 const char *argv_gc_auto[] = { "gc", "--auto", NULL };
722 int ret = 0;
724 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
725 apply_autostash(state_dir_path("autostash", opts));
726 close_object_store(the_repository->objects);
728 * We ignore errors in 'gc --auto', since the
729 * user should see them.
731 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
732 if (opts->type == REBASE_MERGE) {
733 struct replay_opts replay = REPLAY_OPTS_INIT;
735 replay.action = REPLAY_INTERACTIVE_REBASE;
736 ret = sequencer_remove_state(&replay);
737 } else {
738 strbuf_addstr(&dir, opts->state_dir);
739 if (remove_dir_recursively(&dir, 0))
740 ret = error(_("could not remove '%s'"),
741 opts->state_dir);
742 strbuf_release(&dir);
745 return ret;
748 static struct commit *peel_committish(const char *name)
750 struct object *obj;
751 struct object_id oid;
753 if (get_oid(name, &oid))
754 return NULL;
755 obj = parse_object(the_repository, &oid);
756 return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
759 static void add_var(struct strbuf *buf, const char *name, const char *value)
761 if (!value)
762 strbuf_addf(buf, "unset %s; ", name);
763 else {
764 strbuf_addf(buf, "%s=", name);
765 sq_quote_buf(buf, value);
766 strbuf_addstr(buf, "; ");
770 static int move_to_original_branch(struct rebase_options *opts)
772 struct strbuf orig_head_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
773 int ret;
775 if (!opts->head_name)
776 return 0; /* nothing to move back to */
778 if (!opts->onto)
779 BUG("move_to_original_branch without onto");
781 strbuf_addf(&orig_head_reflog, "rebase finished: %s onto %s",
782 opts->head_name, oid_to_hex(&opts->onto->object.oid));
783 strbuf_addf(&head_reflog, "rebase finished: returning to %s",
784 opts->head_name);
785 ret = reset_head(the_repository, NULL, "", opts->head_name,
786 RESET_HEAD_REFS_ONLY,
787 orig_head_reflog.buf, head_reflog.buf,
788 DEFAULT_REFLOG_ACTION);
790 strbuf_release(&orig_head_reflog);
791 strbuf_release(&head_reflog);
792 return ret;
795 static const char *resolvemsg =
796 N_("Resolve all conflicts manually, mark them as resolved with\n"
797 "\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
798 "You can instead skip this commit: run \"git rebase --skip\".\n"
799 "To abort and get back to the state before \"git rebase\", run "
800 "\"git rebase --abort\".");
802 static int run_am(struct rebase_options *opts)
804 struct child_process am = CHILD_PROCESS_INIT;
805 struct child_process format_patch = CHILD_PROCESS_INIT;
806 struct strbuf revisions = STRBUF_INIT;
807 int status;
808 char *rebased_patches;
810 am.git_cmd = 1;
811 argv_array_push(&am.args, "am");
813 if (opts->action && !strcmp("continue", opts->action)) {
814 argv_array_push(&am.args, "--resolved");
815 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
816 if (opts->gpg_sign_opt)
817 argv_array_push(&am.args, opts->gpg_sign_opt);
818 status = run_command(&am);
819 if (status)
820 return status;
822 return move_to_original_branch(opts);
824 if (opts->action && !strcmp("skip", opts->action)) {
825 argv_array_push(&am.args, "--skip");
826 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
827 status = run_command(&am);
828 if (status)
829 return status;
831 return move_to_original_branch(opts);
833 if (opts->action && !strcmp("show-current-patch", opts->action)) {
834 argv_array_push(&am.args, "--show-current-patch");
835 return run_command(&am);
838 strbuf_addf(&revisions, "%s...%s",
839 oid_to_hex(opts->root ?
840 /* this is now equivalent to !opts->upstream */
841 &opts->onto->object.oid :
842 &opts->upstream->object.oid),
843 oid_to_hex(&opts->orig_head));
845 rebased_patches = xstrdup(git_path("rebased-patches"));
846 format_patch.out = open(rebased_patches,
847 O_WRONLY | O_CREAT | O_TRUNC, 0666);
848 if (format_patch.out < 0) {
849 status = error_errno(_("could not open '%s' for writing"),
850 rebased_patches);
851 free(rebased_patches);
852 argv_array_clear(&am.args);
853 return status;
856 format_patch.git_cmd = 1;
857 argv_array_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
858 "--full-index", "--cherry-pick", "--right-only",
859 "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
860 "--no-cover-letter", "--pretty=mboxrd", "--topo-order",
861 "--no-base", NULL);
862 if (opts->git_format_patch_opt.len)
863 argv_array_split(&format_patch.args,
864 opts->git_format_patch_opt.buf);
865 argv_array_push(&format_patch.args, revisions.buf);
866 if (opts->restrict_revision)
867 argv_array_pushf(&format_patch.args, "^%s",
868 oid_to_hex(&opts->restrict_revision->object.oid));
870 status = run_command(&format_patch);
871 if (status) {
872 unlink(rebased_patches);
873 free(rebased_patches);
874 argv_array_clear(&am.args);
876 reset_head(the_repository, &opts->orig_head, "checkout",
877 opts->head_name, 0,
878 "HEAD", NULL, DEFAULT_REFLOG_ACTION);
879 error(_("\ngit encountered an error while preparing the "
880 "patches to replay\n"
881 "these revisions:\n"
882 "\n %s\n\n"
883 "As a result, git cannot rebase them."),
884 opts->revisions);
886 strbuf_release(&revisions);
887 return status;
889 strbuf_release(&revisions);
891 am.in = open(rebased_patches, O_RDONLY);
892 if (am.in < 0) {
893 status = error_errno(_("could not open '%s' for reading"),
894 rebased_patches);
895 free(rebased_patches);
896 argv_array_clear(&am.args);
897 return status;
900 argv_array_pushv(&am.args, opts->git_am_opts.argv);
901 argv_array_push(&am.args, "--rebasing");
902 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
903 argv_array_push(&am.args, "--patch-format=mboxrd");
904 if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
905 argv_array_push(&am.args, "--rerere-autoupdate");
906 else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
907 argv_array_push(&am.args, "--no-rerere-autoupdate");
908 if (opts->gpg_sign_opt)
909 argv_array_push(&am.args, opts->gpg_sign_opt);
910 status = run_command(&am);
911 unlink(rebased_patches);
912 free(rebased_patches);
914 if (!status) {
915 return move_to_original_branch(opts);
918 if (is_directory(opts->state_dir))
919 rebase_write_basic_state(opts);
921 return status;
924 static int run_specific_rebase(struct rebase_options *opts, enum action action)
926 const char *argv[] = { NULL, NULL };
927 struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
928 int status;
929 const char *backend, *backend_func;
931 if (opts->type == REBASE_MERGE) {
932 /* Run sequencer-based rebase */
933 setenv("GIT_CHERRY_PICK_HELP", resolvemsg, 1);
934 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
935 setenv("GIT_SEQUENCE_EDITOR", ":", 1);
936 opts->autosquash = 0;
938 if (opts->gpg_sign_opt) {
939 /* remove the leading "-S" */
940 char *tmp = xstrdup(opts->gpg_sign_opt + 2);
941 free(opts->gpg_sign_opt);
942 opts->gpg_sign_opt = tmp;
945 status = run_sequencer_rebase(opts, action);
946 goto finished_rebase;
949 if (opts->type == REBASE_APPLY) {
950 status = run_am(opts);
951 goto finished_rebase;
954 add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
955 add_var(&script_snippet, "state_dir", opts->state_dir);
957 add_var(&script_snippet, "upstream_name", opts->upstream_name);
958 add_var(&script_snippet, "upstream", opts->upstream ?
959 oid_to_hex(&opts->upstream->object.oid) : NULL);
960 add_var(&script_snippet, "head_name",
961 opts->head_name ? opts->head_name : "detached HEAD");
962 add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
963 add_var(&script_snippet, "onto", opts->onto ?
964 oid_to_hex(&opts->onto->object.oid) : NULL);
965 add_var(&script_snippet, "onto_name", opts->onto_name);
966 add_var(&script_snippet, "revisions", opts->revisions);
967 add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
968 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
969 sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
970 add_var(&script_snippet, "git_am_opt", buf.buf);
971 strbuf_release(&buf);
972 add_var(&script_snippet, "verbose",
973 opts->flags & REBASE_VERBOSE ? "t" : "");
974 add_var(&script_snippet, "diffstat",
975 opts->flags & REBASE_DIFFSTAT ? "t" : "");
976 add_var(&script_snippet, "force_rebase",
977 opts->flags & REBASE_FORCE ? "t" : "");
978 if (opts->switch_to)
979 add_var(&script_snippet, "switch_to", opts->switch_to);
980 add_var(&script_snippet, "action", opts->action ? opts->action : "");
981 add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
982 add_var(&script_snippet, "allow_rerere_autoupdate",
983 opts->allow_rerere_autoupdate ?
984 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
985 "--rerere-autoupdate" : "--no-rerere-autoupdate" : "");
986 add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
987 add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
988 add_var(&script_snippet, "cmd", opts->cmd);
989 add_var(&script_snippet, "allow_empty_message",
990 opts->allow_empty_message ? "--allow-empty-message" : "");
991 add_var(&script_snippet, "rebase_merges",
992 opts->rebase_merges ? "t" : "");
993 add_var(&script_snippet, "rebase_cousins",
994 opts->rebase_cousins ? "t" : "");
995 add_var(&script_snippet, "strategy", opts->strategy);
996 add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
997 add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
998 add_var(&script_snippet, "squash_onto",
999 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
1000 add_var(&script_snippet, "git_format_patch_opt",
1001 opts->git_format_patch_opt.buf);
1003 if (is_merge(opts) &&
1004 !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
1005 strbuf_addstr(&script_snippet,
1006 "GIT_SEQUENCE_EDITOR=:; export GIT_SEQUENCE_EDITOR; ");
1007 opts->autosquash = 0;
1010 switch (opts->type) {
1011 case REBASE_PRESERVE_MERGES:
1012 backend = "git-rebase--preserve-merges";
1013 backend_func = "git_rebase__preserve_merges";
1014 break;
1015 default:
1016 BUG("Unhandled rebase type %d", opts->type);
1017 break;
1020 strbuf_addf(&script_snippet,
1021 ". git-sh-setup && . %s && %s", backend, backend_func);
1022 argv[0] = script_snippet.buf;
1024 status = run_command_v_opt(argv, RUN_USING_SHELL);
1025 finished_rebase:
1026 if (opts->dont_finish_rebase)
1027 ; /* do nothing */
1028 else if (opts->type == REBASE_MERGE)
1029 ; /* merge backend cleans up after itself */
1030 else if (status == 0) {
1031 if (!file_exists(state_dir_path("stopped-sha", opts)))
1032 finish_rebase(opts);
1033 } else if (status == 2) {
1034 struct strbuf dir = STRBUF_INIT;
1036 apply_autostash(state_dir_path("autostash", opts));
1037 strbuf_addstr(&dir, opts->state_dir);
1038 remove_dir_recursively(&dir, 0);
1039 strbuf_release(&dir);
1040 die("Nothing to do");
1043 strbuf_release(&script_snippet);
1045 return status ? -1 : 0;
1048 static int rebase_config(const char *var, const char *value, void *data)
1050 struct rebase_options *opts = data;
1052 if (!strcmp(var, "rebase.stat")) {
1053 if (git_config_bool(var, value))
1054 opts->flags |= REBASE_DIFFSTAT;
1055 else
1056 opts->flags &= ~REBASE_DIFFSTAT;
1057 return 0;
1060 if (!strcmp(var, "rebase.autosquash")) {
1061 opts->autosquash = git_config_bool(var, value);
1062 return 0;
1065 if (!strcmp(var, "commit.gpgsign")) {
1066 free(opts->gpg_sign_opt);
1067 opts->gpg_sign_opt = git_config_bool(var, value) ?
1068 xstrdup("-S") : NULL;
1069 return 0;
1072 if (!strcmp(var, "rebase.autostash")) {
1073 opts->autostash = git_config_bool(var, value);
1074 return 0;
1077 if (!strcmp(var, "rebase.reschedulefailedexec")) {
1078 opts->reschedule_failed_exec = git_config_bool(var, value);
1079 return 0;
1082 if (!strcmp(var, "rebase.usebuiltin")) {
1083 opts->use_legacy_rebase = !git_config_bool(var, value);
1084 return 0;
1087 if (!strcmp(var, "rebase.backend")) {
1088 return git_config_string(&opts->default_backend, var, value);
1091 return git_default_config(var, value, data);
1095 * Determines whether the commits in from..to are linear, i.e. contain
1096 * no merge commits. This function *expects* `from` to be an ancestor of
1097 * `to`.
1099 static int is_linear_history(struct commit *from, struct commit *to)
1101 while (to && to != from) {
1102 parse_commit(to);
1103 if (!to->parents)
1104 return 1;
1105 if (to->parents->next)
1106 return 0;
1107 to = to->parents->item;
1109 return 1;
1112 static int can_fast_forward(struct commit *onto, struct commit *upstream,
1113 struct commit *restrict_revision,
1114 struct object_id *head_oid, struct object_id *merge_base)
1116 struct commit *head = lookup_commit(the_repository, head_oid);
1117 struct commit_list *merge_bases = NULL;
1118 int res = 0;
1120 if (!head)
1121 goto done;
1123 merge_bases = get_merge_bases(onto, head);
1124 if (!merge_bases || merge_bases->next) {
1125 oidcpy(merge_base, &null_oid);
1126 goto done;
1129 oidcpy(merge_base, &merge_bases->item->object.oid);
1130 if (!oideq(merge_base, &onto->object.oid))
1131 goto done;
1133 if (restrict_revision && !oideq(&restrict_revision->object.oid, merge_base))
1134 goto done;
1136 if (!upstream)
1137 goto done;
1139 free_commit_list(merge_bases);
1140 merge_bases = get_merge_bases(upstream, head);
1141 if (!merge_bases || merge_bases->next)
1142 goto done;
1144 if (!oideq(&onto->object.oid, &merge_bases->item->object.oid))
1145 goto done;
1147 res = 1;
1149 done:
1150 free_commit_list(merge_bases);
1151 return res && is_linear_history(onto, head);
1154 static int parse_opt_am(const struct option *opt, const char *arg, int unset)
1156 struct rebase_options *opts = opt->value;
1158 BUG_ON_OPT_NEG(unset);
1159 BUG_ON_OPT_ARG(arg);
1161 opts->type = REBASE_APPLY;
1163 return 0;
1166 /* -i followed by -m is still -i */
1167 static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
1169 struct rebase_options *opts = opt->value;
1171 BUG_ON_OPT_NEG(unset);
1172 BUG_ON_OPT_ARG(arg);
1174 if (!is_merge(opts))
1175 opts->type = REBASE_MERGE;
1177 return 0;
1180 /* -i followed by -p is still explicitly interactive, but -p alone is not */
1181 static int parse_opt_interactive(const struct option *opt, const char *arg,
1182 int unset)
1184 struct rebase_options *opts = opt->value;
1186 BUG_ON_OPT_NEG(unset);
1187 BUG_ON_OPT_ARG(arg);
1189 opts->type = REBASE_MERGE;
1190 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
1192 return 0;
1195 static enum empty_type parse_empty_value(const char *value)
1197 if (!strcasecmp(value, "drop"))
1198 return EMPTY_DROP;
1199 else if (!strcasecmp(value, "keep"))
1200 return EMPTY_KEEP;
1201 else if (!strcasecmp(value, "ask"))
1202 return EMPTY_ASK;
1204 die(_("unrecognized empty type '%s'; valid values are \"drop\", \"keep\", and \"ask\"."), value);
1207 static int parse_opt_empty(const struct option *opt, const char *arg, int unset)
1209 struct rebase_options *options = opt->value;
1210 enum empty_type value = parse_empty_value(arg);
1212 BUG_ON_OPT_NEG(unset);
1214 options->empty = value;
1215 return 0;
1218 static void NORETURN error_on_missing_default_upstream(void)
1220 struct branch *current_branch = branch_get(NULL);
1222 printf(_("%s\n"
1223 "Please specify which branch you want to rebase against.\n"
1224 "See git-rebase(1) for details.\n"
1225 "\n"
1226 " git rebase '<branch>'\n"
1227 "\n"),
1228 current_branch ? _("There is no tracking information for "
1229 "the current branch.") :
1230 _("You are not currently on a branch."));
1232 if (current_branch) {
1233 const char *remote = current_branch->remote_name;
1235 if (!remote)
1236 remote = _("<remote>");
1238 printf(_("If you wish to set tracking information for this "
1239 "branch you can do so with:\n"
1240 "\n"
1241 " git branch --set-upstream-to=%s/<branch> %s\n"
1242 "\n"),
1243 remote, current_branch->name);
1245 exit(1);
1248 static void set_reflog_action(struct rebase_options *options)
1250 const char *env;
1251 struct strbuf buf = STRBUF_INIT;
1253 if (!is_merge(options))
1254 return;
1256 env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
1257 if (env && strcmp("rebase", env))
1258 return; /* only override it if it is "rebase" */
1260 strbuf_addf(&buf, "rebase (%s)", options->action);
1261 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
1262 strbuf_release(&buf);
1265 static int check_exec_cmd(const char *cmd)
1267 if (strchr(cmd, '\n'))
1268 return error(_("exec commands cannot contain newlines"));
1270 /* Does the command consist purely of whitespace? */
1271 if (!cmd[strspn(cmd, " \t\r\f\v")])
1272 return error(_("empty exec command"));
1274 return 0;
1278 int cmd_rebase(int argc, const char **argv, const char *prefix)
1280 struct rebase_options options = REBASE_OPTIONS_INIT;
1281 const char *branch_name;
1282 int ret, flags, total_argc, in_progress = 0;
1283 int keep_base = 0;
1284 int ok_to_skip_pre_rebase = 0;
1285 struct strbuf msg = STRBUF_INIT;
1286 struct strbuf revisions = STRBUF_INIT;
1287 struct strbuf buf = STRBUF_INIT;
1288 struct object_id merge_base;
1289 enum action action = ACTION_NONE;
1290 const char *gpg_sign = NULL;
1291 struct string_list exec = STRING_LIST_INIT_NODUP;
1292 const char *rebase_merges = NULL;
1293 int fork_point = -1;
1294 struct string_list strategy_options = STRING_LIST_INIT_NODUP;
1295 struct object_id squash_onto;
1296 char *squash_onto_name = NULL;
1297 int reschedule_failed_exec = -1;
1298 int allow_preemptive_ff = 1;
1299 struct option builtin_rebase_options[] = {
1300 OPT_STRING(0, "onto", &options.onto_name,
1301 N_("revision"),
1302 N_("rebase onto given branch instead of upstream")),
1303 OPT_BOOL(0, "keep-base", &keep_base,
1304 N_("use the merge-base of upstream and branch as the current base")),
1305 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1306 N_("allow pre-rebase hook to run")),
1307 OPT_NEGBIT('q', "quiet", &options.flags,
1308 N_("be quiet. implies --no-stat"),
1309 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1310 OPT_BIT('v', "verbose", &options.flags,
1311 N_("display a diffstat of what changed upstream"),
1312 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1313 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1314 N_("do not show diffstat of what changed upstream"),
1315 PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
1316 OPT_BOOL(0, "signoff", &options.signoff,
1317 N_("add a Signed-off-by: line to each commit")),
1318 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
1319 NULL, N_("passed to 'git am'"),
1320 PARSE_OPT_NOARG),
1321 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
1322 &options.git_am_opts, NULL,
1323 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1324 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
1325 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1326 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1327 N_("passed to 'git apply'"), 0),
1328 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1329 N_("action"), N_("passed to 'git apply'"), 0),
1330 OPT_BIT('f', "force-rebase", &options.flags,
1331 N_("cherry-pick all commits, even if unchanged"),
1332 REBASE_FORCE),
1333 OPT_BIT(0, "no-ff", &options.flags,
1334 N_("cherry-pick all commits, even if unchanged"),
1335 REBASE_FORCE),
1336 OPT_CMDMODE(0, "continue", &action, N_("continue"),
1337 ACTION_CONTINUE),
1338 OPT_CMDMODE(0, "skip", &action,
1339 N_("skip current patch and continue"), ACTION_SKIP),
1340 OPT_CMDMODE(0, "abort", &action,
1341 N_("abort and check out the original branch"),
1342 ACTION_ABORT),
1343 OPT_CMDMODE(0, "quit", &action,
1344 N_("abort but keep HEAD where it is"), ACTION_QUIT),
1345 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
1346 "during an interactive rebase"), ACTION_EDIT_TODO),
1347 OPT_CMDMODE(0, "show-current-patch", &action,
1348 N_("show the patch file being applied or merged"),
1349 ACTION_SHOW_CURRENT_PATCH),
1350 { OPTION_CALLBACK, 0, "apply", &options, NULL,
1351 N_("use apply strategies to rebase"),
1352 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1353 parse_opt_am },
1354 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
1355 N_("use merging strategies to rebase"),
1356 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1357 parse_opt_merge },
1358 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
1359 N_("let the user edit the list of commits to rebase"),
1360 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1361 parse_opt_interactive },
1362 OPT_SET_INT_F('p', "preserve-merges", &options.type,
1363 N_("(DEPRECATED) try to recreate merges instead of "
1364 "ignoring them"),
1365 REBASE_PRESERVE_MERGES, PARSE_OPT_HIDDEN),
1366 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
1367 OPT_CALLBACK_F(0, "empty", &options, "{drop,keep,ask}",
1368 N_("how to handle commits that become empty"),
1369 PARSE_OPT_NONEG, parse_opt_empty),
1370 { OPTION_CALLBACK, 'k', "keep-empty", &options, NULL,
1371 N_("(DEPRECATED) keep empty commits"),
1372 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN,
1373 parse_opt_keep_empty },
1374 OPT_BOOL(0, "autosquash", &options.autosquash,
1375 N_("move commits that begin with "
1376 "squash!/fixup! under -i")),
1377 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1378 N_("GPG-sign commits"),
1379 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1380 OPT_BOOL(0, "autostash", &options.autostash,
1381 N_("automatically stash/stash pop before and after")),
1382 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
1383 N_("add exec lines after each commit of the "
1384 "editable list")),
1385 OPT_BOOL_F(0, "allow-empty-message",
1386 &options.allow_empty_message,
1387 N_("allow rebasing commits with empty messages"),
1388 PARSE_OPT_HIDDEN),
1389 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1390 N_("mode"),
1391 N_("try to rebase merges instead of skipping them"),
1392 PARSE_OPT_OPTARG, NULL, (intptr_t)""},
1393 OPT_BOOL(0, "fork-point", &fork_point,
1394 N_("use 'merge-base --fork-point' to refine upstream")),
1395 OPT_STRING('s', "strategy", &options.strategy,
1396 N_("strategy"), N_("use the given merge strategy")),
1397 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1398 N_("option"),
1399 N_("pass the argument through to the merge "
1400 "strategy")),
1401 OPT_BOOL(0, "root", &options.root,
1402 N_("rebase all reachable commits up to the root(s)")),
1403 OPT_BOOL(0, "reschedule-failed-exec",
1404 &reschedule_failed_exec,
1405 N_("automatically re-schedule any `exec` that fails")),
1406 OPT_END(),
1408 int i;
1410 if (argc == 2 && !strcmp(argv[1], "-h"))
1411 usage_with_options(builtin_rebase_usage,
1412 builtin_rebase_options);
1414 options.allow_empty_message = 1;
1415 git_config(rebase_config, &options);
1417 if (options.use_legacy_rebase ||
1418 !git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1))
1419 warning(_("the rebase.useBuiltin support has been removed!\n"
1420 "See its entry in 'git help config' for details."));
1422 strbuf_reset(&buf);
1423 strbuf_addf(&buf, "%s/applying", apply_dir());
1424 if(file_exists(buf.buf))
1425 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1427 if (is_directory(apply_dir())) {
1428 options.type = REBASE_APPLY;
1429 options.state_dir = apply_dir();
1430 } else if (is_directory(merge_dir())) {
1431 strbuf_reset(&buf);
1432 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1433 if (is_directory(buf.buf)) {
1434 options.type = REBASE_PRESERVE_MERGES;
1435 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1436 } else {
1437 strbuf_reset(&buf);
1438 strbuf_addf(&buf, "%s/interactive", merge_dir());
1439 if(file_exists(buf.buf)) {
1440 options.type = REBASE_MERGE;
1441 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1442 } else
1443 options.type = REBASE_MERGE;
1445 options.state_dir = merge_dir();
1448 if (options.type != REBASE_UNSPECIFIED)
1449 in_progress = 1;
1451 total_argc = argc;
1452 argc = parse_options(argc, argv, prefix,
1453 builtin_rebase_options,
1454 builtin_rebase_usage, 0);
1456 if (action != ACTION_NONE && total_argc != 2) {
1457 usage_with_options(builtin_rebase_usage,
1458 builtin_rebase_options);
1461 if (argc > 2)
1462 usage_with_options(builtin_rebase_usage,
1463 builtin_rebase_options);
1465 if (options.type == REBASE_PRESERVE_MERGES)
1466 warning(_("git rebase --preserve-merges is deprecated. "
1467 "Use --rebase-merges instead."));
1469 if (keep_base) {
1470 if (options.onto_name)
1471 die(_("cannot combine '--keep-base' with '--onto'"));
1472 if (options.root)
1473 die(_("cannot combine '--keep-base' with '--root'"));
1476 if (action != ACTION_NONE && !in_progress)
1477 die(_("No rebase in progress?"));
1478 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
1480 if (action == ACTION_EDIT_TODO && !is_merge(&options))
1481 die(_("The --edit-todo action can only be used during "
1482 "interactive rebase."));
1484 if (trace2_is_enabled()) {
1485 if (is_merge(&options))
1486 trace2_cmd_mode("interactive");
1487 else if (exec.nr)
1488 trace2_cmd_mode("interactive-exec");
1489 else
1490 trace2_cmd_mode(action_names[action]);
1493 switch (action) {
1494 case ACTION_CONTINUE: {
1495 struct object_id head;
1496 struct lock_file lock_file = LOCK_INIT;
1497 int fd;
1499 options.action = "continue";
1500 set_reflog_action(&options);
1502 /* Sanity check */
1503 if (get_oid("HEAD", &head))
1504 die(_("Cannot read HEAD"));
1506 fd = hold_locked_index(&lock_file, 0);
1507 if (repo_read_index(the_repository) < 0)
1508 die(_("could not read index"));
1509 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1510 NULL);
1511 if (0 <= fd)
1512 repo_update_index_if_able(the_repository, &lock_file);
1513 rollback_lock_file(&lock_file);
1515 if (has_unstaged_changes(the_repository, 1)) {
1516 puts(_("You must edit all merge conflicts and then\n"
1517 "mark them as resolved using git add"));
1518 exit(1);
1520 if (read_basic_state(&options))
1521 exit(1);
1522 goto run_rebase;
1524 case ACTION_SKIP: {
1525 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1527 options.action = "skip";
1528 set_reflog_action(&options);
1530 rerere_clear(the_repository, &merge_rr);
1531 string_list_clear(&merge_rr, 1);
1533 if (reset_head(the_repository, NULL, "reset", NULL, RESET_HEAD_HARD,
1534 NULL, NULL, DEFAULT_REFLOG_ACTION) < 0)
1535 die(_("could not discard worktree changes"));
1536 remove_branch_state(the_repository, 0);
1537 if (read_basic_state(&options))
1538 exit(1);
1539 goto run_rebase;
1541 case ACTION_ABORT: {
1542 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1543 options.action = "abort";
1544 set_reflog_action(&options);
1546 rerere_clear(the_repository, &merge_rr);
1547 string_list_clear(&merge_rr, 1);
1549 if (read_basic_state(&options))
1550 exit(1);
1551 if (reset_head(the_repository, &options.orig_head, "reset",
1552 options.head_name, RESET_HEAD_HARD,
1553 NULL, NULL, DEFAULT_REFLOG_ACTION) < 0)
1554 die(_("could not move back to %s"),
1555 oid_to_hex(&options.orig_head));
1556 remove_branch_state(the_repository, 0);
1557 ret = !!finish_rebase(&options);
1558 goto cleanup;
1560 case ACTION_QUIT: {
1561 if (options.type == REBASE_MERGE) {
1562 struct replay_opts replay = REPLAY_OPTS_INIT;
1564 replay.action = REPLAY_INTERACTIVE_REBASE;
1565 ret = !!sequencer_remove_state(&replay);
1566 } else {
1567 strbuf_reset(&buf);
1568 strbuf_addstr(&buf, options.state_dir);
1569 ret = !!remove_dir_recursively(&buf, 0);
1570 if (ret)
1571 error(_("could not remove '%s'"),
1572 options.state_dir);
1574 goto cleanup;
1576 case ACTION_EDIT_TODO:
1577 options.action = "edit-todo";
1578 options.dont_finish_rebase = 1;
1579 goto run_rebase;
1580 case ACTION_SHOW_CURRENT_PATCH:
1581 options.action = "show-current-patch";
1582 options.dont_finish_rebase = 1;
1583 goto run_rebase;
1584 case ACTION_NONE:
1585 break;
1586 default:
1587 BUG("action: %d", action);
1590 /* Make sure no rebase is in progress */
1591 if (in_progress) {
1592 const char *last_slash = strrchr(options.state_dir, '/');
1593 const char *state_dir_base =
1594 last_slash ? last_slash + 1 : options.state_dir;
1595 const char *cmd_live_rebase =
1596 "git rebase (--continue | --abort | --skip)";
1597 strbuf_reset(&buf);
1598 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1599 die(_("It seems that there is already a %s directory, and\n"
1600 "I wonder if you are in the middle of another rebase. "
1601 "If that is the\n"
1602 "case, please try\n\t%s\n"
1603 "If that is not the case, please\n\t%s\n"
1604 "and run me again. I am stopping in case you still "
1605 "have something\n"
1606 "valuable there.\n"),
1607 state_dir_base, cmd_live_rebase, buf.buf);
1610 if ((options.flags & REBASE_INTERACTIVE_EXPLICIT) ||
1611 (action != ACTION_NONE) ||
1612 (exec.nr > 0) ||
1613 options.autosquash) {
1614 allow_preemptive_ff = 0;
1617 for (i = 0; i < options.git_am_opts.argc; i++) {
1618 const char *option = options.git_am_opts.argv[i], *p;
1619 if (!strcmp(option, "--committer-date-is-author-date") ||
1620 !strcmp(option, "--ignore-date") ||
1621 !strcmp(option, "--whitespace=fix") ||
1622 !strcmp(option, "--whitespace=strip"))
1623 allow_preemptive_ff = 0;
1624 else if (skip_prefix(option, "-C", &p)) {
1625 while (*p)
1626 if (!isdigit(*(p++)))
1627 die(_("switch `C' expects a "
1628 "numerical value"));
1629 } else if (skip_prefix(option, "--whitespace=", &p)) {
1630 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1631 strcmp(p, "error") && strcmp(p, "error-all"))
1632 die("Invalid whitespace option: '%s'", p);
1636 for (i = 0; i < exec.nr; i++)
1637 if (check_exec_cmd(exec.items[i].string))
1638 exit(1);
1640 if (!(options.flags & REBASE_NO_QUIET))
1641 argv_array_push(&options.git_am_opts, "-q");
1643 if (options.empty != EMPTY_UNSPECIFIED)
1644 imply_merge(&options, "--empty");
1646 if (gpg_sign) {
1647 free(options.gpg_sign_opt);
1648 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1651 if (exec.nr) {
1652 int i;
1654 imply_merge(&options, "--exec");
1656 strbuf_reset(&buf);
1657 for (i = 0; i < exec.nr; i++)
1658 strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1659 options.cmd = xstrdup(buf.buf);
1662 if (rebase_merges) {
1663 if (!*rebase_merges)
1664 ; /* default mode; do nothing */
1665 else if (!strcmp("rebase-cousins", rebase_merges))
1666 options.rebase_cousins = 1;
1667 else if (strcmp("no-rebase-cousins", rebase_merges))
1668 die(_("Unknown mode: %s"), rebase_merges);
1669 options.rebase_merges = 1;
1670 imply_merge(&options, "--rebase-merges");
1673 if (strategy_options.nr) {
1674 int i;
1676 if (!options.strategy)
1677 options.strategy = "recursive";
1679 strbuf_reset(&buf);
1680 for (i = 0; i < strategy_options.nr; i++)
1681 strbuf_addf(&buf, " --%s",
1682 strategy_options.items[i].string);
1683 options.strategy_opts = xstrdup(buf.buf);
1686 if (options.strategy) {
1687 options.strategy = xstrdup(options.strategy);
1688 switch (options.type) {
1689 case REBASE_APPLY:
1690 die(_("--strategy requires --merge or --interactive"));
1691 case REBASE_MERGE:
1692 case REBASE_PRESERVE_MERGES:
1693 /* compatible */
1694 break;
1695 case REBASE_UNSPECIFIED:
1696 options.type = REBASE_MERGE;
1697 break;
1698 default:
1699 BUG("unhandled rebase type (%d)", options.type);
1703 if (options.type == REBASE_MERGE)
1704 imply_merge(&options, "--merge");
1706 if (options.root && !options.onto_name)
1707 imply_merge(&options, "--root without --onto");
1709 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1710 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1712 if (options.git_am_opts.argc || options.type == REBASE_APPLY) {
1713 /* all am options except -q are compatible only with --apply */
1714 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1715 if (strcmp(options.git_am_opts.argv[i], "-q"))
1716 break;
1718 if (i >= 0) {
1719 if (is_merge(&options))
1720 die(_("cannot combine apply options with "
1721 "merge options"));
1722 else
1723 options.type = REBASE_APPLY;
1727 if (options.type == REBASE_UNSPECIFIED) {
1728 if (!strcmp(options.default_backend, "merge"))
1729 imply_merge(&options, "--merge");
1730 else if (!strcmp(options.default_backend, "apply"))
1731 options.type = REBASE_APPLY;
1732 else
1733 die(_("Unknown rebase backend: %s"),
1734 options.default_backend);
1737 switch (options.type) {
1738 case REBASE_MERGE:
1739 case REBASE_PRESERVE_MERGES:
1740 options.state_dir = merge_dir();
1741 break;
1742 case REBASE_APPLY:
1743 options.state_dir = apply_dir();
1744 break;
1745 default:
1746 BUG("options.type was just set above; should be unreachable.");
1749 if (options.empty == EMPTY_UNSPECIFIED) {
1750 if (options.flags & REBASE_INTERACTIVE_EXPLICIT)
1751 options.empty = EMPTY_ASK;
1752 else if (exec.nr > 0)
1753 options.empty = EMPTY_KEEP;
1754 else
1755 options.empty = EMPTY_DROP;
1757 if (reschedule_failed_exec > 0 && !is_merge(&options))
1758 die(_("--reschedule-failed-exec requires "
1759 "--exec or --interactive"));
1760 if (reschedule_failed_exec >= 0)
1761 options.reschedule_failed_exec = reschedule_failed_exec;
1763 if (options.signoff) {
1764 if (options.type == REBASE_PRESERVE_MERGES)
1765 die("cannot combine '--signoff' with "
1766 "'--preserve-merges'");
1767 argv_array_push(&options.git_am_opts, "--signoff");
1768 options.flags |= REBASE_FORCE;
1771 if (options.type == REBASE_PRESERVE_MERGES) {
1773 * Note: incompatibility with --signoff handled in signoff block above
1774 * Note: incompatibility with --interactive is just a strong warning;
1775 * git-rebase.txt caveats with "unless you know what you are doing"
1777 if (options.rebase_merges)
1778 die(_("cannot combine '--preserve-merges' with "
1779 "'--rebase-merges'"));
1781 if (options.reschedule_failed_exec)
1782 die(_("error: cannot combine '--preserve-merges' with "
1783 "'--reschedule-failed-exec'"));
1786 if (!options.root) {
1787 if (argc < 1) {
1788 struct branch *branch;
1790 branch = branch_get(NULL);
1791 options.upstream_name = branch_get_upstream(branch,
1792 NULL);
1793 if (!options.upstream_name)
1794 error_on_missing_default_upstream();
1795 if (fork_point < 0)
1796 fork_point = 1;
1797 } else {
1798 options.upstream_name = argv[0];
1799 argc--;
1800 argv++;
1801 if (!strcmp(options.upstream_name, "-"))
1802 options.upstream_name = "@{-1}";
1804 options.upstream = peel_committish(options.upstream_name);
1805 if (!options.upstream)
1806 die(_("invalid upstream '%s'"), options.upstream_name);
1807 options.upstream_arg = options.upstream_name;
1808 } else {
1809 if (!options.onto_name) {
1810 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1811 &squash_onto, NULL, NULL) < 0)
1812 die(_("Could not create new root commit"));
1813 options.squash_onto = &squash_onto;
1814 options.onto_name = squash_onto_name =
1815 xstrdup(oid_to_hex(&squash_onto));
1816 } else
1817 options.root_with_onto = 1;
1819 options.upstream_name = NULL;
1820 options.upstream = NULL;
1821 if (argc > 1)
1822 usage_with_options(builtin_rebase_usage,
1823 builtin_rebase_options);
1824 options.upstream_arg = "--root";
1827 /* Make sure the branch to rebase onto is valid. */
1828 if (keep_base) {
1829 strbuf_reset(&buf);
1830 strbuf_addstr(&buf, options.upstream_name);
1831 strbuf_addstr(&buf, "...");
1832 options.onto_name = xstrdup(buf.buf);
1833 } else if (!options.onto_name)
1834 options.onto_name = options.upstream_name;
1835 if (strstr(options.onto_name, "...")) {
1836 if (get_oid_mb(options.onto_name, &merge_base) < 0) {
1837 if (keep_base)
1838 die(_("'%s': need exactly one merge base with branch"),
1839 options.upstream_name);
1840 else
1841 die(_("'%s': need exactly one merge base"),
1842 options.onto_name);
1844 options.onto = lookup_commit_or_die(&merge_base,
1845 options.onto_name);
1846 } else {
1847 options.onto = peel_committish(options.onto_name);
1848 if (!options.onto)
1849 die(_("Does not point to a valid commit '%s'"),
1850 options.onto_name);
1854 * If the branch to rebase is given, that is the branch we will rebase
1855 * branch_name -- branch/commit being rebased, or
1856 * HEAD (already detached)
1857 * orig_head -- commit object name of tip of the branch before rebasing
1858 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1860 if (argc == 1) {
1861 /* Is it "rebase other branchname" or "rebase other commit"? */
1862 branch_name = argv[0];
1863 options.switch_to = argv[0];
1865 /* Is it a local branch? */
1866 strbuf_reset(&buf);
1867 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1868 if (!read_ref(buf.buf, &options.orig_head)) {
1869 die_if_checked_out(buf.buf, 1);
1870 options.head_name = xstrdup(buf.buf);
1871 /* If not is it a valid ref (branch or commit)? */
1872 } else if (!get_oid(branch_name, &options.orig_head))
1873 options.head_name = NULL;
1874 else
1875 die(_("fatal: no such branch/commit '%s'"),
1876 branch_name);
1877 } else if (argc == 0) {
1878 /* Do not need to switch branches, we are already on it. */
1879 options.head_name =
1880 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1881 &flags));
1882 if (!options.head_name)
1883 die(_("No such ref: %s"), "HEAD");
1884 if (flags & REF_ISSYMREF) {
1885 if (!skip_prefix(options.head_name,
1886 "refs/heads/", &branch_name))
1887 branch_name = options.head_name;
1889 } else {
1890 FREE_AND_NULL(options.head_name);
1891 branch_name = "HEAD";
1893 if (get_oid("HEAD", &options.orig_head))
1894 die(_("Could not resolve HEAD to a revision"));
1895 } else
1896 BUG("unexpected number of arguments left to parse");
1898 if (fork_point > 0) {
1899 struct commit *head =
1900 lookup_commit_reference(the_repository,
1901 &options.orig_head);
1902 options.restrict_revision =
1903 get_fork_point(options.upstream_name, head);
1906 if (repo_read_index(the_repository) < 0)
1907 die(_("could not read index"));
1909 if (options.autostash) {
1910 struct lock_file lock_file = LOCK_INIT;
1911 int fd;
1913 fd = hold_locked_index(&lock_file, 0);
1914 refresh_cache(REFRESH_QUIET);
1915 if (0 <= fd)
1916 repo_update_index_if_able(the_repository, &lock_file);
1917 rollback_lock_file(&lock_file);
1919 if (has_unstaged_changes(the_repository, 1) ||
1920 has_uncommitted_changes(the_repository, 1)) {
1921 const char *autostash =
1922 state_dir_path("autostash", &options);
1923 struct child_process stash = CHILD_PROCESS_INIT;
1924 struct object_id oid;
1926 argv_array_pushl(&stash.args,
1927 "stash", "create", "autostash", NULL);
1928 stash.git_cmd = 1;
1929 stash.no_stdin = 1;
1930 strbuf_reset(&buf);
1931 if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
1932 die(_("Cannot autostash"));
1933 strbuf_trim_trailing_newline(&buf);
1934 if (get_oid(buf.buf, &oid))
1935 die(_("Unexpected stash response: '%s'"),
1936 buf.buf);
1937 strbuf_reset(&buf);
1938 strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
1940 if (safe_create_leading_directories_const(autostash))
1941 die(_("Could not create directory for '%s'"),
1942 options.state_dir);
1943 write_file(autostash, "%s", oid_to_hex(&oid));
1944 printf(_("Created autostash: %s\n"), buf.buf);
1945 if (reset_head(the_repository, NULL, "reset --hard",
1946 NULL, RESET_HEAD_HARD, NULL, NULL,
1947 DEFAULT_REFLOG_ACTION) < 0)
1948 die(_("could not reset --hard"));
1950 if (discard_index(the_repository->index) < 0 ||
1951 repo_read_index(the_repository) < 0)
1952 die(_("could not read index"));
1956 if (require_clean_work_tree(the_repository, "rebase",
1957 _("Please commit or stash them."), 1, 1)) {
1958 ret = 1;
1959 goto cleanup;
1963 * Now we are rebasing commits upstream..orig_head (or with --root,
1964 * everything leading up to orig_head) on top of onto.
1968 * Check if we are already based on onto with linear history,
1969 * in which case we could fast-forward without replacing the commits
1970 * with new commits recreated by replaying their changes.
1972 * Note that can_fast_forward() initializes merge_base, so we have to
1973 * call it before checking allow_preemptive_ff.
1975 if (can_fast_forward(options.onto, options.upstream, options.restrict_revision,
1976 &options.orig_head, &merge_base) &&
1977 allow_preemptive_ff) {
1978 int flag;
1980 if (!(options.flags & REBASE_FORCE)) {
1981 /* Lazily switch to the target branch if needed... */
1982 if (options.switch_to) {
1983 strbuf_reset(&buf);
1984 strbuf_addf(&buf, "%s: checkout %s",
1985 getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
1986 options.switch_to);
1987 if (reset_head(the_repository,
1988 &options.orig_head, "checkout",
1989 options.head_name,
1990 RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
1991 NULL, buf.buf,
1992 DEFAULT_REFLOG_ACTION) < 0) {
1993 ret = !!error(_("could not switch to "
1994 "%s"),
1995 options.switch_to);
1996 goto cleanup;
2000 if (!(options.flags & REBASE_NO_QUIET))
2001 ; /* be quiet */
2002 else if (!strcmp(branch_name, "HEAD") &&
2003 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2004 puts(_("HEAD is up to date."));
2005 else
2006 printf(_("Current branch %s is up to date.\n"),
2007 branch_name);
2008 ret = !!finish_rebase(&options);
2009 goto cleanup;
2010 } else if (!(options.flags & REBASE_NO_QUIET))
2011 ; /* be quiet */
2012 else if (!strcmp(branch_name, "HEAD") &&
2013 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2014 puts(_("HEAD is up to date, rebase forced."));
2015 else
2016 printf(_("Current branch %s is up to date, rebase "
2017 "forced.\n"), branch_name);
2020 /* If a hook exists, give it a chance to interrupt*/
2021 if (!ok_to_skip_pre_rebase &&
2022 run_hook_le(NULL, "pre-rebase", options.upstream_arg,
2023 argc ? argv[0] : NULL, NULL))
2024 die(_("The pre-rebase hook refused to rebase."));
2026 if (options.flags & REBASE_DIFFSTAT) {
2027 struct diff_options opts;
2029 if (options.flags & REBASE_VERBOSE) {
2030 if (is_null_oid(&merge_base))
2031 printf(_("Changes to %s:\n"),
2032 oid_to_hex(&options.onto->object.oid));
2033 else
2034 printf(_("Changes from %s to %s:\n"),
2035 oid_to_hex(&merge_base),
2036 oid_to_hex(&options.onto->object.oid));
2039 /* We want color (if set), but no pager */
2040 diff_setup(&opts);
2041 opts.stat_width = -1; /* use full terminal width */
2042 opts.stat_graph_width = -1; /* respect statGraphWidth config */
2043 opts.output_format |=
2044 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
2045 opts.detect_rename = DIFF_DETECT_RENAME;
2046 diff_setup_done(&opts);
2047 diff_tree_oid(is_null_oid(&merge_base) ?
2048 the_hash_algo->empty_tree : &merge_base,
2049 &options.onto->object.oid, "", &opts);
2050 diffcore_std(&opts);
2051 diff_flush(&opts);
2054 if (is_merge(&options))
2055 goto run_rebase;
2057 /* Detach HEAD and reset the tree */
2058 if (options.flags & REBASE_NO_QUIET)
2059 printf(_("First, rewinding head to replay your work on top of "
2060 "it...\n"));
2062 strbuf_addf(&msg, "%s: checkout %s",
2063 getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
2064 if (reset_head(the_repository, &options.onto->object.oid, "checkout", NULL,
2065 RESET_HEAD_DETACH | RESET_ORIG_HEAD |
2066 RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
2067 NULL, msg.buf, DEFAULT_REFLOG_ACTION))
2068 die(_("Could not detach HEAD"));
2069 strbuf_release(&msg);
2072 * If the onto is a proper descendant of the tip of the branch, then
2073 * we just fast-forwarded.
2075 strbuf_reset(&msg);
2076 if (oideq(&merge_base, &options.orig_head)) {
2077 printf(_("Fast-forwarded %s to %s.\n"),
2078 branch_name, options.onto_name);
2079 strbuf_addf(&msg, "rebase finished: %s onto %s",
2080 options.head_name ? options.head_name : "detached HEAD",
2081 oid_to_hex(&options.onto->object.oid));
2082 reset_head(the_repository, NULL, "Fast-forwarded", options.head_name,
2083 RESET_HEAD_REFS_ONLY, "HEAD", msg.buf,
2084 DEFAULT_REFLOG_ACTION);
2085 strbuf_release(&msg);
2086 ret = !!finish_rebase(&options);
2087 goto cleanup;
2090 strbuf_addf(&revisions, "%s..%s",
2091 options.root ? oid_to_hex(&options.onto->object.oid) :
2092 (options.restrict_revision ?
2093 oid_to_hex(&options.restrict_revision->object.oid) :
2094 oid_to_hex(&options.upstream->object.oid)),
2095 oid_to_hex(&options.orig_head));
2097 options.revisions = revisions.buf;
2099 run_rebase:
2100 ret = !!run_specific_rebase(&options, action);
2102 cleanup:
2103 strbuf_release(&buf);
2104 strbuf_release(&revisions);
2105 free(options.head_name);
2106 free(options.gpg_sign_opt);
2107 free(options.cmd);
2108 free(squash_onto_name);
2109 return ret;