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