1/*
2 * "git rebase" builtin command
3 *
4 * Copyright (c) 2018 Pratik Karki
5 */
6#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"
30static char const * const builtin_rebase_usage[] = {
32 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
33 "[<upstream>] [<branch>]"),
34 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
35 "--root [<branch>]"),
36 N_("git rebase --continue | --abort | --skip | --edit-todo"),
37 NULL
38};
39static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
41static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
42static GIT_PATH_FUNC(apply_dir, "rebase-apply")
43static GIT_PATH_FUNC(merge_dir, "rebase-merge")
44enum rebase_type {
46 REBASE_UNSPECIFIED = -1,
47 REBASE_AM,
48 REBASE_MERGE,
49 REBASE_INTERACTIVE,
50 REBASE_PRESERVE_MERGES
51};
52struct rebase_options {
54 enum rebase_type type;
55 const char *state_dir;
56 struct commit *upstream;
57 const char *upstream_name;
58 const char *upstream_arg;
59 char *head_name;
60 struct object_id orig_head;
61 struct commit *onto;
62 const char *onto_name;
63 const char *revisions;
64 const char *switch_to;
65 int root;
66 struct object_id *squash_onto;
67 struct commit *restrict_revision;
68 int dont_finish_rebase;
69 enum {
70 REBASE_NO_QUIET = 1<<0,
71 REBASE_VERBOSE = 1<<1,
72 REBASE_DIFFSTAT = 1<<2,
73 REBASE_FORCE = 1<<3,
74 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
75 } flags;
76 struct argv_array git_am_opts;
77 const char *action;
78 int signoff;
79 int allow_rerere_autoupdate;
80 int keep_empty;
81 int autosquash;
82 char *gpg_sign_opt;
83 int autostash;
84 char *cmd;
85 int allow_empty_message;
86 int rebase_merges, rebase_cousins;
87 char *strategy, *strategy_opts;
88 struct strbuf git_format_patch_opt;
89 int reschedule_failed_exec;
90 int use_legacy_rebase;
91};
92#define REBASE_OPTIONS_INIT { \
94 .type = REBASE_UNSPECIFIED, \
95 .flags = REBASE_NO_QUIET, \
96 .git_am_opts = ARGV_ARRAY_INIT, \
97 .git_format_patch_opt = STRBUF_INIT \
98 }
99static struct replay_opts get_replay_opts(const struct rebase_options *opts)
101{
102 struct replay_opts replay = REPLAY_OPTS_INIT;
103 replay.action = REPLAY_INTERACTIVE_REBASE;
105 sequencer_init_config(&replay);
106 replay.signoff = opts->signoff;
108 replay.allow_ff = !(opts->flags & REBASE_FORCE);
109 if (opts->allow_rerere_autoupdate)
110 replay.allow_rerere_auto = opts->allow_rerere_autoupdate;
111 replay.allow_empty = 1;
112 replay.allow_empty_message = opts->allow_empty_message;
113 replay.verbose = opts->flags & REBASE_VERBOSE;
114 replay.reschedule_failed_exec = opts->reschedule_failed_exec;
115 replay.gpg_sign = xstrdup_or_null(opts->gpg_sign_opt);
116 replay.strategy = opts->strategy;
117 if (opts->strategy_opts)
118 parse_strategy_opts(&replay, opts->strategy_opts);
119 return replay;
121}
122enum action {
124 ACTION_NONE = 0,
125 ACTION_CONTINUE,
126 ACTION_SKIP,
127 ACTION_ABORT,
128 ACTION_QUIT,
129 ACTION_EDIT_TODO,
130 ACTION_SHOW_CURRENT_PATCH,
131 ACTION_SHORTEN_OIDS,
132 ACTION_EXPAND_OIDS,
133 ACTION_CHECK_TODO_LIST,
134 ACTION_REARRANGE_SQUASH,
135 ACTION_ADD_EXEC
136};
137static const char *action_names[] = { "undefined",
139 "continue",
140 "skip",
141 "abort",
142 "quit",
143 "edit_todo",
144 "show_current_patch" };
145static int add_exec_commands(struct string_list *commands)
147{
148 const char *todo_file = rebase_path_todo();
149 struct todo_list todo_list = TODO_LIST_INIT;
150 int res;
151 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
153 return error_errno(_("could not read '%s'."), todo_file);
154 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
156 &todo_list)) {
157 todo_list_release(&todo_list);
158 return error(_("unusable todo list: '%s'"), todo_file);
159 }
160 todo_list_add_exec_commands(&todo_list, commands);
162 res = todo_list_write_to_file(the_repository, &todo_list,
163 todo_file, NULL, NULL, -1, 0);
164 todo_list_release(&todo_list);
165 if (res)
167 return error_errno(_("could not write '%s'."), todo_file);
168 return 0;
169}
170static int rearrange_squash_in_todo_file(void)
172{
173 const char *todo_file = rebase_path_todo();
174 struct todo_list todo_list = TODO_LIST_INIT;
175 int res = 0;
176 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
178 return error_errno(_("could not read '%s'."), todo_file);
179 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
180 &todo_list)) {
181 todo_list_release(&todo_list);
182 return error(_("unusable todo list: '%s'"), todo_file);
183 }
184 res = todo_list_rearrange_squash(&todo_list);
186 if (!res)
187 res = todo_list_write_to_file(the_repository, &todo_list,
188 todo_file, NULL, NULL, -1, 0);
189 todo_list_release(&todo_list);
191 if (res)
193 return error_errno(_("could not write '%s'."), todo_file);
194 return 0;
195}
196static int transform_todo_file(unsigned flags)
198{
199 const char *todo_file = rebase_path_todo();
200 struct todo_list todo_list = TODO_LIST_INIT;
201 int res;
202 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
204 return error_errno(_("could not read '%s'."), todo_file);
205 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
207 &todo_list)) {
208 todo_list_release(&todo_list);
209 return error(_("unusable todo list: '%s'"), todo_file);
210 }
211 res = todo_list_write_to_file(the_repository, &todo_list, todo_file,
213 NULL, NULL, -1, flags);
214 todo_list_release(&todo_list);
215 if (res)
217 return error_errno(_("could not write '%s'."), todo_file);
218 return 0;
219}
220static int edit_todo_file(unsigned flags)
222{
223 const char *todo_file = rebase_path_todo();
224 struct todo_list todo_list = TODO_LIST_INIT,
225 new_todo = TODO_LIST_INIT;
226 int res = 0;
227 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
229 return error_errno(_("could not read '%s'."), todo_file);
230 strbuf_stripspace(&todo_list.buf, 1);
232 res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
233 if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
234 NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
235 res = error_errno(_("could not write '%s'"), todo_file);
236 todo_list_release(&todo_list);
238 todo_list_release(&new_todo);
239 return res;
241}
242static int get_revision_ranges(struct commit *upstream, struct commit *onto,
244 const char **head_hash,
245 char **revisions, char **shortrevisions)
246{
247 struct commit *base_rev = upstream ? upstream : onto;
248 const char *shorthead;
249 struct object_id orig_head;
250 if (get_oid("HEAD", &orig_head))
252 return error(_("no HEAD?"));
253 *head_hash = find_unique_abbrev(&orig_head, GIT_MAX_HEXSZ);
255 *revisions = xstrfmt("%s...%s", oid_to_hex(&base_rev->object.oid),
256 *head_hash);
257 shorthead = find_unique_abbrev(&orig_head, DEFAULT_ABBREV);
259 if (upstream) {
261 const char *shortrev;
262 shortrev = find_unique_abbrev(&base_rev->object.oid,
264 DEFAULT_ABBREV);
265 *shortrevisions = xstrfmt("%s..%s", shortrev, shorthead);
267 } else
268 *shortrevisions = xstrdup(shorthead);
269 return 0;
271}
272static int init_basic_state(struct replay_opts *opts, const char *head_name,
274 struct commit *onto, const char *orig_head)
275{
276 FILE *interactive;
277 if (!is_directory(merge_dir()) && mkdir_in_gitdir(merge_dir()))
279 return error_errno(_("could not create temporary %s"), merge_dir());
280 delete_reflog("REBASE_HEAD");
282 interactive = fopen(path_interactive(), "w");
284 if (!interactive)
285 return error_errno(_("could not mark as interactive"));
286 fclose(interactive);
287 return write_basic_state(opts, head_name, onto, orig_head);
289}
290static void split_exec_commands(const char *cmd, struct string_list *commands)
292{
293 if (cmd && *cmd) {
294 string_list_split(commands, cmd, '\n', -1);
295 /* rebase.c adds a new line to cmd after every command,
297 * so here the last command is always empty */
298 string_list_remove_empty_items(commands, 0);
299 }
300}
301static int do_interactive_rebase(struct rebase_options *opts, unsigned flags)
303{
304 int ret;
305 const char *head_hash = NULL;
306 char *revisions = NULL, *shortrevisions = NULL;
307 struct argv_array make_script_args = ARGV_ARRAY_INIT;
308 struct todo_list todo_list = TODO_LIST_INIT;
309 struct replay_opts replay = get_replay_opts(opts);
310 struct string_list commands = STRING_LIST_INIT_DUP;
311 if (prepare_branch_to_be_rebased(the_repository, &replay,
313 opts->switch_to))
314 return -1;
315 if (get_revision_ranges(opts->upstream, opts->onto, &head_hash,
317 &revisions, &shortrevisions))
318 return -1;
319 if (init_basic_state(&replay,
321 opts->head_name ? opts->head_name : "detached HEAD",
322 opts->onto, head_hash)) {
323 free(revisions);
324 free(shortrevisions);
325 return -1;
327 }
328 if (!opts->upstream && opts->squash_onto)
330 write_file(path_squash_onto(), "%s\n",
331 oid_to_hex(opts->squash_onto));
332 argv_array_pushl(&make_script_args, "", revisions, NULL);
334 if (opts->restrict_revision)
335 argv_array_push(&make_script_args,
336 oid_to_hex(&opts->restrict_revision->object.oid));
337 ret = sequencer_make_script(the_repository, &todo_list.buf,
339 make_script_args.argc, make_script_args.argv,
340 flags);
341 if (ret)
343 error(_("could not generate todo list"));
344 else {
345 discard_cache();
346 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
347 &todo_list))
348 BUG("unusable todo list");
349 split_exec_commands(opts->cmd, &commands);
351 ret = complete_action(the_repository, &replay, flags,
352 shortrevisions, opts->onto_name, opts->onto, head_hash,
353 &commands, opts->autosquash, &todo_list);
354 }
355 string_list_clear(&commands, 0);
357 free(revisions);
358 free(shortrevisions);
359 todo_list_release(&todo_list);
360 argv_array_clear(&make_script_args);
361 return ret;
363}
364static int run_rebase_interactive(struct rebase_options *opts,
366 enum action command)
367{
368 unsigned flags = 0;
369 int abbreviate_commands = 0, ret = 0;
370 git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands);
372 flags |= opts->keep_empty ? TODO_LIST_KEEP_EMPTY : 0;
374 flags |= abbreviate_commands ? TODO_LIST_ABBREVIATE_CMDS : 0;
375 flags |= opts->rebase_merges ? TODO_LIST_REBASE_MERGES : 0;
376 flags |= opts->rebase_cousins > 0 ? TODO_LIST_REBASE_COUSINS : 0;
377 flags |= command == ACTION_SHORTEN_OIDS ? TODO_LIST_SHORTEN_IDS : 0;
378 switch (command) {
380 case ACTION_NONE: {
381 if (!opts->onto && !opts->upstream)
382 die(_("a base commit must be provided with --upstream or --onto"));
383 ret = do_interactive_rebase(opts, flags);
385 break;
386 }
387 case ACTION_SKIP: {
388 struct string_list merge_rr = STRING_LIST_INIT_DUP;
389 rerere_clear(the_repository, &merge_rr);
391 }
392 /* fallthrough */
393 case ACTION_CONTINUE: {
394 struct replay_opts replay_opts = get_replay_opts(opts);
395 ret = sequencer_continue(the_repository, &replay_opts);
397 break;
398 }
399 case ACTION_EDIT_TODO:
400 ret = edit_todo_file(flags);
401 break;
402 case ACTION_SHOW_CURRENT_PATCH: {
403 struct child_process cmd = CHILD_PROCESS_INIT;
404 cmd.git_cmd = 1;
406 argv_array_pushl(&cmd.args, "show", "REBASE_HEAD", "--", NULL);
407 ret = run_command(&cmd);
408 break;
410 }
411 case ACTION_SHORTEN_OIDS:
412 case ACTION_EXPAND_OIDS:
413 ret = transform_todo_file(flags);
414 break;
415 case ACTION_CHECK_TODO_LIST:
416 ret = check_todo_list_from_file(the_repository);
417 break;
418 case ACTION_REARRANGE_SQUASH:
419 ret = rearrange_squash_in_todo_file();
420 break;
421 case ACTION_ADD_EXEC: {
422 struct string_list commands = STRING_LIST_INIT_DUP;
423 split_exec_commands(opts->cmd, &commands);
425 ret = add_exec_commands(&commands);
426 string_list_clear(&commands, 0);
427 break;
428 }
429 default:
430 BUG("invalid command '%d'", command);
431 }
432 return ret;
434}
435static const char * const builtin_rebase_interactive_usage[] = {
437 N_("git rebase--interactive [<options>]"),
438 NULL
439};
440int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
442{
443 struct rebase_options opts = REBASE_OPTIONS_INIT;
444 struct object_id squash_onto = null_oid;
445 enum action command = ACTION_NONE;
446 struct option options[] = {
447 OPT_NEGBIT(0, "ff", &opts.flags, N_("allow fast-forward"),
448 REBASE_FORCE),
449 OPT_BOOL(0, "keep-empty", &opts.keep_empty, N_("keep empty commits")),
450 OPT_BOOL(0, "allow-empty-message", &opts.allow_empty_message,
451 N_("allow commits with empty messages")),
452 OPT_BOOL(0, "rebase-merges", &opts.rebase_merges, N_("rebase merge commits")),
453 OPT_BOOL(0, "rebase-cousins", &opts.rebase_cousins,
454 N_("keep original branch points of cousins")),
455 OPT_BOOL(0, "autosquash", &opts.autosquash,
456 N_("move commits that begin with squash!/fixup!")),
457 OPT_BOOL(0, "signoff", &opts.signoff, N_("sign commits")),
458 OPT_BIT('v', "verbose", &opts.flags,
459 N_("display a diffstat of what changed upstream"),
460 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
461 OPT_CMDMODE(0, "continue", &command, N_("continue rebase"),
462 ACTION_CONTINUE),
463 OPT_CMDMODE(0, "skip", &command, N_("skip commit"), ACTION_SKIP),
464 OPT_CMDMODE(0, "edit-todo", &command, N_("edit the todo list"),
465 ACTION_EDIT_TODO),
466 OPT_CMDMODE(0, "show-current-patch", &command, N_("show the current patch"),
467 ACTION_SHOW_CURRENT_PATCH),
468 OPT_CMDMODE(0, "shorten-ids", &command,
469 N_("shorten commit ids in the todo list"), ACTION_SHORTEN_OIDS),
470 OPT_CMDMODE(0, "expand-ids", &command,
471 N_("expand commit ids in the todo list"), ACTION_EXPAND_OIDS),
472 OPT_CMDMODE(0, "check-todo-list", &command,
473 N_("check the todo list"), ACTION_CHECK_TODO_LIST),
474 OPT_CMDMODE(0, "rearrange-squash", &command,
475 N_("rearrange fixup/squash lines"), ACTION_REARRANGE_SQUASH),
476 OPT_CMDMODE(0, "add-exec-commands", &command,
477 N_("insert exec commands in todo list"), ACTION_ADD_EXEC),
478 { OPTION_CALLBACK, 0, "onto", &opts.onto, N_("onto"), N_("onto"),
479 PARSE_OPT_NONEG, parse_opt_commit, 0 },
480 { OPTION_CALLBACK, 0, "restrict-revision", &opts.restrict_revision,
481 N_("restrict-revision"), N_("restrict revision"),
482 PARSE_OPT_NONEG, parse_opt_commit, 0 },
483 { OPTION_CALLBACK, 0, "squash-onto", &squash_onto, N_("squash-onto"),
484 N_("squash onto"), PARSE_OPT_NONEG, parse_opt_object_id, 0 },
485 { OPTION_CALLBACK, 0, "upstream", &opts.upstream, N_("upstream"),
486 N_("the upstream commit"), PARSE_OPT_NONEG, parse_opt_commit,
487 0 },
488 OPT_STRING(0, "head-name", &opts.head_name, N_("head-name"), N_("head name")),
489 { OPTION_STRING, 'S', "gpg-sign", &opts.gpg_sign_opt, N_("key-id"),
490 N_("GPG-sign commits"),
491 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
492 OPT_STRING(0, "strategy", &opts.strategy, N_("strategy"),
493 N_("rebase strategy")),
494 OPT_STRING(0, "strategy-opts", &opts.strategy_opts, N_("strategy-opts"),
495 N_("strategy options")),
496 OPT_STRING(0, "switch-to", &opts.switch_to, N_("switch-to"),
497 N_("the branch or commit to checkout")),
498 OPT_STRING(0, "onto-name", &opts.onto_name, N_("onto-name"), N_("onto name")),
499 OPT_STRING(0, "cmd", &opts.cmd, N_("cmd"), N_("the command to run")),
500 OPT_RERERE_AUTOUPDATE(&opts.allow_rerere_autoupdate),
501 OPT_BOOL(0, "reschedule-failed-exec", &opts.reschedule_failed_exec,
502 N_("automatically re-schedule any `exec` that fails")),
503 OPT_END()
504 };
505 opts.rebase_cousins = -1;
507 if (argc == 1)
509 usage_with_options(builtin_rebase_interactive_usage, options);
510 argc = parse_options(argc, argv, NULL, options,
512 builtin_rebase_interactive_usage, PARSE_OPT_KEEP_ARGV0);
513 if (!is_null_oid(&squash_onto))
515 opts.squash_onto = &squash_onto;
516 if (opts.rebase_cousins >= 0 && !opts.rebase_merges)
518 warning(_("--[no-]rebase-cousins has no effect without "
519 "--rebase-merges"));
520 return !!run_rebase_interactive(&opts, command);
522}
523static int is_interactive(struct rebase_options *opts)
525{
526 return opts->type == REBASE_INTERACTIVE ||
527 opts->type == REBASE_PRESERVE_MERGES;
528}
529static void imply_interactive(struct rebase_options *opts, const char *option)
531{
532 switch (opts->type) {
533 case REBASE_AM:
534 die(_("%s requires an interactive rebase"), option);
535 break;
536 case REBASE_INTERACTIVE:
537 case REBASE_PRESERVE_MERGES:
538 break;
539 case REBASE_MERGE:
540 /* we now implement --merge via --interactive */
541 default:
542 opts->type = REBASE_INTERACTIVE; /* implied */
543 break;
544 }
545}
546/* Returns the filename prefixed by the state_dir */
548static const char *state_dir_path(const char *filename, struct rebase_options *opts)
549{
550 static struct strbuf path = STRBUF_INIT;
551 static size_t prefix_len;
552 if (!prefix_len) {
554 strbuf_addf(&path, "%s/", opts->state_dir);
555 prefix_len = path.len;
556 }
557 strbuf_setlen(&path, prefix_len);
559 strbuf_addstr(&path, filename);
560 return path.buf;
561}
562/* Read one file, then strip line endings */
564static int read_one(const char *path, struct strbuf *buf)
565{
566 if (strbuf_read_file(buf, path, 0) < 0)
567 return error_errno(_("could not read '%s'"), path);
568 strbuf_trim_trailing_newline(buf);
569 return 0;
570}
571/* Initialize the rebase options from the state directory. */
573static int read_basic_state(struct rebase_options *opts)
574{
575 struct strbuf head_name = STRBUF_INIT;
576 struct strbuf buf = STRBUF_INIT;
577 struct object_id oid;
578 if (read_one(state_dir_path("head-name", opts), &head_name) ||
580 read_one(state_dir_path("onto", opts), &buf))
581 return -1;
582 opts->head_name = starts_with(head_name.buf, "refs/") ?
583 xstrdup(head_name.buf) : NULL;
584 strbuf_release(&head_name);
585 if (get_oid(buf.buf, &oid))
586 return error(_("could not get 'onto': '%s'"), buf.buf);
587 opts->onto = lookup_commit_or_die(&oid, buf.buf);
588 /*
590 * We always write to orig-head, but interactive rebase used to write to
591 * head. Fall back to reading from head to cover for the case that the
592 * user upgraded git with an ongoing interactive rebase.
593 */
594 strbuf_reset(&buf);
595 if (file_exists(state_dir_path("orig-head", opts))) {
596 if (read_one(state_dir_path("orig-head", opts), &buf))
597 return -1;
598 } else if (read_one(state_dir_path("head", opts), &buf))
599 return -1;
600 if (get_oid(buf.buf, &opts->orig_head))
601 return error(_("invalid orig-head: '%s'"), buf.buf);
602 if (file_exists(state_dir_path("quiet", opts)))
604 opts->flags &= ~REBASE_NO_QUIET;
605 else
606 opts->flags |= REBASE_NO_QUIET;
607 if (file_exists(state_dir_path("verbose", opts)))
609 opts->flags |= REBASE_VERBOSE;
610 if (file_exists(state_dir_path("signoff", opts))) {
612 opts->signoff = 1;
613 opts->flags |= REBASE_FORCE;
614 }
615 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
617 strbuf_reset(&buf);
618 if (read_one(state_dir_path("allow_rerere_autoupdate", opts),
619 &buf))
620 return -1;
621 if (!strcmp(buf.buf, "--rerere-autoupdate"))
622 opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
623 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
624 opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
625 else
626 warning(_("ignoring invalid allow_rerere_autoupdate: "
627 "'%s'"), buf.buf);
628 }
629 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
631 strbuf_reset(&buf);
632 if (read_one(state_dir_path("gpg_sign_opt", opts),
633 &buf))
634 return -1;
635 free(opts->gpg_sign_opt);
636 opts->gpg_sign_opt = xstrdup(buf.buf);
637 }
638 if (file_exists(state_dir_path("strategy", opts))) {
640 strbuf_reset(&buf);
641 if (read_one(state_dir_path("strategy", opts), &buf))
642 return -1;
643 free(opts->strategy);
644 opts->strategy = xstrdup(buf.buf);
645 }
646 if (file_exists(state_dir_path("strategy_opts", opts))) {
648 strbuf_reset(&buf);
649 if (read_one(state_dir_path("strategy_opts", opts), &buf))
650 return -1;
651 free(opts->strategy_opts);
652 opts->strategy_opts = xstrdup(buf.buf);
653 }
654 strbuf_release(&buf);
656 return 0;
658}
659static int rebase_write_basic_state(struct rebase_options *opts)
661{
662 write_file(state_dir_path("head-name", opts), "%s",
663 opts->head_name ? opts->head_name : "detached HEAD");
664 write_file(state_dir_path("onto", opts), "%s",
665 opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
666 write_file(state_dir_path("orig-head", opts), "%s",
667 oid_to_hex(&opts->orig_head));
668 write_file(state_dir_path("quiet", opts), "%s",
669 opts->flags & REBASE_NO_QUIET ? "" : "t");
670 if (opts->flags & REBASE_VERBOSE)
671 write_file(state_dir_path("verbose", opts), "%s", "");
672 if (opts->strategy)
673 write_file(state_dir_path("strategy", opts), "%s",
674 opts->strategy);
675 if (opts->strategy_opts)
676 write_file(state_dir_path("strategy_opts", opts), "%s",
677 opts->strategy_opts);
678 if (opts->allow_rerere_autoupdate > 0)
679 write_file(state_dir_path("allow_rerere_autoupdate", opts),
680 "-%s-rerere-autoupdate",
681 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
682 "" : "-no");
683 if (opts->gpg_sign_opt)
684 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
685 opts->gpg_sign_opt);
686 if (opts->signoff)
687 write_file(state_dir_path("strategy", opts), "--signoff");
688 return 0;
690}
691static int apply_autostash(struct rebase_options *opts)
693{
694 const char *path = state_dir_path("autostash", opts);
695 struct strbuf autostash = STRBUF_INIT;
696 struct child_process stash_apply = CHILD_PROCESS_INIT;
697 if (!file_exists(path))
699 return 0;
700 if (read_one(path, &autostash))
702 return error(_("Could not read '%s'"), path);
703 /* Ensure that the hash is not mistaken for a number */
704 strbuf_addstr(&autostash, "^0");
705 argv_array_pushl(&stash_apply.args,
706 "stash", "apply", autostash.buf, NULL);
707 stash_apply.git_cmd = 1;
708 stash_apply.no_stderr = stash_apply.no_stdout =
709 stash_apply.no_stdin = 1;
710 if (!run_command(&stash_apply))
711 printf(_("Applied autostash.\n"));
712 else {
713 struct argv_array args = ARGV_ARRAY_INIT;
714 int res = 0;
715 argv_array_pushl(&args,
717 "stash", "store", "-m", "autostash", "-q",
718 autostash.buf, NULL);
719 if (run_command_v_opt(args.argv, RUN_GIT_CMD))
720 res = error(_("Cannot store %s"), autostash.buf);
721 argv_array_clear(&args);
722 strbuf_release(&autostash);
723 if (res)
724 return res;
725 fprintf(stderr,
727 _("Applying autostash resulted in conflicts.\n"
728 "Your changes are safe in the stash.\n"
729 "You can run \"git stash pop\" or \"git stash drop\" "
730 "at any time.\n"));
731 }
732 strbuf_release(&autostash);
734 return 0;
735}
736static int finish_rebase(struct rebase_options *opts)
738{
739 struct strbuf dir = STRBUF_INIT;
740 const char *argv_gc_auto[] = { "gc", "--auto", NULL };
741 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
743 apply_autostash(opts);
744 close_all_packs(the_repository->objects);
745 /*
746 * We ignore errors in 'gc --auto', since the
747 * user should see them.
748 */
749 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
750 strbuf_addstr(&dir, opts->state_dir);
751 remove_dir_recursively(&dir, 0);
752 strbuf_release(&dir);
753 return 0;
755}
756static struct commit *peel_committish(const char *name)
758{
759 struct object *obj;
760 struct object_id oid;
761 if (get_oid(name, &oid))
763 return NULL;
764 obj = parse_object(the_repository, &oid);
765 return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
766}
767static void add_var(struct strbuf *buf, const char *name, const char *value)
769{
770 if (!value)
771 strbuf_addf(buf, "unset %s; ", name);
772 else {
773 strbuf_addf(buf, "%s=", name);
774 sq_quote_buf(buf, value);
775 strbuf_addstr(buf, "; ");
776 }
777}
778#define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
780#define RESET_HEAD_DETACH (1<<0)
782#define RESET_HEAD_HARD (1<<1)
783#define RESET_HEAD_RUN_POST_CHECKOUT_HOOK (1<<2)
784#define RESET_HEAD_REFS_ONLY (1<<3)
785#define RESET_ORIG_HEAD (1<<4)
786static int reset_head(struct object_id *oid, const char *action,
788 const char *switch_to_branch, unsigned flags,
789 const char *reflog_orig_head, const char *reflog_head)
790{
791 unsigned detach_head = flags & RESET_HEAD_DETACH;
792 unsigned reset_hard = flags & RESET_HEAD_HARD;
793 unsigned run_hook = flags & RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
794 unsigned refs_only = flags & RESET_HEAD_REFS_ONLY;
795 unsigned update_orig_head = flags & RESET_ORIG_HEAD;
796 struct object_id head_oid;
797 struct tree_desc desc[2] = { { NULL }, { NULL } };
798 struct lock_file lock = LOCK_INIT;
799 struct unpack_trees_options unpack_tree_opts;
800 struct tree *tree;
801 const char *reflog_action;
802 struct strbuf msg = STRBUF_INIT;
803 size_t prefix_len;
804 struct object_id *orig = NULL, oid_orig,
805 *old_orig = NULL, oid_old_orig;
806 int ret = 0, nr = 0;
807 if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
809 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
810 if (!refs_only && hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
812 ret = -1;
813 goto leave_reset_head;
814 }
815 if ((!oid || !reset_hard) && get_oid("HEAD", &head_oid)) {
817 ret = error(_("could not determine HEAD revision"));
818 goto leave_reset_head;
819 }
820 if (!oid)
822 oid = &head_oid;
823 if (refs_only)
825 goto reset_head_refs;
826 memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
828 setup_unpack_trees_porcelain(&unpack_tree_opts, action);
829 unpack_tree_opts.head_idx = 1;
830 unpack_tree_opts.src_index = the_repository->index;
831 unpack_tree_opts.dst_index = the_repository->index;
832 unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
833 unpack_tree_opts.update = 1;
834 unpack_tree_opts.merge = 1;
835 if (!detach_head)
836 unpack_tree_opts.reset = 1;
837 if (repo_read_index_unmerged(the_repository) < 0) {
839 ret = error(_("could not read index"));
840 goto leave_reset_head;
841 }
842 if (!reset_hard && !fill_tree_descriptor(&desc[nr++], &head_oid)) {
844 ret = error(_("failed to find tree of %s"),
845 oid_to_hex(&head_oid));
846 goto leave_reset_head;
847 }
848 if (!fill_tree_descriptor(&desc[nr++], oid)) {
850 ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
851 goto leave_reset_head;
852 }
853 if (unpack_trees(nr, desc, &unpack_tree_opts)) {
855 ret = -1;
856 goto leave_reset_head;
857 }
858 tree = parse_tree_indirect(oid);
860 prime_cache_tree(the_repository, the_repository->index, tree);
861 if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0) {
863 ret = error(_("could not write index"));
864 goto leave_reset_head;
865 }
866reset_head_refs:
868 reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
869 strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
870 prefix_len = msg.len;
871 if (update_orig_head) {
873 if (!get_oid("ORIG_HEAD", &oid_old_orig))
874 old_orig = &oid_old_orig;
875 if (!get_oid("HEAD", &oid_orig)) {
876 orig = &oid_orig;
877 if (!reflog_orig_head) {
878 strbuf_addstr(&msg, "updating ORIG_HEAD");
879 reflog_orig_head = msg.buf;
880 }
881 update_ref(reflog_orig_head, "ORIG_HEAD", orig,
882 old_orig, 0, UPDATE_REFS_MSG_ON_ERR);
883 } else if (old_orig)
884 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
885 }
886 if (!reflog_head) {
888 strbuf_setlen(&msg, prefix_len);
889 strbuf_addstr(&msg, "updating HEAD");
890 reflog_head = msg.buf;
891 }
892 if (!switch_to_branch)
893 ret = update_ref(reflog_head, "HEAD", oid, orig,
894 detach_head ? REF_NO_DEREF : 0,
895 UPDATE_REFS_MSG_ON_ERR);
896 else {
897 ret = update_ref(reflog_head, switch_to_branch, oid,
898 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
899 if (!ret)
900 ret = create_symref("HEAD", switch_to_branch,
901 reflog_head);
902 }
903 if (run_hook)
904 run_hook_le(NULL, "post-checkout",
905 oid_to_hex(orig ? orig : &null_oid),
906 oid_to_hex(oid), "1", NULL);
907leave_reset_head:
909 strbuf_release(&msg);
910 rollback_lock_file(&lock);
911 while (nr)
912 free((void *)desc[--nr].buffer);
913 return ret;
914}
915static int move_to_original_branch(struct rebase_options *opts)
917{
918 struct strbuf orig_head_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
919 int ret;
920 if (!opts->head_name)
922 return 0; /* nothing to move back to */
923 if (!opts->onto)
925 BUG("move_to_original_branch without onto");
926 strbuf_addf(&orig_head_reflog, "rebase finished: %s onto %s",
928 opts->head_name, oid_to_hex(&opts->onto->object.oid));
929 strbuf_addf(&head_reflog, "rebase finished: returning to %s",
930 opts->head_name);
931 ret = reset_head(NULL, "", opts->head_name, RESET_HEAD_REFS_ONLY,
932 orig_head_reflog.buf, head_reflog.buf);
933 strbuf_release(&orig_head_reflog);
935 strbuf_release(&head_reflog);
936 return ret;
937}
938static const char *resolvemsg =
940N_("Resolve all conflicts manually, mark them as resolved with\n"
941"\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
942"You can instead skip this commit: run \"git rebase --skip\".\n"
943"To abort and get back to the state before \"git rebase\", run "
944"\"git rebase --abort\".");
945static int run_am(struct rebase_options *opts)
947{
948 struct child_process am = CHILD_PROCESS_INIT;
949 struct child_process format_patch = CHILD_PROCESS_INIT;
950 struct strbuf revisions = STRBUF_INIT;
951 int status;
952 char *rebased_patches;
953 am.git_cmd = 1;
955 argv_array_push(&am.args, "am");
956 if (opts->action && !strcmp("continue", opts->action)) {
958 argv_array_push(&am.args, "--resolved");
959 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
960 if (opts->gpg_sign_opt)
961 argv_array_push(&am.args, opts->gpg_sign_opt);
962 status = run_command(&am);
963 if (status)
964 return status;
965 return move_to_original_branch(opts);
967 }
968 if (opts->action && !strcmp("skip", opts->action)) {
969 argv_array_push(&am.args, "--skip");
970 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
971 status = run_command(&am);
972 if (status)
973 return status;
974 return move_to_original_branch(opts);
976 }
977 if (opts->action && !strcmp("show-current-patch", opts->action)) {
978 argv_array_push(&am.args, "--show-current-patch");
979 return run_command(&am);
980 }
981 strbuf_addf(&revisions, "%s...%s",
983 oid_to_hex(opts->root ?
984 /* this is now equivalent to !opts->upstream */
985 &opts->onto->object.oid :
986 &opts->upstream->object.oid),
987 oid_to_hex(&opts->orig_head));
988 rebased_patches = xstrdup(git_path("rebased-patches"));
990 format_patch.out = open(rebased_patches,
991 O_WRONLY | O_CREAT | O_TRUNC, 0666);
992 if (format_patch.out < 0) {
993 status = error_errno(_("could not open '%s' for writing"),
994 rebased_patches);
995 free(rebased_patches);
996 argv_array_clear(&am.args);
997 return status;
998 }
999 format_patch.git_cmd = 1;
1001 argv_array_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
1002 "--full-index", "--cherry-pick", "--right-only",
1003 "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
1004 "--no-cover-letter", "--pretty=mboxrd", "--topo-order", NULL);
1005 if (opts->git_format_patch_opt.len)
1006 argv_array_split(&format_patch.args,
1007 opts->git_format_patch_opt.buf);
1008 argv_array_push(&format_patch.args, revisions.buf);
1009 if (opts->restrict_revision)
1010 argv_array_pushf(&format_patch.args, "^%s",
1011 oid_to_hex(&opts->restrict_revision->object.oid));
1012 status = run_command(&format_patch);
1014 if (status) {
1015 unlink(rebased_patches);
1016 free(rebased_patches);
1017 argv_array_clear(&am.args);
1018 reset_head(&opts->orig_head, "checkout", opts->head_name, 0,
1020 "HEAD", NULL);
1021 error(_("\ngit encountered an error while preparing the "
1022 "patches to replay\n"
1023 "these revisions:\n"
1024 "\n %s\n\n"
1025 "As a result, git cannot rebase them."),
1026 opts->revisions);
1027 strbuf_release(&revisions);
1029 return status;
1030 }
1031 strbuf_release(&revisions);
1032 am.in = open(rebased_patches, O_RDONLY);
1034 if (am.in < 0) {
1035 status = error_errno(_("could not open '%s' for reading"),
1036 rebased_patches);
1037 free(rebased_patches);
1038 argv_array_clear(&am.args);
1039 return status;
1040 }
1041 argv_array_pushv(&am.args, opts->git_am_opts.argv);
1043 argv_array_push(&am.args, "--rebasing");
1044 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
1045 argv_array_push(&am.args, "--patch-format=mboxrd");
1046 if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
1047 argv_array_push(&am.args, "--rerere-autoupdate");
1048 else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
1049 argv_array_push(&am.args, "--no-rerere-autoupdate");
1050 if (opts->gpg_sign_opt)
1051 argv_array_push(&am.args, opts->gpg_sign_opt);
1052 status = run_command(&am);
1053 unlink(rebased_patches);
1054 free(rebased_patches);
1055 if (!status) {
1057 return move_to_original_branch(opts);
1058 }
1059 if (is_directory(opts->state_dir))
1061 rebase_write_basic_state(opts);
1062 return status;
1064}
1065static int run_specific_rebase(struct rebase_options *opts, enum action action)
1067{
1068 const char *argv[] = { NULL, NULL };
1069 struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
1070 int status;
1071 const char *backend, *backend_func;
1072 if (opts->type == REBASE_INTERACTIVE) {
1074 /* Run builtin interactive rebase */
1075 setenv("GIT_CHERRY_PICK_HELP", resolvemsg, 1);
1076 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
1077 setenv("GIT_SEQUENCE_EDITOR", ":", 1);
1078 opts->autosquash = 0;
1079 }
1080 if (opts->gpg_sign_opt) {
1081 /* remove the leading "-S" */
1082 char *tmp = xstrdup(opts->gpg_sign_opt + 2);
1083 free(opts->gpg_sign_opt);
1084 opts->gpg_sign_opt = tmp;
1085 }
1086 status = run_rebase_interactive(opts, action);
1088 goto finished_rebase;
1089 }
1090 if (opts->type == REBASE_AM) {
1092 status = run_am(opts);
1093 goto finished_rebase;
1094 }
1095 add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
1097 add_var(&script_snippet, "state_dir", opts->state_dir);
1098 add_var(&script_snippet, "upstream_name", opts->upstream_name);
1100 add_var(&script_snippet, "upstream", opts->upstream ?
1101 oid_to_hex(&opts->upstream->object.oid) : NULL);
1102 add_var(&script_snippet, "head_name",
1103 opts->head_name ? opts->head_name : "detached HEAD");
1104 add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
1105 add_var(&script_snippet, "onto", opts->onto ?
1106 oid_to_hex(&opts->onto->object.oid) : NULL);
1107 add_var(&script_snippet, "onto_name", opts->onto_name);
1108 add_var(&script_snippet, "revisions", opts->revisions);
1109 add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
1110 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
1111 add_var(&script_snippet, "GIT_QUIET",
1112 opts->flags & REBASE_NO_QUIET ? "" : "t");
1113 sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
1114 add_var(&script_snippet, "git_am_opt", buf.buf);
1115 strbuf_release(&buf);
1116 add_var(&script_snippet, "verbose",
1117 opts->flags & REBASE_VERBOSE ? "t" : "");
1118 add_var(&script_snippet, "diffstat",
1119 opts->flags & REBASE_DIFFSTAT ? "t" : "");
1120 add_var(&script_snippet, "force_rebase",
1121 opts->flags & REBASE_FORCE ? "t" : "");
1122 if (opts->switch_to)
1123 add_var(&script_snippet, "switch_to", opts->switch_to);
1124 add_var(&script_snippet, "action", opts->action ? opts->action : "");
1125 add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
1126 add_var(&script_snippet, "allow_rerere_autoupdate",
1127 opts->allow_rerere_autoupdate ?
1128 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
1129 "--rerere-autoupdate" : "--no-rerere-autoupdate" : "");
1130 add_var(&script_snippet, "keep_empty", opts->keep_empty ? "yes" : "");
1131 add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
1132 add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
1133 add_var(&script_snippet, "cmd", opts->cmd);
1134 add_var(&script_snippet, "allow_empty_message",
1135 opts->allow_empty_message ? "--allow-empty-message" : "");
1136 add_var(&script_snippet, "rebase_merges",
1137 opts->rebase_merges ? "t" : "");
1138 add_var(&script_snippet, "rebase_cousins",
1139 opts->rebase_cousins ? "t" : "");
1140 add_var(&script_snippet, "strategy", opts->strategy);
1141 add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
1142 add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
1143 add_var(&script_snippet, "squash_onto",
1144 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
1145 add_var(&script_snippet, "git_format_patch_opt",
1146 opts->git_format_patch_opt.buf);
1147 if (is_interactive(opts) &&
1149 !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
1150 strbuf_addstr(&script_snippet,
1151 "GIT_SEQUENCE_EDITOR=:; export GIT_SEQUENCE_EDITOR; ");
1152 opts->autosquash = 0;
1153 }
1154 switch (opts->type) {
1156 case REBASE_AM:
1157 backend = "git-rebase--am";
1158 backend_func = "git_rebase__am";
1159 break;
1160 case REBASE_PRESERVE_MERGES:
1161 backend = "git-rebase--preserve-merges";
1162 backend_func = "git_rebase__preserve_merges";
1163 break;
1164 default:
1165 BUG("Unhandled rebase type %d", opts->type);
1166 break;
1167 }
1168 strbuf_addf(&script_snippet,
1170 ". git-sh-setup && . git-rebase--common &&"
1171 " . %s && %s", backend, backend_func);
1172 argv[0] = script_snippet.buf;
1173 status = run_command_v_opt(argv, RUN_USING_SHELL);
1175finished_rebase:
1176 if (opts->dont_finish_rebase)
1177 ; /* do nothing */
1178 else if (opts->type == REBASE_INTERACTIVE)
1179 ; /* interactive rebase cleans up after itself */
1180 else if (status == 0) {
1181 if (!file_exists(state_dir_path("stopped-sha", opts)))
1182 finish_rebase(opts);
1183 } else if (status == 2) {
1184 struct strbuf dir = STRBUF_INIT;
1185 apply_autostash(opts);
1187 strbuf_addstr(&dir, opts->state_dir);
1188 remove_dir_recursively(&dir, 0);
1189 strbuf_release(&dir);
1190 die("Nothing to do");
1191 }
1192 strbuf_release(&script_snippet);
1194 return status ? -1 : 0;
1196}
1197static int rebase_config(const char *var, const char *value, void *data)
1199{
1200 struct rebase_options *opts = data;
1201 if (!strcmp(var, "rebase.stat")) {
1203 if (git_config_bool(var, value))
1204 opts->flags |= REBASE_DIFFSTAT;
1205 else
1206 opts->flags &= ~REBASE_DIFFSTAT;
1207 return 0;
1208 }
1209 if (!strcmp(var, "rebase.autosquash")) {
1211 opts->autosquash = git_config_bool(var, value);
1212 return 0;
1213 }
1214 if (!strcmp(var, "commit.gpgsign")) {
1216 free(opts->gpg_sign_opt);
1217 opts->gpg_sign_opt = git_config_bool(var, value) ?
1218 xstrdup("-S") : NULL;
1219 return 0;
1220 }
1221 if (!strcmp(var, "rebase.autostash")) {
1223 opts->autostash = git_config_bool(var, value);
1224 return 0;
1225 }
1226 if (!strcmp(var, "rebase.reschedulefailedexec")) {
1228 opts->reschedule_failed_exec = git_config_bool(var, value);
1229 return 0;
1230 }
1231 if (!strcmp(var, "rebase.usebuiltin")) {
1233 opts->use_legacy_rebase = !git_config_bool(var, value);
1234 return 0;
1235 }
1236 return git_default_config(var, value, data);
1238}
1239/*
1241 * Determines whether the commits in from..to are linear, i.e. contain
1242 * no merge commits. This function *expects* `from` to be an ancestor of
1243 * `to`.
1244 */
1245static int is_linear_history(struct commit *from, struct commit *to)
1246{
1247 while (to && to != from) {
1248 parse_commit(to);
1249 if (!to->parents)
1250 return 1;
1251 if (to->parents->next)
1252 return 0;
1253 to = to->parents->item;
1254 }
1255 return 1;
1256}
1257static int can_fast_forward(struct commit *onto, struct object_id *head_oid,
1259 struct object_id *merge_base)
1260{
1261 struct commit *head = lookup_commit(the_repository, head_oid);
1262 struct commit_list *merge_bases;
1263 int res;
1264 if (!head)
1266 return 0;
1267 merge_bases = get_merge_bases(onto, head);
1269 if (merge_bases && !merge_bases->next) {
1270 oidcpy(merge_base, &merge_bases->item->object.oid);
1271 res = oideq(merge_base, &onto->object.oid);
1272 } else {
1273 oidcpy(merge_base, &null_oid);
1274 res = 0;
1275 }
1276 free_commit_list(merge_bases);
1277 return res && is_linear_history(onto, head);
1278}
1279/* -i followed by -m is still -i */
1281static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
1282{
1283 struct rebase_options *opts = opt->value;
1284 BUG_ON_OPT_NEG(unset);
1286 BUG_ON_OPT_ARG(arg);
1287 if (!is_interactive(opts))
1289 opts->type = REBASE_MERGE;
1290 return 0;
1292}
1293/* -i followed by -p is still explicitly interactive, but -p alone is not */
1295static int parse_opt_interactive(const struct option *opt, const char *arg,
1296 int unset)
1297{
1298 struct rebase_options *opts = opt->value;
1299 BUG_ON_OPT_NEG(unset);
1301 BUG_ON_OPT_ARG(arg);
1302 opts->type = REBASE_INTERACTIVE;
1304 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
1305 return 0;
1307}
1308static void NORETURN error_on_missing_default_upstream(void)
1310{
1311 struct branch *current_branch = branch_get(NULL);
1312 printf(_("%s\n"
1314 "Please specify which branch you want to rebase against.\n"
1315 "See git-rebase(1) for details.\n"
1316 "\n"
1317 " git rebase '<branch>'\n"
1318 "\n"),
1319 current_branch ? _("There is no tracking information for "
1320 "the current branch.") :
1321 _("You are not currently on a branch."));
1322 if (current_branch) {
1324 const char *remote = current_branch->remote_name;
1325 if (!remote)
1327 remote = _("<remote>");
1328 printf(_("If you wish to set tracking information for this "
1330 "branch you can do so with:\n"
1331 "\n"
1332 " git branch --set-upstream-to=%s/<branch> %s\n"
1333 "\n"),
1334 remote, current_branch->name);
1335 }
1336 exit(1);
1337}
1338static void set_reflog_action(struct rebase_options *options)
1340{
1341 const char *env;
1342 struct strbuf buf = STRBUF_INIT;
1343 if (!is_interactive(options))
1345 return;
1346 env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
1348 if (env && strcmp("rebase", env))
1349 return; /* only override it if it is "rebase" */
1350 strbuf_addf(&buf, "rebase -i (%s)", options->action);
1352 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
1353 strbuf_release(&buf);
1354}
1355static int check_exec_cmd(const char *cmd)
1357{
1358 if (strchr(cmd, '\n'))
1359 return error(_("exec commands cannot contain newlines"));
1360 /* Does the command consist purely of whitespace? */
1362 if (!cmd[strspn(cmd, " \t\r\f\v")])
1363 return error(_("empty exec command"));
1364 return 0;
1366}
1367int cmd_rebase(int argc, const char **argv, const char *prefix)
1370{
1371 struct rebase_options options = REBASE_OPTIONS_INIT;
1372 const char *branch_name;
1373 int ret, flags, total_argc, in_progress = 0;
1374 int ok_to_skip_pre_rebase = 0;
1375 struct strbuf msg = STRBUF_INIT;
1376 struct strbuf revisions = STRBUF_INIT;
1377 struct strbuf buf = STRBUF_INIT;
1378 struct object_id merge_base;
1379 enum action action = ACTION_NONE;
1380 const char *gpg_sign = NULL;
1381 struct string_list exec = STRING_LIST_INIT_NODUP;
1382 const char *rebase_merges = NULL;
1383 int fork_point = -1;
1384 struct string_list strategy_options = STRING_LIST_INIT_NODUP;
1385 struct object_id squash_onto;
1386 char *squash_onto_name = NULL;
1387 struct option builtin_rebase_options[] = {
1388 OPT_STRING(0, "onto", &options.onto_name,
1389 N_("revision"),
1390 N_("rebase onto given branch instead of upstream")),
1391 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1392 N_("allow pre-rebase hook to run")),
1393 OPT_NEGBIT('q', "quiet", &options.flags,
1394 N_("be quiet. implies --no-stat"),
1395 REBASE_NO_QUIET| REBASE_VERBOSE | REBASE_DIFFSTAT),
1396 OPT_BIT('v', "verbose", &options.flags,
1397 N_("display a diffstat of what changed upstream"),
1398 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1399 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1400 N_("do not show diffstat of what changed upstream"),
1401 PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
1402 OPT_BOOL(0, "signoff", &options.signoff,
1403 N_("add a Signed-off-by: line to each commit")),
1404 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
1405 NULL, N_("passed to 'git am'"),
1406 PARSE_OPT_NOARG),
1407 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
1408 &options.git_am_opts, NULL,
1409 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1410 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
1411 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1412 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1413 N_("passed to 'git apply'"), 0),
1414 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1415 N_("action"), N_("passed to 'git apply'"), 0),
1416 OPT_BIT('f', "force-rebase", &options.flags,
1417 N_("cherry-pick all commits, even if unchanged"),
1418 REBASE_FORCE),
1419 OPT_BIT(0, "no-ff", &options.flags,
1420 N_("cherry-pick all commits, even if unchanged"),
1421 REBASE_FORCE),
1422 OPT_CMDMODE(0, "continue", &action, N_("continue"),
1423 ACTION_CONTINUE),
1424 OPT_CMDMODE(0, "skip", &action,
1425 N_("skip current patch and continue"), ACTION_SKIP),
1426 OPT_CMDMODE(0, "abort", &action,
1427 N_("abort and check out the original branch"),
1428 ACTION_ABORT),
1429 OPT_CMDMODE(0, "quit", &action,
1430 N_("abort but keep HEAD where it is"), ACTION_QUIT),
1431 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
1432 "during an interactive rebase"), ACTION_EDIT_TODO),
1433 OPT_CMDMODE(0, "show-current-patch", &action,
1434 N_("show the patch file being applied or merged"),
1435 ACTION_SHOW_CURRENT_PATCH),
1436 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
1437 N_("use merging strategies to rebase"),
1438 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1439 parse_opt_merge },
1440 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
1441 N_("let the user edit the list of commits to rebase"),
1442 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1443 parse_opt_interactive },
1444 OPT_SET_INT('p', "preserve-merges", &options.type,
1445 N_("(DEPRECATED) try to recreate merges instead of "
1446 "ignoring them"), REBASE_PRESERVE_MERGES),
1447 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
1448 OPT_BOOL('k', "keep-empty", &options.keep_empty,
1449 N_("preserve empty commits during rebase")),
1450 OPT_BOOL(0, "autosquash", &options.autosquash,
1451 N_("move commits that begin with "
1452 "squash!/fixup! under -i")),
1453 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1454 N_("GPG-sign commits"),
1455 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1456 OPT_BOOL(0, "autostash", &options.autostash,
1457 N_("automatically stash/stash pop before and after")),
1458 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
1459 N_("add exec lines after each commit of the "
1460 "editable list")),
1461 OPT_BOOL(0, "allow-empty-message",
1462 &options.allow_empty_message,
1463 N_("allow rebasing commits with empty messages")),
1464 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1465 N_("mode"),
1466 N_("try to rebase merges instead of skipping them"),
1467 PARSE_OPT_OPTARG, NULL, (intptr_t)""},
1468 OPT_BOOL(0, "fork-point", &fork_point,
1469 N_("use 'merge-base --fork-point' to refine upstream")),
1470 OPT_STRING('s', "strategy", &options.strategy,
1471 N_("strategy"), N_("use the given merge strategy")),
1472 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1473 N_("option"),
1474 N_("pass the argument through to the merge "
1475 "strategy")),
1476 OPT_BOOL(0, "root", &options.root,
1477 N_("rebase all reachable commits up to the root(s)")),
1478 OPT_BOOL(0, "reschedule-failed-exec",
1479 &options.reschedule_failed_exec,
1480 N_("automatically re-schedule any `exec` that fails")),
1481 OPT_END(),
1482 };
1483 int i;
1484 if (argc == 2 && !strcmp(argv[1], "-h"))
1486 usage_with_options(builtin_rebase_usage,
1487 builtin_rebase_options);
1488 prefix = setup_git_directory();
1490 trace_repo_setup(prefix);
1491 setup_work_tree();
1492 options.allow_empty_message = 1;
1494 git_config(rebase_config, &options);
1495 if (options.use_legacy_rebase ||
1497 !git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1))
1498 warning(_("the rebase.useBuiltin support has been removed!\n"
1499 "See its entry in 'git help config' for details."));
1500 strbuf_reset(&buf);
1502 strbuf_addf(&buf, "%s/applying", apply_dir());
1503 if(file_exists(buf.buf))
1504 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1505 if (is_directory(apply_dir())) {
1507 options.type = REBASE_AM;
1508 options.state_dir = apply_dir();
1509 } else if (is_directory(merge_dir())) {
1510 strbuf_reset(&buf);
1511 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1512 if (is_directory(buf.buf)) {
1513 options.type = REBASE_PRESERVE_MERGES;
1514 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1515 } else {
1516 strbuf_reset(&buf);
1517 strbuf_addf(&buf, "%s/interactive", merge_dir());
1518 if(file_exists(buf.buf)) {
1519 options.type = REBASE_INTERACTIVE;
1520 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1521 } else
1522 options.type = REBASE_MERGE;
1523 }
1524 options.state_dir = merge_dir();
1525 }
1526 if (options.type != REBASE_UNSPECIFIED)
1528 in_progress = 1;
1529 total_argc = argc;
1531 argc = parse_options(argc, argv, prefix,
1532 builtin_rebase_options,
1533 builtin_rebase_usage, 0);
1534 if (action != ACTION_NONE && total_argc != 2) {
1536 usage_with_options(builtin_rebase_usage,
1537 builtin_rebase_options);
1538 }
1539 if (argc > 2)
1541 usage_with_options(builtin_rebase_usage,
1542 builtin_rebase_options);
1543 if (options.type == REBASE_PRESERVE_MERGES)
1545 warning(_("git rebase --preserve-merges is deprecated. "
1546 "Use --rebase-merges instead."));
1547 if (action != ACTION_NONE && !in_progress)
1549 die(_("No rebase in progress?"));
1550 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
1551 if (action == ACTION_EDIT_TODO && !is_interactive(&options))
1553 die(_("The --edit-todo action can only be used during "
1554 "interactive rebase."));
1555 if (trace2_is_enabled()) {
1557 if (is_interactive(&options))
1558 trace2_cmd_mode("interactive");
1559 else if (exec.nr)
1560 trace2_cmd_mode("interactive-exec");
1561 else
1562 trace2_cmd_mode(action_names[action]);
1563 }
1564 switch (action) {
1566 case ACTION_CONTINUE: {
1567 struct object_id head;
1568 struct lock_file lock_file = LOCK_INIT;
1569 int fd;
1570 options.action = "continue";
1572 set_reflog_action(&options);
1573 /* Sanity check */
1575 if (get_oid("HEAD", &head))
1576 die(_("Cannot read HEAD"));
1577 fd = hold_locked_index(&lock_file, 0);
1579 if (repo_read_index(the_repository) < 0)
1580 die(_("could not read index"));
1581 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1582 NULL);
1583 if (0 <= fd)
1584 repo_update_index_if_able(the_repository, &lock_file);
1585 rollback_lock_file(&lock_file);
1586 if (has_unstaged_changes(the_repository, 1)) {
1588 puts(_("You must edit all merge conflicts and then\n"
1589 "mark them as resolved using git add"));
1590 exit(1);
1591 }
1592 if (read_basic_state(&options))
1593 exit(1);
1594 goto run_rebase;
1595 }
1596 case ACTION_SKIP: {
1597 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1598 options.action = "skip";
1600 set_reflog_action(&options);
1601 rerere_clear(the_repository, &merge_rr);
1603 string_list_clear(&merge_rr, 1);
1604 if (reset_head(NULL, "reset", NULL, RESET_HEAD_HARD,
1606 NULL, NULL) < 0)
1607 die(_("could not discard worktree changes"));
1608 remove_branch_state(the_repository);
1609 if (read_basic_state(&options))
1610 exit(1);
1611 goto run_rebase;
1612 }
1613 case ACTION_ABORT: {
1614 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1615 options.action = "abort";
1616 set_reflog_action(&options);
1617 rerere_clear(the_repository, &merge_rr);
1619 string_list_clear(&merge_rr, 1);
1620 if (read_basic_state(&options))
1622 exit(1);
1623 if (reset_head(&options.orig_head, "reset",
1624 options.head_name, RESET_HEAD_HARD,
1625 NULL, NULL) < 0)
1626 die(_("could not move back to %s"),
1627 oid_to_hex(&options.orig_head));
1628 remove_branch_state(the_repository);
1629 ret = finish_rebase(&options);
1630 goto cleanup;
1631 }
1632 case ACTION_QUIT: {
1633 strbuf_reset(&buf);
1634 strbuf_addstr(&buf, options.state_dir);
1635 ret = !!remove_dir_recursively(&buf, 0);
1636 if (ret)
1637 die(_("could not remove '%s'"), options.state_dir);
1638 goto cleanup;
1639 }
1640 case ACTION_EDIT_TODO:
1641 options.action = "edit-todo";
1642 options.dont_finish_rebase = 1;
1643 goto run_rebase;
1644 case ACTION_SHOW_CURRENT_PATCH:
1645 options.action = "show-current-patch";
1646 options.dont_finish_rebase = 1;
1647 goto run_rebase;
1648 case ACTION_NONE:
1649 break;
1650 default:
1651 BUG("action: %d", action);
1652 }
1653 /* Make sure no rebase is in progress */
1655 if (in_progress) {
1656 const char *last_slash = strrchr(options.state_dir, '/');
1657 const char *state_dir_base =
1658 last_slash ? last_slash + 1 : options.state_dir;
1659 const char *cmd_live_rebase =
1660 "git rebase (--continue | --abort | --skip)";
1661 strbuf_reset(&buf);
1662 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1663 die(_("It seems that there is already a %s directory, and\n"
1664 "I wonder if you are in the middle of another rebase. "
1665 "If that is the\n"
1666 "case, please try\n\t%s\n"
1667 "If that is not the case, please\n\t%s\n"
1668 "and run me again. I am stopping in case you still "
1669 "have something\n"
1670 "valuable there.\n"),
1671 state_dir_base, cmd_live_rebase, buf.buf);
1672 }
1673 for (i = 0; i < options.git_am_opts.argc; i++) {
1675 const char *option = options.git_am_opts.argv[i], *p;
1676 if (!strcmp(option, "--committer-date-is-author-date") ||
1677 !strcmp(option, "--ignore-date") ||
1678 !strcmp(option, "--whitespace=fix") ||
1679 !strcmp(option, "--whitespace=strip"))
1680 options.flags |= REBASE_FORCE;
1681 else if (skip_prefix(option, "-C", &p)) {
1682 while (*p)
1683 if (!isdigit(*(p++)))
1684 die(_("switch `C' expects a "
1685 "numerical value"));
1686 } else if (skip_prefix(option, "--whitespace=", &p)) {
1687 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1688 strcmp(p, "error") && strcmp(p, "error-all"))
1689 die("Invalid whitespace option: '%s'", p);
1690 }
1691 }
1692 for (i = 0; i < exec.nr; i++)
1694 if (check_exec_cmd(exec.items[i].string))
1695 exit(1);
1696 if (!(options.flags & REBASE_NO_QUIET))
1698 argv_array_push(&options.git_am_opts, "-q");
1699 if (options.keep_empty)
1701 imply_interactive(&options, "--keep-empty");
1702 if (gpg_sign) {
1704 free(options.gpg_sign_opt);
1705 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1706 }
1707 if (exec.nr) {
1709 int i;
1710 imply_interactive(&options, "--exec");
1712 strbuf_reset(&buf);
1714 for (i = 0; i < exec.nr; i++)
1715 strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1716 options.cmd = xstrdup(buf.buf);
1717 }
1718 if (rebase_merges) {
1720 if (!*rebase_merges)
1721 ; /* default mode; do nothing */
1722 else if (!strcmp("rebase-cousins", rebase_merges))
1723 options.rebase_cousins = 1;
1724 else if (strcmp("no-rebase-cousins", rebase_merges))
1725 die(_("Unknown mode: %s"), rebase_merges);
1726 options.rebase_merges = 1;
1727 imply_interactive(&options, "--rebase-merges");
1728 }
1729 if (strategy_options.nr) {
1731 int i;
1732 if (!options.strategy)
1734 options.strategy = "recursive";
1735 strbuf_reset(&buf);
1737 for (i = 0; i < strategy_options.nr; i++)
1738 strbuf_addf(&buf, " --%s",
1739 strategy_options.items[i].string);
1740 options.strategy_opts = xstrdup(buf.buf);
1741 }
1742 if (options.strategy) {
1744 options.strategy = xstrdup(options.strategy);
1745 switch (options.type) {
1746 case REBASE_AM:
1747 die(_("--strategy requires --merge or --interactive"));
1748 case REBASE_MERGE:
1749 case REBASE_INTERACTIVE:
1750 case REBASE_PRESERVE_MERGES:
1751 /* compatible */
1752 break;
1753 case REBASE_UNSPECIFIED:
1754 options.type = REBASE_MERGE;
1755 break;
1756 default:
1757 BUG("unhandled rebase type (%d)", options.type);
1758 }
1759 }
1760 if (options.type == REBASE_MERGE)
1762 imply_interactive(&options, "--merge");
1763 if (options.root && !options.onto_name)
1765 imply_interactive(&options, "--root without --onto");
1766 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1768 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1769 switch (options.type) {
1771 case REBASE_MERGE:
1772 case REBASE_INTERACTIVE:
1773 case REBASE_PRESERVE_MERGES:
1774 options.state_dir = merge_dir();
1775 break;
1776 case REBASE_AM:
1777 options.state_dir = apply_dir();
1778 break;
1779 default:
1780 /* the default rebase backend is `--am` */
1781 options.type = REBASE_AM;
1782 options.state_dir = apply_dir();
1783 break;
1784 }
1785 if (options.reschedule_failed_exec && !is_interactive(&options))
1787 die(_("%s requires an interactive rebase"), "--reschedule-failed-exec");
1788 if (options.git_am_opts.argc) {
1790 /* all am options except -q are compatible only with --am */
1791 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1792 if (strcmp(options.git_am_opts.argv[i], "-q"))
1793 break;
1794 if (is_interactive(&options) && i >= 0)
1796 die(_("cannot combine am options with either "
1797 "interactive or merge options"));
1798 }
1799 if (options.signoff) {
1801 if (options.type == REBASE_PRESERVE_MERGES)
1802 die("cannot combine '--signoff' with "
1803 "'--preserve-merges'");
1804 argv_array_push(&options.git_am_opts, "--signoff");
1805 options.flags |= REBASE_FORCE;
1806 }
1807 if (options.type == REBASE_PRESERVE_MERGES) {
1809 /*
1810 * Note: incompatibility with --signoff handled in signoff block above
1811 * Note: incompatibility with --interactive is just a strong warning;
1812 * git-rebase.txt caveats with "unless you know what you are doing"
1813 */
1814 if (options.rebase_merges)
1815 die(_("cannot combine '--preserve-merges' with "
1816 "'--rebase-merges'"));
1817 if (options.reschedule_failed_exec)
1819 die(_("error: cannot combine '--preserve-merges' with "
1820 "'--reschedule-failed-exec'"));
1821 }
1822 if (options.rebase_merges) {
1824 if (strategy_options.nr)
1825 die(_("cannot combine '--rebase-merges' with "
1826 "'--strategy-option'"));
1827 if (options.strategy)
1828 die(_("cannot combine '--rebase-merges' with "
1829 "'--strategy'"));
1830 }
1831 if (!options.root) {
1833 if (argc < 1) {
1834 struct branch *branch;
1835 branch = branch_get(NULL);
1837 options.upstream_name = branch_get_upstream(branch,
1838 NULL);
1839 if (!options.upstream_name)
1840 error_on_missing_default_upstream();
1841 if (fork_point < 0)
1842 fork_point = 1;
1843 } else {
1844 options.upstream_name = argv[0];
1845 argc--;
1846 argv++;
1847 if (!strcmp(options.upstream_name, "-"))
1848 options.upstream_name = "@{-1}";
1849 }
1850 options.upstream = peel_committish(options.upstream_name);
1851 if (!options.upstream)
1852 die(_("invalid upstream '%s'"), options.upstream_name);
1853 options.upstream_arg = options.upstream_name;
1854 } else {
1855 if (!options.onto_name) {
1856 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1857 &squash_onto, NULL, NULL) < 0)
1858 die(_("Could not create new root commit"));
1859 options.squash_onto = &squash_onto;
1860 options.onto_name = squash_onto_name =
1861 xstrdup(oid_to_hex(&squash_onto));
1862 }
1863 options.upstream_name = NULL;
1864 options.upstream = NULL;
1865 if (argc > 1)
1866 usage_with_options(builtin_rebase_usage,
1867 builtin_rebase_options);
1868 options.upstream_arg = "--root";
1869 }
1870 /* Make sure the branch to rebase onto is valid. */
1872 if (!options.onto_name)
1873 options.onto_name = options.upstream_name;
1874 if (strstr(options.onto_name, "...")) {
1875 if (get_oid_mb(options.onto_name, &merge_base) < 0)
1876 die(_("'%s': need exactly one merge base"),
1877 options.onto_name);
1878 options.onto = lookup_commit_or_die(&merge_base,
1879 options.onto_name);
1880 } else {
1881 options.onto = peel_committish(options.onto_name);
1882 if (!options.onto)
1883 die(_("Does not point to a valid commit '%s'"),
1884 options.onto_name);
1885 }
1886 /*
1888 * If the branch to rebase is given, that is the branch we will rebase
1889 * branch_name -- branch/commit being rebased, or
1890 * HEAD (already detached)
1891 * orig_head -- commit object name of tip of the branch before rebasing
1892 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1893 */
1894 if (argc == 1) {
1895 /* Is it "rebase other branchname" or "rebase other commit"? */
1896 branch_name = argv[0];
1897 options.switch_to = argv[0];
1898 /* Is it a local branch? */
1900 strbuf_reset(&buf);
1901 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1902 if (!read_ref(buf.buf, &options.orig_head))
1903 options.head_name = xstrdup(buf.buf);
1904 /* If not is it a valid ref (branch or commit)? */
1905 else if (!get_oid(branch_name, &options.orig_head))
1906 options.head_name = NULL;
1907 else
1908 die(_("fatal: no such branch/commit '%s'"),
1909 branch_name);
1910 } else if (argc == 0) {
1911 /* Do not need to switch branches, we are already on it. */
1912 options.head_name =
1913 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1914 &flags));
1915 if (!options.head_name)
1916 die(_("No such ref: %s"), "HEAD");
1917 if (flags & REF_ISSYMREF) {
1918 if (!skip_prefix(options.head_name,
1919 "refs/heads/", &branch_name))
1920 branch_name = options.head_name;
1921 } else {
1923 FREE_AND_NULL(options.head_name);
1924 branch_name = "HEAD";
1925 }
1926 if (get_oid("HEAD", &options.orig_head))
1927 die(_("Could not resolve HEAD to a revision"));
1928 } else
1929 BUG("unexpected number of arguments left to parse");
1930 if (fork_point > 0) {
1932 struct commit *head =
1933 lookup_commit_reference(the_repository,
1934 &options.orig_head);
1935 options.restrict_revision =
1936 get_fork_point(options.upstream_name, head);
1937 }
1938 if (repo_read_index(the_repository) < 0)
1940 die(_("could not read index"));
1941 if (options.autostash) {
1943 struct lock_file lock_file = LOCK_INIT;
1944 int fd;
1945 fd = hold_locked_index(&lock_file, 0);
1947 refresh_cache(REFRESH_QUIET);
1948 if (0 <= fd)
1949 repo_update_index_if_able(the_repository, &lock_file);
1950 rollback_lock_file(&lock_file);
1951 if (has_unstaged_changes(the_repository, 1) ||
1953 has_uncommitted_changes(the_repository, 1)) {
1954 const char *autostash =
1955 state_dir_path("autostash", &options);
1956 struct child_process stash = CHILD_PROCESS_INIT;
1957 struct object_id oid;
1958 struct commit *head =
1959 lookup_commit_reference(the_repository,
1960 &options.orig_head);
1961 argv_array_pushl(&stash.args,
1963 "stash", "create", "autostash", NULL);
1964 stash.git_cmd = 1;
1965 stash.no_stdin = 1;
1966 strbuf_reset(&buf);
1967 if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
1968 die(_("Cannot autostash"));
1969 strbuf_trim_trailing_newline(&buf);
1970 if (get_oid(buf.buf, &oid))
1971 die(_("Unexpected stash response: '%s'"),
1972 buf.buf);
1973 strbuf_reset(&buf);
1974 strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
1975 if (safe_create_leading_directories_const(autostash))
1977 die(_("Could not create directory for '%s'"),
1978 options.state_dir);
1979 write_file(autostash, "%s", oid_to_hex(&oid));
1980 printf(_("Created autostash: %s\n"), buf.buf);
1981 if (reset_head(&head->object.oid, "reset --hard",
1982 NULL, RESET_HEAD_HARD, NULL, NULL) < 0)
1983 die(_("could not reset --hard"));
1984 printf(_("HEAD is now at %s"),
1985 find_unique_abbrev(&head->object.oid,
1986 DEFAULT_ABBREV));
1987 strbuf_reset(&buf);
1988 pp_commit_easy(CMIT_FMT_ONELINE, head, &buf);
1989 if (buf.len > 0)
1990 printf(" %s", buf.buf);
1991 putchar('\n');
1992 if (discard_index(the_repository->index) < 0 ||
1994 repo_read_index(the_repository) < 0)
1995 die(_("could not read index"));
1996 }
1997 }
1998 if (require_clean_work_tree(the_repository, "rebase",
2000 _("Please commit or stash them."), 1, 1)) {
2001 ret = 1;
2002 goto cleanup;
2003 }
2004 /*
2006 * Now we are rebasing commits upstream..orig_head (or with --root,
2007 * everything leading up to orig_head) on top of onto.
2008 */
2009 /*
2011 * Check if we are already based on onto with linear history,
2012 * but this should be done only when upstream and onto are the same
2013 * and if this is not an interactive rebase.
2014 */
2015 if (can_fast_forward(options.onto, &options.orig_head, &merge_base) &&
2016 !is_interactive(&options) && !options.restrict_revision &&
2017 options.upstream &&
2018 !oidcmp(&options.upstream->object.oid, &options.onto->object.oid)) {
2019 int flag;
2020 if (!(options.flags & REBASE_FORCE)) {
2022 /* Lazily switch to the target branch if needed... */
2023 if (options.switch_to) {
2024 struct object_id oid;
2025 if (get_oid(options.switch_to, &oid) < 0) {
2027 ret = !!error(_("could not parse '%s'"),
2028 options.switch_to);
2029 goto cleanup;
2030 }
2031 strbuf_reset(&buf);
2033 strbuf_addf(&buf, "%s: checkout %s",
2034 getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
2035 options.switch_to);
2036 if (reset_head(&oid, "checkout",
2037 options.head_name,
2038 RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
2039 NULL, buf.buf) < 0) {
2040 ret = !!error(_("could not switch to "
2041 "%s"),
2042 options.switch_to);
2043 goto cleanup;
2044 }
2045 }
2046 if (!(options.flags & REBASE_NO_QUIET))
2048 ; /* be quiet */
2049 else if (!strcmp(branch_name, "HEAD") &&
2050 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2051 puts(_("HEAD is up to date."));
2052 else
2053 printf(_("Current branch %s is up to date.\n"),
2054 branch_name);
2055 ret = !!finish_rebase(&options);
2056 goto cleanup;
2057 } else if (!(options.flags & REBASE_NO_QUIET))
2058 ; /* be quiet */
2059 else if (!strcmp(branch_name, "HEAD") &&
2060 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2061 puts(_("HEAD is up to date, rebase forced."));
2062 else
2063 printf(_("Current branch %s is up to date, rebase "
2064 "forced.\n"), branch_name);
2065 }
2066 /* If a hook exists, give it a chance to interrupt*/
2068 if (!ok_to_skip_pre_rebase &&
2069 run_hook_le(NULL, "pre-rebase", options.upstream_arg,
2070 argc ? argv[0] : NULL, NULL))
2071 die(_("The pre-rebase hook refused to rebase."));
2072 if (options.flags & REBASE_DIFFSTAT) {
2074 struct diff_options opts;
2075 if (options.flags & REBASE_VERBOSE) {
2077 if (is_null_oid(&merge_base))
2078 printf(_("Changes to %s:\n"),
2079 oid_to_hex(&options.onto->object.oid));
2080 else
2081 printf(_("Changes from %s to %s:\n"),
2082 oid_to_hex(&merge_base),
2083 oid_to_hex(&options.onto->object.oid));
2084 }
2085 /* We want color (if set), but no pager */
2087 diff_setup(&opts);
2088 opts.stat_width = -1; /* use full terminal width */
2089 opts.stat_graph_width = -1; /* respect statGraphWidth config */
2090 opts.output_format |=
2091 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
2092 opts.detect_rename = DIFF_DETECT_RENAME;
2093 diff_setup_done(&opts);
2094 diff_tree_oid(is_null_oid(&merge_base) ?
2095 the_hash_algo->empty_tree : &merge_base,
2096 &options.onto->object.oid, "", &opts);
2097 diffcore_std(&opts);
2098 diff_flush(&opts);
2099 }
2100 if (is_interactive(&options))
2102 goto run_rebase;
2103 /* Detach HEAD and reset the tree */
2105 if (options.flags & REBASE_NO_QUIET)
2106 printf(_("First, rewinding head to replay your work on top of "
2107 "it...\n"));
2108 strbuf_addf(&msg, "%s: checkout %s",
2110 getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
2111 if (reset_head(&options.onto->object.oid, "checkout", NULL,
2112 RESET_HEAD_DETACH | RESET_ORIG_HEAD |
2113 RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
2114 NULL, msg.buf))
2115 die(_("Could not detach HEAD"));
2116 strbuf_release(&msg);
2117 /*
2119 * If the onto is a proper descendant of the tip of the branch, then
2120 * we just fast-forwarded.
2121 */
2122 strbuf_reset(&msg);
2123 if (oideq(&merge_base, &options.orig_head)) {
2124 printf(_("Fast-forwarded %s to %s.\n"),
2125 branch_name, options.onto_name);
2126 strbuf_addf(&msg, "rebase finished: %s onto %s",
2127 options.head_name ? options.head_name : "detached HEAD",
2128 oid_to_hex(&options.onto->object.oid));
2129 reset_head(NULL, "Fast-forwarded", options.head_name,
2130 RESET_HEAD_REFS_ONLY, "HEAD", msg.buf);
2131 strbuf_release(&msg);
2132 ret = !!finish_rebase(&options);
2133 goto cleanup;
2134 }
2135 strbuf_addf(&revisions, "%s..%s",
2137 options.root ? oid_to_hex(&options.onto->object.oid) :
2138 (options.restrict_revision ?
2139 oid_to_hex(&options.restrict_revision->object.oid) :
2140 oid_to_hex(&options.upstream->object.oid)),
2141 oid_to_hex(&options.orig_head));
2142 options.revisions = revisions.buf;
2144run_rebase:
2146 ret = !!run_specific_rebase(&options, action);
2147cleanup:
2149 strbuf_release(&revisions);
2150 free(options.head_name);
2151 free(options.gpg_sign_opt);
2152 free(options.cmd);
2153 free(squash_onto_name);
2154 return ret;
2155}