1/*
2 * "git rebase" builtin command
3 *
4 * Copyright (c) 2018 Pratik Karki
5 */
6#include "builtin.h"
8#include "run-command.h"
9#include "exec-cmd.h"
10#include "argv-array.h"
11#include "dir.h"
12#include "packfile.h"
13#include "refs.h"
14#include "quote.h"
15#include "config.h"
16#include "cache-tree.h"
17#include "unpack-trees.h"
18#include "lockfile.h"
19#include "parse-options.h"
20#include "commit.h"
21#include "diff.h"
22#include "wt-status.h"
23#include "revision.h"
24#include "commit-reach.h"
25#include "rerere.h"
26#include "branch.h"
27static char const * const builtin_rebase_usage[] = {
29 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
30 "[<upstream>] [<branch>]"),
31 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
32 "--root [<branch>]"),
33 N_("git rebase --continue | --abort | --skip | --edit-todo"),
34 NULL
35};
36static GIT_PATH_FUNC(apply_dir, "rebase-apply")
38static GIT_PATH_FUNC(merge_dir, "rebase-merge")
39enum rebase_type {
41 REBASE_UNSPECIFIED = -1,
42 REBASE_AM,
43 REBASE_MERGE,
44 REBASE_INTERACTIVE,
45 REBASE_PRESERVE_MERGES
46};
47static int use_builtin_rebase(void)
49{
50 struct child_process cp = CHILD_PROCESS_INIT;
51 struct strbuf out = STRBUF_INIT;
52 int ret, env = git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1);
53 if (env != -1)
55 return env;
56 argv_array_pushl(&cp.args,
58 "config", "--bool", "rebase.usebuiltin", NULL);
59 cp.git_cmd = 1;
60 if (capture_command(&cp, &out, 6)) {
61 strbuf_release(&out);
62 return 1;
63 }
64 strbuf_trim(&out);
66 ret = !strcmp("true", out.buf);
67 strbuf_release(&out);
68 return ret;
69}
70struct rebase_options {
72 enum rebase_type type;
73 const char *state_dir;
74 struct commit *upstream;
75 const char *upstream_name;
76 const char *upstream_arg;
77 char *head_name;
78 struct object_id orig_head;
79 struct commit *onto;
80 const char *onto_name;
81 const char *revisions;
82 const char *switch_to;
83 int root;
84 struct object_id *squash_onto;
85 struct commit *restrict_revision;
86 int dont_finish_rebase;
87 enum {
88 REBASE_NO_QUIET = 1<<0,
89 REBASE_VERBOSE = 1<<1,
90 REBASE_DIFFSTAT = 1<<2,
91 REBASE_FORCE = 1<<3,
92 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
93 } flags;
94 struct argv_array git_am_opts;
95 const char *action;
96 int signoff;
97 int allow_rerere_autoupdate;
98 int keep_empty;
99 int autosquash;
100 char *gpg_sign_opt;
101 int autostash;
102 char *cmd;
103 int allow_empty_message;
104 int rebase_merges, rebase_cousins;
105 char *strategy, *strategy_opts;
106 struct strbuf git_format_patch_opt;
107 int reschedule_failed_exec;
108};
109static int is_interactive(struct rebase_options *opts)
111{
112 return opts->type == REBASE_INTERACTIVE ||
113 opts->type == REBASE_PRESERVE_MERGES;
114}
115static void imply_interactive(struct rebase_options *opts, const char *option)
117{
118 switch (opts->type) {
119 case REBASE_AM:
120 die(_("%s requires an interactive rebase"), option);
121 break;
122 case REBASE_INTERACTIVE:
123 case REBASE_PRESERVE_MERGES:
124 break;
125 case REBASE_MERGE:
126 /* we silently *upgrade* --merge to --interactive if needed */
127 default:
128 opts->type = REBASE_INTERACTIVE; /* implied */
129 break;
130 }
131}
132/* Returns the filename prefixed by the state_dir */
134static const char *state_dir_path(const char *filename, struct rebase_options *opts)
135{
136 static struct strbuf path = STRBUF_INIT;
137 static size_t prefix_len;
138 if (!prefix_len) {
140 strbuf_addf(&path, "%s/", opts->state_dir);
141 prefix_len = path.len;
142 }
143 strbuf_setlen(&path, prefix_len);
145 strbuf_addstr(&path, filename);
146 return path.buf;
147}
148/* Read one file, then strip line endings */
150static int read_one(const char *path, struct strbuf *buf)
151{
152 if (strbuf_read_file(buf, path, 0) < 0)
153 return error_errno(_("could not read '%s'"), path);
154 strbuf_trim_trailing_newline(buf);
155 return 0;
156}
157/* Initialize the rebase options from the state directory. */
159static int read_basic_state(struct rebase_options *opts)
160{
161 struct strbuf head_name = STRBUF_INIT;
162 struct strbuf buf = STRBUF_INIT;
163 struct object_id oid;
164 if (read_one(state_dir_path("head-name", opts), &head_name) ||
166 read_one(state_dir_path("onto", opts), &buf))
167 return -1;
168 opts->head_name = starts_with(head_name.buf, "refs/") ?
169 xstrdup(head_name.buf) : NULL;
170 strbuf_release(&head_name);
171 if (get_oid(buf.buf, &oid))
172 return error(_("could not get 'onto': '%s'"), buf.buf);
173 opts->onto = lookup_commit_or_die(&oid, buf.buf);
174 /*
176 * We always write to orig-head, but interactive rebase used to write to
177 * head. Fall back to reading from head to cover for the case that the
178 * user upgraded git with an ongoing interactive rebase.
179 */
180 strbuf_reset(&buf);
181 if (file_exists(state_dir_path("orig-head", opts))) {
182 if (read_one(state_dir_path("orig-head", opts), &buf))
183 return -1;
184 } else if (read_one(state_dir_path("head", opts), &buf))
185 return -1;
186 if (get_oid(buf.buf, &opts->orig_head))
187 return error(_("invalid orig-head: '%s'"), buf.buf);
188 strbuf_reset(&buf);
190 if (read_one(state_dir_path("quiet", opts), &buf))
191 return -1;
192 if (buf.len)
193 opts->flags &= ~REBASE_NO_QUIET;
194 else
195 opts->flags |= REBASE_NO_QUIET;
196 if (file_exists(state_dir_path("verbose", opts)))
198 opts->flags |= REBASE_VERBOSE;
199 if (file_exists(state_dir_path("signoff", opts))) {
201 opts->signoff = 1;
202 opts->flags |= REBASE_FORCE;
203 }
204 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
206 strbuf_reset(&buf);
207 if (read_one(state_dir_path("allow_rerere_autoupdate", opts),
208 &buf))
209 return -1;
210 if (!strcmp(buf.buf, "--rerere-autoupdate"))
211 opts->allow_rerere_autoupdate = 1;
212 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
213 opts->allow_rerere_autoupdate = 0;
214 else
215 warning(_("ignoring invalid allow_rerere_autoupdate: "
216 "'%s'"), buf.buf);
217 } else
218 opts->allow_rerere_autoupdate = -1;
219 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
221 strbuf_reset(&buf);
222 if (read_one(state_dir_path("gpg_sign_opt", opts),
223 &buf))
224 return -1;
225 free(opts->gpg_sign_opt);
226 opts->gpg_sign_opt = xstrdup(buf.buf);
227 }
228 if (file_exists(state_dir_path("strategy", opts))) {
230 strbuf_reset(&buf);
231 if (read_one(state_dir_path("strategy", opts), &buf))
232 return -1;
233 free(opts->strategy);
234 opts->strategy = xstrdup(buf.buf);
235 }
236 if (file_exists(state_dir_path("strategy_opts", opts))) {
238 strbuf_reset(&buf);
239 if (read_one(state_dir_path("strategy_opts", opts), &buf))
240 return -1;
241 free(opts->strategy_opts);
242 opts->strategy_opts = xstrdup(buf.buf);
243 }
244 strbuf_release(&buf);
246 return 0;
248}
249static int apply_autostash(struct rebase_options *opts)
251{
252 const char *path = state_dir_path("autostash", opts);
253 struct strbuf autostash = STRBUF_INIT;
254 struct child_process stash_apply = CHILD_PROCESS_INIT;
255 if (!file_exists(path))
257 return 0;
258 if (read_one(path, &autostash))
260 return error(_("Could not read '%s'"), path);
261 /* Ensure that the hash is not mistaken for a number */
262 strbuf_addstr(&autostash, "^0");
263 argv_array_pushl(&stash_apply.args,
264 "stash", "apply", autostash.buf, NULL);
265 stash_apply.git_cmd = 1;
266 stash_apply.no_stderr = stash_apply.no_stdout =
267 stash_apply.no_stdin = 1;
268 if (!run_command(&stash_apply))
269 printf(_("Applied autostash.\n"));
270 else {
271 struct argv_array args = ARGV_ARRAY_INIT;
272 int res = 0;
273 argv_array_pushl(&args,
275 "stash", "store", "-m", "autostash", "-q",
276 autostash.buf, NULL);
277 if (run_command_v_opt(args.argv, RUN_GIT_CMD))
278 res = error(_("Cannot store %s"), autostash.buf);
279 argv_array_clear(&args);
280 strbuf_release(&autostash);
281 if (res)
282 return res;
283 fprintf(stderr,
285 _("Applying autostash resulted in conflicts.\n"
286 "Your changes are safe in the stash.\n"
287 "You can run \"git stash pop\" or \"git stash drop\" "
288 "at any time.\n"));
289 }
290 strbuf_release(&autostash);
292 return 0;
293}
294static int finish_rebase(struct rebase_options *opts)
296{
297 struct strbuf dir = STRBUF_INIT;
298 const char *argv_gc_auto[] = { "gc", "--auto", NULL };
299 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
301 apply_autostash(opts);
302 close_all_packs(the_repository->objects);
303 /*
304 * We ignore errors in 'gc --auto', since the
305 * user should see them.
306 */
307 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
308 strbuf_addstr(&dir, opts->state_dir);
309 remove_dir_recursively(&dir, 0);
310 strbuf_release(&dir);
311 return 0;
313}
314static struct commit *peel_committish(const char *name)
316{
317 struct object *obj;
318 struct object_id oid;
319 if (get_oid(name, &oid))
321 return NULL;
322 obj = parse_object(the_repository, &oid);
323 return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
324}
325static void add_var(struct strbuf *buf, const char *name, const char *value)
327{
328 if (!value)
329 strbuf_addf(buf, "unset %s; ", name);
330 else {
331 strbuf_addf(buf, "%s=", name);
332 sq_quote_buf(buf, value);
333 strbuf_addstr(buf, "; ");
334 }
335}
336static const char *resolvemsg =
338N_("Resolve all conflicts manually, mark them as resolved with\n"
339"\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
340"You can instead skip this commit: run \"git rebase --skip\".\n"
341"To abort and get back to the state before \"git rebase\", run "
342"\"git rebase --abort\".");
343static int run_specific_rebase(struct rebase_options *opts)
345{
346 const char *argv[] = { NULL, NULL };
347 struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
348 int status;
349 const char *backend, *backend_func;
350 if (opts->type == REBASE_INTERACTIVE) {
352 /* Run builtin interactive rebase */
353 struct child_process child = CHILD_PROCESS_INIT;
354 argv_array_pushf(&child.env_array, "GIT_CHERRY_PICK_HELP=%s",
356 resolvemsg);
357 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
358 argv_array_push(&child.env_array, "GIT_EDITOR=:");
359 opts->autosquash = 0;
360 }
361 child.git_cmd = 1;
363 argv_array_push(&child.args, "rebase--interactive");
364 if (opts->action)
366 argv_array_pushf(&child.args, "--%s", opts->action);
367 if (opts->keep_empty)
368 argv_array_push(&child.args, "--keep-empty");
369 if (opts->rebase_merges)
370 argv_array_push(&child.args, "--rebase-merges");
371 if (opts->rebase_cousins)
372 argv_array_push(&child.args, "--rebase-cousins");
373 if (opts->autosquash)
374 argv_array_push(&child.args, "--autosquash");
375 if (opts->flags & REBASE_VERBOSE)
376 argv_array_push(&child.args, "--verbose");
377 if (opts->flags & REBASE_FORCE)
378 argv_array_push(&child.args, "--no-ff");
379 if (opts->restrict_revision)
380 argv_array_pushf(&child.args,
381 "--restrict-revision=^%s",
382 oid_to_hex(&opts->restrict_revision->object.oid));
383 if (opts->upstream)
384 argv_array_pushf(&child.args, "--upstream=%s",
385 oid_to_hex(&opts->upstream->object.oid));
386 if (opts->onto)
387 argv_array_pushf(&child.args, "--onto=%s",
388 oid_to_hex(&opts->onto->object.oid));
389 if (opts->squash_onto)
390 argv_array_pushf(&child.args, "--squash-onto=%s",
391 oid_to_hex(opts->squash_onto));
392 if (opts->onto_name)
393 argv_array_pushf(&child.args, "--onto-name=%s",
394 opts->onto_name);
395 argv_array_pushf(&child.args, "--head-name=%s",
396 opts->head_name ?
397 opts->head_name : "detached HEAD");
398 if (opts->strategy)
399 argv_array_pushf(&child.args, "--strategy=%s",
400 opts->strategy);
401 if (opts->strategy_opts)
402 argv_array_pushf(&child.args, "--strategy-opts=%s",
403 opts->strategy_opts);
404 if (opts->switch_to)
405 argv_array_pushf(&child.args, "--switch-to=%s",
406 opts->switch_to);
407 if (opts->cmd)
408 argv_array_pushf(&child.args, "--cmd=%s", opts->cmd);
409 if (opts->allow_empty_message)
410 argv_array_push(&child.args, "--allow-empty-message");
411 if (opts->allow_rerere_autoupdate > 0)
412 argv_array_push(&child.args, "--rerere-autoupdate");
413 else if (opts->allow_rerere_autoupdate == 0)
414 argv_array_push(&child.args, "--no-rerere-autoupdate");
415 if (opts->gpg_sign_opt)
416 argv_array_push(&child.args, opts->gpg_sign_opt);
417 if (opts->signoff)
418 argv_array_push(&child.args, "--signoff");
419 if (opts->reschedule_failed_exec)
420 argv_array_push(&child.args, "--reschedule-failed-exec");
421 status = run_command(&child);
423 goto finished_rebase;
424 }
425 add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
427 add_var(&script_snippet, "state_dir", opts->state_dir);
428 add_var(&script_snippet, "upstream_name", opts->upstream_name);
430 add_var(&script_snippet, "upstream", opts->upstream ?
431 oid_to_hex(&opts->upstream->object.oid) : NULL);
432 add_var(&script_snippet, "head_name",
433 opts->head_name ? opts->head_name : "detached HEAD");
434 add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
435 add_var(&script_snippet, "onto", opts->onto ?
436 oid_to_hex(&opts->onto->object.oid) : NULL);
437 add_var(&script_snippet, "onto_name", opts->onto_name);
438 add_var(&script_snippet, "revisions", opts->revisions);
439 add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
440 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
441 add_var(&script_snippet, "GIT_QUIET",
442 opts->flags & REBASE_NO_QUIET ? "" : "t");
443 sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
444 add_var(&script_snippet, "git_am_opt", buf.buf);
445 strbuf_release(&buf);
446 add_var(&script_snippet, "verbose",
447 opts->flags & REBASE_VERBOSE ? "t" : "");
448 add_var(&script_snippet, "diffstat",
449 opts->flags & REBASE_DIFFSTAT ? "t" : "");
450 add_var(&script_snippet, "force_rebase",
451 opts->flags & REBASE_FORCE ? "t" : "");
452 if (opts->switch_to)
453 add_var(&script_snippet, "switch_to", opts->switch_to);
454 add_var(&script_snippet, "action", opts->action ? opts->action : "");
455 add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
456 add_var(&script_snippet, "allow_rerere_autoupdate",
457 opts->allow_rerere_autoupdate < 0 ? "" :
458 opts->allow_rerere_autoupdate ?
459 "--rerere-autoupdate" : "--no-rerere-autoupdate");
460 add_var(&script_snippet, "keep_empty", opts->keep_empty ? "yes" : "");
461 add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
462 add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
463 add_var(&script_snippet, "cmd", opts->cmd);
464 add_var(&script_snippet, "allow_empty_message",
465 opts->allow_empty_message ? "--allow-empty-message" : "");
466 add_var(&script_snippet, "rebase_merges",
467 opts->rebase_merges ? "t" : "");
468 add_var(&script_snippet, "rebase_cousins",
469 opts->rebase_cousins ? "t" : "");
470 add_var(&script_snippet, "strategy", opts->strategy);
471 add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
472 add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
473 add_var(&script_snippet, "squash_onto",
474 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
475 add_var(&script_snippet, "git_format_patch_opt",
476 opts->git_format_patch_opt.buf);
477 if (is_interactive(opts) &&
479 !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
480 strbuf_addstr(&script_snippet,
481 "GIT_EDITOR=:; export GIT_EDITOR; ");
482 opts->autosquash = 0;
483 }
484 switch (opts->type) {
486 case REBASE_AM:
487 backend = "git-rebase--am";
488 backend_func = "git_rebase__am";
489 break;
490 case REBASE_MERGE:
491 backend = "git-rebase--merge";
492 backend_func = "git_rebase__merge";
493 break;
494 case REBASE_PRESERVE_MERGES:
495 backend = "git-rebase--preserve-merges";
496 backend_func = "git_rebase__preserve_merges";
497 break;
498 default:
499 BUG("Unhandled rebase type %d", opts->type);
500 break;
501 }
502 strbuf_addf(&script_snippet,
504 ". git-sh-setup && . git-rebase--common &&"
505 " . %s && %s", backend, backend_func);
506 argv[0] = script_snippet.buf;
507 status = run_command_v_opt(argv, RUN_USING_SHELL);
509finished_rebase:
510 if (opts->dont_finish_rebase)
511 ; /* do nothing */
512 else if (opts->type == REBASE_INTERACTIVE)
513 ; /* interactive rebase cleans up after itself */
514 else if (status == 0) {
515 if (!file_exists(state_dir_path("stopped-sha", opts)))
516 finish_rebase(opts);
517 } else if (status == 2) {
518 struct strbuf dir = STRBUF_INIT;
519 apply_autostash(opts);
521 strbuf_addstr(&dir, opts->state_dir);
522 remove_dir_recursively(&dir, 0);
523 strbuf_release(&dir);
524 die("Nothing to do");
525 }
526 strbuf_release(&script_snippet);
528 return status ? -1 : 0;
530}
531#define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
533#define RESET_HEAD_DETACH (1<<0)
535#define RESET_HEAD_HARD (1<<1)
536static int reset_head(struct object_id *oid, const char *action,
538 const char *switch_to_branch, unsigned flags,
539 const char *reflog_orig_head, const char *reflog_head)
540{
541 unsigned detach_head = flags & RESET_HEAD_DETACH;
542 unsigned reset_hard = flags & RESET_HEAD_HARD;
543 struct object_id head_oid;
544 struct tree_desc desc[2] = { { NULL }, { NULL } };
545 struct lock_file lock = LOCK_INIT;
546 struct unpack_trees_options unpack_tree_opts;
547 struct tree *tree;
548 const char *reflog_action;
549 struct strbuf msg = STRBUF_INIT;
550 size_t prefix_len;
551 struct object_id *orig = NULL, oid_orig,
552 *old_orig = NULL, oid_old_orig;
553 int ret = 0, nr = 0;
554 if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
556 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
557 if (hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
559 ret = -1;
560 goto leave_reset_head;
561 }
562 if ((!oid || !reset_hard) && get_oid("HEAD", &head_oid)) {
564 ret = error(_("could not determine HEAD revision"));
565 goto leave_reset_head;
566 }
567 if (!oid)
569 oid = &head_oid;
570 memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
572 setup_unpack_trees_porcelain(&unpack_tree_opts, action);
573 unpack_tree_opts.head_idx = 1;
574 unpack_tree_opts.src_index = the_repository->index;
575 unpack_tree_opts.dst_index = the_repository->index;
576 unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
577 unpack_tree_opts.update = 1;
578 unpack_tree_opts.merge = 1;
579 if (!detach_head)
580 unpack_tree_opts.reset = 1;
581 if (read_index_unmerged(the_repository->index) < 0) {
583 ret = error(_("could not read index"));
584 goto leave_reset_head;
585 }
586 if (!reset_hard && !fill_tree_descriptor(&desc[nr++], &head_oid)) {
588 ret = error(_("failed to find tree of %s"),
589 oid_to_hex(&head_oid));
590 goto leave_reset_head;
591 }
592 if (!fill_tree_descriptor(&desc[nr++], oid)) {
594 ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
595 goto leave_reset_head;
596 }
597 if (unpack_trees(nr, desc, &unpack_tree_opts)) {
599 ret = -1;
600 goto leave_reset_head;
601 }
602 tree = parse_tree_indirect(oid);
604 prime_cache_tree(the_repository->index, tree);
605 if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0) {
607 ret = error(_("could not write index"));
608 goto leave_reset_head;
609 }
610 reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
612 strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
613 prefix_len = msg.len;
614 if (!get_oid("ORIG_HEAD", &oid_old_orig))
616 old_orig = &oid_old_orig;
617 if (!get_oid("HEAD", &oid_orig)) {
618 orig = &oid_orig;
619 if (!reflog_orig_head) {
620 strbuf_addstr(&msg, "updating ORIG_HEAD");
621 reflog_orig_head = msg.buf;
622 }
623 update_ref(reflog_orig_head, "ORIG_HEAD", orig, old_orig, 0,
624 UPDATE_REFS_MSG_ON_ERR);
625 } else if (old_orig)
626 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
627 if (!reflog_head) {
628 strbuf_setlen(&msg, prefix_len);
629 strbuf_addstr(&msg, "updating HEAD");
630 reflog_head = msg.buf;
631 }
632 if (!switch_to_branch)
633 ret = update_ref(reflog_head, "HEAD", oid, orig,
634 detach_head ? REF_NO_DEREF : 0,
635 UPDATE_REFS_MSG_ON_ERR);
636 else {
637 ret = create_symref("HEAD", switch_to_branch, msg.buf);
638 if (!ret)
639 ret = update_ref(reflog_head, "HEAD", oid, NULL, 0,
640 UPDATE_REFS_MSG_ON_ERR);
641 }
642leave_reset_head:
644 strbuf_release(&msg);
645 rollback_lock_file(&lock);
646 while (nr)
647 free((void *)desc[--nr].buffer);
648 return ret;
649}
650static int rebase_config(const char *var, const char *value, void *data)
652{
653 struct rebase_options *opts = data;
654 if (!strcmp(var, "rebase.stat")) {
656 if (git_config_bool(var, value))
657 opts->flags |= REBASE_DIFFSTAT;
658 else
659 opts->flags &= !REBASE_DIFFSTAT;
660 return 0;
661 }
662 if (!strcmp(var, "rebase.autosquash")) {
664 opts->autosquash = git_config_bool(var, value);
665 return 0;
666 }
667 if (!strcmp(var, "commit.gpgsign")) {
669 free(opts->gpg_sign_opt);
670 opts->gpg_sign_opt = git_config_bool(var, value) ?
671 xstrdup("-S") : NULL;
672 return 0;
673 }
674 if (!strcmp(var, "rebase.autostash")) {
676 opts->autostash = git_config_bool(var, value);
677 return 0;
678 }
679 if (!strcmp(var, "rebase.reschedulefailedexec")) {
681 opts->reschedule_failed_exec = git_config_bool(var, value);
682 return 0;
683 }
684 return git_default_config(var, value, data);
686}
687/*
689 * Determines whether the commits in from..to are linear, i.e. contain
690 * no merge commits. This function *expects* `from` to be an ancestor of
691 * `to`.
692 */
693static int is_linear_history(struct commit *from, struct commit *to)
694{
695 while (to && to != from) {
696 parse_commit(to);
697 if (!to->parents)
698 return 1;
699 if (to->parents->next)
700 return 0;
701 to = to->parents->item;
702 }
703 return 1;
704}
705static int can_fast_forward(struct commit *onto, struct object_id *head_oid,
707 struct object_id *merge_base)
708{
709 struct commit *head = lookup_commit(the_repository, head_oid);
710 struct commit_list *merge_bases;
711 int res;
712 if (!head)
714 return 0;
715 merge_bases = get_merge_bases(onto, head);
717 if (merge_bases && !merge_bases->next) {
718 oidcpy(merge_base, &merge_bases->item->object.oid);
719 res = oideq(merge_base, &onto->object.oid);
720 } else {
721 oidcpy(merge_base, &null_oid);
722 res = 0;
723 }
724 free_commit_list(merge_bases);
725 return res && is_linear_history(onto, head);
726}
727/* -i followed by -m is still -i */
729static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
730{
731 struct rebase_options *opts = opt->value;
732 BUG_ON_OPT_NEG(unset);
734 BUG_ON_OPT_ARG(arg);
735 if (!is_interactive(opts))
737 opts->type = REBASE_MERGE;
738 return 0;
740}
741/* -i followed by -p is still explicitly interactive, but -p alone is not */
743static int parse_opt_interactive(const struct option *opt, const char *arg,
744 int unset)
745{
746 struct rebase_options *opts = opt->value;
747 BUG_ON_OPT_NEG(unset);
749 BUG_ON_OPT_ARG(arg);
750 opts->type = REBASE_INTERACTIVE;
752 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
753 return 0;
755}
756static void NORETURN error_on_missing_default_upstream(void)
758{
759 struct branch *current_branch = branch_get(NULL);
760 printf(_("%s\n"
762 "Please specify which branch you want to rebase against.\n"
763 "See git-rebase(1) for details.\n"
764 "\n"
765 " git rebase '<branch>'\n"
766 "\n"),
767 current_branch ? _("There is no tracking information for "
768 "the current branch.") :
769 _("You are not currently on a branch."));
770 if (current_branch) {
772 const char *remote = current_branch->remote_name;
773 if (!remote)
775 remote = _("<remote>");
776 printf(_("If you wish to set tracking information for this "
778 "branch you can do so with:\n"
779 "\n"
780 " git branch --set-upstream-to=%s/<branch> %s\n"
781 "\n"),
782 remote, current_branch->name);
783 }
784 exit(1);
785}
786static void set_reflog_action(struct rebase_options *options)
788{
789 const char *env;
790 struct strbuf buf = STRBUF_INIT;
791 if (!is_interactive(options))
793 return;
794 env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
796 if (env && strcmp("rebase", env))
797 return; /* only override it if it is "rebase" */
798 strbuf_addf(&buf, "rebase -i (%s)", options->action);
800 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
801 strbuf_release(&buf);
802}
803int cmd_rebase(int argc, const char **argv, const char *prefix)
805{
806 struct rebase_options options = {
807 .type = REBASE_UNSPECIFIED,
808 .flags = REBASE_NO_QUIET,
809 .git_am_opts = ARGV_ARRAY_INIT,
810 .allow_rerere_autoupdate = -1,
811 .allow_empty_message = 1,
812 .git_format_patch_opt = STRBUF_INIT,
813 };
814 const char *branch_name;
815 int ret, flags, total_argc, in_progress = 0;
816 int ok_to_skip_pre_rebase = 0;
817 struct strbuf msg = STRBUF_INIT;
818 struct strbuf revisions = STRBUF_INIT;
819 struct strbuf buf = STRBUF_INIT;
820 struct object_id merge_base;
821 enum {
822 NO_ACTION,
823 ACTION_CONTINUE,
824 ACTION_SKIP,
825 ACTION_ABORT,
826 ACTION_QUIT,
827 ACTION_EDIT_TODO,
828 ACTION_SHOW_CURRENT_PATCH,
829 } action = NO_ACTION;
830 const char *gpg_sign = NULL;
831 struct string_list exec = STRING_LIST_INIT_NODUP;
832 const char *rebase_merges = NULL;
833 int fork_point = -1;
834 struct string_list strategy_options = STRING_LIST_INIT_NODUP;
835 struct object_id squash_onto;
836 char *squash_onto_name = NULL;
837 int reschedule_failed_exec = -1;
838 struct option builtin_rebase_options[] = {
839 OPT_STRING(0, "onto", &options.onto_name,
840 N_("revision"),
841 N_("rebase onto given branch instead of upstream")),
842 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
843 N_("allow pre-rebase hook to run")),
844 OPT_NEGBIT('q', "quiet", &options.flags,
845 N_("be quiet. implies --no-stat"),
846 REBASE_NO_QUIET| REBASE_VERBOSE | REBASE_DIFFSTAT),
847 OPT_BIT('v', "verbose", &options.flags,
848 N_("display a diffstat of what changed upstream"),
849 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
850 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
851 N_("do not show diffstat of what changed upstream"),
852 PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
853 OPT_BOOL(0, "signoff", &options.signoff,
854 N_("add a Signed-off-by: line to each commit")),
855 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
856 NULL, N_("passed to 'git am'"),
857 PARSE_OPT_NOARG),
858 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
859 &options.git_am_opts, NULL,
860 N_("passed to 'git am'"), PARSE_OPT_NOARG),
861 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
862 N_("passed to 'git am'"), PARSE_OPT_NOARG),
863 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
864 N_("passed to 'git apply'"), 0),
865 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
866 N_("action"), N_("passed to 'git apply'"), 0),
867 OPT_BIT('f', "force-rebase", &options.flags,
868 N_("cherry-pick all commits, even if unchanged"),
869 REBASE_FORCE),
870 OPT_BIT(0, "no-ff", &options.flags,
871 N_("cherry-pick all commits, even if unchanged"),
872 REBASE_FORCE),
873 OPT_CMDMODE(0, "continue", &action, N_("continue"),
874 ACTION_CONTINUE),
875 OPT_CMDMODE(0, "skip", &action,
876 N_("skip current patch and continue"), ACTION_SKIP),
877 OPT_CMDMODE(0, "abort", &action,
878 N_("abort and check out the original branch"),
879 ACTION_ABORT),
880 OPT_CMDMODE(0, "quit", &action,
881 N_("abort but keep HEAD where it is"), ACTION_QUIT),
882 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
883 "during an interactive rebase"), ACTION_EDIT_TODO),
884 OPT_CMDMODE(0, "show-current-patch", &action,
885 N_("show the patch file being applied or merged"),
886 ACTION_SHOW_CURRENT_PATCH),
887 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
888 N_("use merging strategies to rebase"),
889 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
890 parse_opt_merge },
891 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
892 N_("let the user edit the list of commits to rebase"),
893 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
894 parse_opt_interactive },
895 OPT_SET_INT('p', "preserve-merges", &options.type,
896 N_("try to recreate merges instead of ignoring "
897 "them"), REBASE_PRESERVE_MERGES),
898 OPT_BOOL(0, "rerere-autoupdate",
899 &options.allow_rerere_autoupdate,
900 N_("allow rerere to update index with resolved "
901 "conflict")),
902 OPT_BOOL('k', "keep-empty", &options.keep_empty,
903 N_("preserve empty commits during rebase")),
904 OPT_BOOL(0, "autosquash", &options.autosquash,
905 N_("move commits that begin with "
906 "squash!/fixup! under -i")),
907 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
908 N_("GPG-sign commits"),
909 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
910 OPT_BOOL(0, "autostash", &options.autostash,
911 N_("automatically stash/stash pop before and after")),
912 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
913 N_("add exec lines after each commit of the "
914 "editable list")),
915 OPT_BOOL(0, "allow-empty-message",
916 &options.allow_empty_message,
917 N_("allow rebasing commits with empty messages")),
918 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
919 N_("mode"),
920 N_("try to rebase merges instead of skipping them"),
921 PARSE_OPT_OPTARG, NULL, (intptr_t)""},
922 OPT_BOOL(0, "fork-point", &fork_point,
923 N_("use 'merge-base --fork-point' to refine upstream")),
924 OPT_STRING('s', "strategy", &options.strategy,
925 N_("strategy"), N_("use the given merge strategy")),
926 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
927 N_("option"),
928 N_("pass the argument through to the merge "
929 "strategy")),
930 OPT_BOOL(0, "root", &options.root,
931 N_("rebase all reachable commits up to the root(s)")),
932 OPT_BOOL(0, "reschedule-failed-exec",
933 &reschedule_failed_exec,
934 N_("automatically re-schedule any `exec` that fails")),
935 OPT_END(),
936 };
937 int i;
938 /*
940 * NEEDSWORK: Once the builtin rebase has been tested enough
941 * and git-legacy-rebase.sh is retired to contrib/, this preamble
942 * can be removed.
943 */
944 if (!use_builtin_rebase()) {
946 const char *path = mkpath("%s/git-legacy-rebase",
947 git_exec_path());
948 if (sane_execvp(path, (char **)argv) < 0)
950 die_errno(_("could not exec %s"), path);
951 else
952 BUG("sane_execvp() returned???");
953 }
954 if (argc == 2 && !strcmp(argv[1], "-h"))
956 usage_with_options(builtin_rebase_usage,
957 builtin_rebase_options);
958 prefix = setup_git_directory();
960 trace_repo_setup(prefix);
961 setup_work_tree();
962 git_config(rebase_config, &options);
964 strbuf_reset(&buf);
966 strbuf_addf(&buf, "%s/applying", apply_dir());
967 if(file_exists(buf.buf))
968 die(_("It looks like 'git am' is in progress. Cannot rebase."));
969 if (is_directory(apply_dir())) {
971 options.type = REBASE_AM;
972 options.state_dir = apply_dir();
973 } else if (is_directory(merge_dir())) {
974 strbuf_reset(&buf);
975 strbuf_addf(&buf, "%s/rewritten", merge_dir());
976 if (is_directory(buf.buf)) {
977 options.type = REBASE_PRESERVE_MERGES;
978 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
979 } else {
980 strbuf_reset(&buf);
981 strbuf_addf(&buf, "%s/interactive", merge_dir());
982 if(file_exists(buf.buf)) {
983 options.type = REBASE_INTERACTIVE;
984 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
985 } else
986 options.type = REBASE_MERGE;
987 }
988 options.state_dir = merge_dir();
989 }
990 if (options.type != REBASE_UNSPECIFIED)
992 in_progress = 1;
993 total_argc = argc;
995 argc = parse_options(argc, argv, prefix,
996 builtin_rebase_options,
997 builtin_rebase_usage, 0);
998 if (action != NO_ACTION && total_argc != 2) {
1000 usage_with_options(builtin_rebase_usage,
1001 builtin_rebase_options);
1002 }
1003 if (argc > 2)
1005 usage_with_options(builtin_rebase_usage,
1006 builtin_rebase_options);
1007 if (action != NO_ACTION && !in_progress)
1009 die(_("No rebase in progress?"));
1010 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
1011 if (action == ACTION_EDIT_TODO && !is_interactive(&options))
1013 die(_("The --edit-todo action can only be used during "
1014 "interactive rebase."));
1015 switch (action) {
1017 case ACTION_CONTINUE: {
1018 struct object_id head;
1019 struct lock_file lock_file = LOCK_INIT;
1020 int fd;
1021 options.action = "continue";
1023 set_reflog_action(&options);
1024 /* Sanity check */
1026 if (get_oid("HEAD", &head))
1027 die(_("Cannot read HEAD"));
1028 fd = hold_locked_index(&lock_file, 0);
1030 if (read_index(the_repository->index) < 0)
1031 die(_("could not read index"));
1032 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1033 NULL);
1034 if (0 <= fd)
1035 update_index_if_able(the_repository->index,
1036 &lock_file);
1037 rollback_lock_file(&lock_file);
1038 if (has_unstaged_changes(1)) {
1040 puts(_("You must edit all merge conflicts and then\n"
1041 "mark them as resolved using git add"));
1042 exit(1);
1043 }
1044 if (read_basic_state(&options))
1045 exit(1);
1046 goto run_rebase;
1047 }
1048 case ACTION_SKIP: {
1049 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1050 options.action = "skip";
1052 set_reflog_action(&options);
1053 rerere_clear(&merge_rr);
1055 string_list_clear(&merge_rr, 1);
1056 if (reset_head(NULL, "reset", NULL, RESET_HEAD_HARD,
1058 NULL, NULL) < 0)
1059 die(_("could not discard worktree changes"));
1060 remove_branch_state();
1061 if (read_basic_state(&options))
1062 exit(1);
1063 goto run_rebase;
1064 }
1065 case ACTION_ABORT: {
1066 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1067 options.action = "abort";
1068 set_reflog_action(&options);
1069 rerere_clear(&merge_rr);
1071 string_list_clear(&merge_rr, 1);
1072 if (read_basic_state(&options))
1074 exit(1);
1075 if (reset_head(&options.orig_head, "reset",
1076 options.head_name, RESET_HEAD_HARD,
1077 NULL, NULL) < 0)
1078 die(_("could not move back to %s"),
1079 oid_to_hex(&options.orig_head));
1080 remove_branch_state();
1081 ret = finish_rebase(&options);
1082 goto cleanup;
1083 }
1084 case ACTION_QUIT: {
1085 strbuf_reset(&buf);
1086 strbuf_addstr(&buf, options.state_dir);
1087 ret = !!remove_dir_recursively(&buf, 0);
1088 if (ret)
1089 die(_("could not remove '%s'"), options.state_dir);
1090 goto cleanup;
1091 }
1092 case ACTION_EDIT_TODO:
1093 options.action = "edit-todo";
1094 options.dont_finish_rebase = 1;
1095 goto run_rebase;
1096 case ACTION_SHOW_CURRENT_PATCH:
1097 options.action = "show-current-patch";
1098 options.dont_finish_rebase = 1;
1099 goto run_rebase;
1100 case NO_ACTION:
1101 break;
1102 default:
1103 BUG("action: %d", action);
1104 }
1105 /* Make sure no rebase is in progress */
1107 if (in_progress) {
1108 const char *last_slash = strrchr(options.state_dir, '/');
1109 const char *state_dir_base =
1110 last_slash ? last_slash + 1 : options.state_dir;
1111 const char *cmd_live_rebase =
1112 "git rebase (--continue | --abort | --skip)";
1113 strbuf_reset(&buf);
1114 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1115 die(_("It seems that there is already a %s directory, and\n"
1116 "I wonder if you are in the middle of another rebase. "
1117 "If that is the\n"
1118 "case, please try\n\t%s\n"
1119 "If that is not the case, please\n\t%s\n"
1120 "and run me again. I am stopping in case you still "
1121 "have something\n"
1122 "valuable there.\n"),
1123 state_dir_base, cmd_live_rebase, buf.buf);
1124 }
1125 for (i = 0; i < options.git_am_opts.argc; i++) {
1127 const char *option = options.git_am_opts.argv[i], *p;
1128 if (!strcmp(option, "--committer-date-is-author-date") ||
1129 !strcmp(option, "--ignore-date") ||
1130 !strcmp(option, "--whitespace=fix") ||
1131 !strcmp(option, "--whitespace=strip"))
1132 options.flags |= REBASE_FORCE;
1133 else if (skip_prefix(option, "-C", &p)) {
1134 while (*p)
1135 if (!isdigit(*(p++)))
1136 die(_("switch `C' expects a "
1137 "numerical value"));
1138 } else if (skip_prefix(option, "--whitespace=", &p)) {
1139 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1140 strcmp(p, "error") && strcmp(p, "error-all"))
1141 die("Invalid whitespace option: '%s'", p);
1142 }
1143 }
1144 if (!(options.flags & REBASE_NO_QUIET))
1146 argv_array_push(&options.git_am_opts, "-q");
1147 if (options.keep_empty)
1149 imply_interactive(&options, "--keep-empty");
1150 if (gpg_sign) {
1152 free(options.gpg_sign_opt);
1153 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1154 }
1155 if (exec.nr) {
1157 int i;
1158 imply_interactive(&options, "--exec");
1160 strbuf_reset(&buf);
1162 for (i = 0; i < exec.nr; i++)
1163 strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1164 options.cmd = xstrdup(buf.buf);
1165 }
1166 if (rebase_merges) {
1168 if (!*rebase_merges)
1169 ; /* default mode; do nothing */
1170 else if (!strcmp("rebase-cousins", rebase_merges))
1171 options.rebase_cousins = 1;
1172 else if (strcmp("no-rebase-cousins", rebase_merges))
1173 die(_("Unknown mode: %s"), rebase_merges);
1174 options.rebase_merges = 1;
1175 imply_interactive(&options, "--rebase-merges");
1176 }
1177 if (strategy_options.nr) {
1179 int i;
1180 if (!options.strategy)
1182 options.strategy = "recursive";
1183 strbuf_reset(&buf);
1185 for (i = 0; i < strategy_options.nr; i++)
1186 strbuf_addf(&buf, " --%s",
1187 strategy_options.items[i].string);
1188 options.strategy_opts = xstrdup(buf.buf);
1189 }
1190 if (options.strategy) {
1192 options.strategy = xstrdup(options.strategy);
1193 switch (options.type) {
1194 case REBASE_AM:
1195 die(_("--strategy requires --merge or --interactive"));
1196 case REBASE_MERGE:
1197 case REBASE_INTERACTIVE:
1198 case REBASE_PRESERVE_MERGES:
1199 /* compatible */
1200 break;
1201 case REBASE_UNSPECIFIED:
1202 options.type = REBASE_MERGE;
1203 break;
1204 default:
1205 BUG("unhandled rebase type (%d)", options.type);
1206 }
1207 }
1208 if (options.root && !options.onto_name)
1210 imply_interactive(&options, "--root without --onto");
1211 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1213 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1214 switch (options.type) {
1216 case REBASE_MERGE:
1217 case REBASE_INTERACTIVE:
1218 case REBASE_PRESERVE_MERGES:
1219 options.state_dir = merge_dir();
1220 break;
1221 case REBASE_AM:
1222 options.state_dir = apply_dir();
1223 break;
1224 default:
1225 /* the default rebase backend is `--am` */
1226 options.type = REBASE_AM;
1227 options.state_dir = apply_dir();
1228 break;
1229 }
1230 if (reschedule_failed_exec > 0 && !is_interactive(&options))
1232 die(_("--reschedule-failed-exec requires "
1233 "--exec or --interactive"));
1234 if (reschedule_failed_exec >= 0)
1235 options.reschedule_failed_exec = reschedule_failed_exec;
1236 if (options.git_am_opts.argc) {
1238 /* all am options except -q are compatible only with --am */
1239 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1240 if (strcmp(options.git_am_opts.argv[i], "-q"))
1241 break;
1242 if (is_interactive(&options) && i >= 0)
1244 die(_("error: cannot combine interactive options "
1245 "(--interactive, --exec, --rebase-merges, "
1246 "--preserve-merges, --keep-empty, --root + "
1247 "--onto) with am options (%s)"), buf.buf);
1248 if (options.type == REBASE_MERGE && i >= 0)
1249 die(_("error: cannot combine merge options (--merge, "
1250 "--strategy, --strategy-option) with am options "
1251 "(%s)"), buf.buf);
1252 }
1253 if (options.signoff) {
1255 if (options.type == REBASE_PRESERVE_MERGES)
1256 die("cannot combine '--signoff' with "
1257 "'--preserve-merges'");
1258 argv_array_push(&options.git_am_opts, "--signoff");
1259 options.flags |= REBASE_FORCE;
1260 }
1261 if (options.type == REBASE_PRESERVE_MERGES) {
1263 /*
1264 * Note: incompatibility with --signoff handled in signoff block above
1265 * Note: incompatibility with --interactive is just a strong warning;
1266 * git-rebase.txt caveats with "unless you know what you are doing"
1267 */
1268 if (options.rebase_merges)
1269 die(_("error: cannot combine '--preserve-merges' with "
1270 "'--rebase-merges'"));
1271 if (options.reschedule_failed_exec)
1273 die(_("error: cannot combine '--preserve-merges' with "
1274 "'--reschedule-failed-exec'"));
1275 }
1276 if (options.rebase_merges) {
1278 if (strategy_options.nr)
1279 die(_("error: cannot combine '--rebase-merges' with "
1280 "'--strategy-option'"));
1281 if (options.strategy)
1282 die(_("error: cannot combine '--rebase-merges' with "
1283 "'--strategy'"));
1284 }
1285 if (!options.root) {
1287 if (argc < 1) {
1288 struct branch *branch;
1289 branch = branch_get(NULL);
1291 options.upstream_name = branch_get_upstream(branch,
1292 NULL);
1293 if (!options.upstream_name)
1294 error_on_missing_default_upstream();
1295 if (fork_point < 0)
1296 fork_point = 1;
1297 } else {
1298 options.upstream_name = argv[0];
1299 argc--;
1300 argv++;
1301 if (!strcmp(options.upstream_name, "-"))
1302 options.upstream_name = "@{-1}";
1303 }
1304 options.upstream = peel_committish(options.upstream_name);
1305 if (!options.upstream)
1306 die(_("invalid upstream '%s'"), options.upstream_name);
1307 options.upstream_arg = options.upstream_name;
1308 } else {
1309 if (!options.onto_name) {
1310 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1311 &squash_onto, NULL, NULL) < 0)
1312 die(_("Could not create new root commit"));
1313 options.squash_onto = &squash_onto;
1314 options.onto_name = squash_onto_name =
1315 xstrdup(oid_to_hex(&squash_onto));
1316 }
1317 options.upstream_name = NULL;
1318 options.upstream = NULL;
1319 if (argc > 1)
1320 usage_with_options(builtin_rebase_usage,
1321 builtin_rebase_options);
1322 options.upstream_arg = "--root";
1323 }
1324 /* Make sure the branch to rebase onto is valid. */
1326 if (!options.onto_name)
1327 options.onto_name = options.upstream_name;
1328 if (strstr(options.onto_name, "...")) {
1329 if (get_oid_mb(options.onto_name, &merge_base) < 0)
1330 die(_("'%s': need exactly one merge base"),
1331 options.onto_name);
1332 options.onto = lookup_commit_or_die(&merge_base,
1333 options.onto_name);
1334 } else {
1335 options.onto = peel_committish(options.onto_name);
1336 if (!options.onto)
1337 die(_("Does not point to a valid commit '%s'"),
1338 options.onto_name);
1339 }
1340 /*
1342 * If the branch to rebase is given, that is the branch we will rebase
1343 * branch_name -- branch/commit being rebased, or
1344 * HEAD (already detached)
1345 * orig_head -- commit object name of tip of the branch before rebasing
1346 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1347 */
1348 if (argc == 1) {
1349 /* Is it "rebase other branchname" or "rebase other commit"? */
1350 branch_name = argv[0];
1351 options.switch_to = argv[0];
1352 /* Is it a local branch? */
1354 strbuf_reset(&buf);
1355 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1356 if (!read_ref(buf.buf, &options.orig_head))
1357 options.head_name = xstrdup(buf.buf);
1358 /* If not is it a valid ref (branch or commit)? */
1359 else if (!get_oid(branch_name, &options.orig_head))
1360 options.head_name = NULL;
1361 else
1362 die(_("fatal: no such branch/commit '%s'"),
1363 branch_name);
1364 } else if (argc == 0) {
1365 /* Do not need to switch branches, we are already on it. */
1366 options.head_name =
1367 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1368 &flags));
1369 if (!options.head_name)
1370 die(_("No such ref: %s"), "HEAD");
1371 if (flags & REF_ISSYMREF) {
1372 if (!skip_prefix(options.head_name,
1373 "refs/heads/", &branch_name))
1374 branch_name = options.head_name;
1375 } else {
1377 free(options.head_name);
1378 options.head_name = NULL;
1379 branch_name = "HEAD";
1380 }
1381 if (get_oid("HEAD", &options.orig_head))
1382 die(_("Could not resolve HEAD to a revision"));
1383 } else
1384 BUG("unexpected number of arguments left to parse");
1385 if (fork_point > 0) {
1387 struct commit *head =
1388 lookup_commit_reference(the_repository,
1389 &options.orig_head);
1390 options.restrict_revision =
1391 get_fork_point(options.upstream_name, head);
1392 }
1393 if (read_index(the_repository->index) < 0)
1395 die(_("could not read index"));
1396 if (options.autostash) {
1398 struct lock_file lock_file = LOCK_INIT;
1399 int fd;
1400 fd = hold_locked_index(&lock_file, 0);
1402 refresh_cache(REFRESH_QUIET);
1403 if (0 <= fd)
1404 update_index_if_able(&the_index, &lock_file);
1405 rollback_lock_file(&lock_file);
1406 if (has_unstaged_changes(1) || has_uncommitted_changes(1)) {
1408 const char *autostash =
1409 state_dir_path("autostash", &options);
1410 struct child_process stash = CHILD_PROCESS_INIT;
1411 struct object_id oid;
1412 struct commit *head =
1413 lookup_commit_reference(the_repository,
1414 &options.orig_head);
1415 argv_array_pushl(&stash.args,
1417 "stash", "create", "autostash", NULL);
1418 stash.git_cmd = 1;
1419 stash.no_stdin = 1;
1420 strbuf_reset(&buf);
1421 if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
1422 die(_("Cannot autostash"));
1423 strbuf_trim_trailing_newline(&buf);
1424 if (get_oid(buf.buf, &oid))
1425 die(_("Unexpected stash response: '%s'"),
1426 buf.buf);
1427 strbuf_reset(&buf);
1428 strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
1429 if (safe_create_leading_directories_const(autostash))
1431 die(_("Could not create directory for '%s'"),
1432 options.state_dir);
1433 write_file(autostash, "%s", oid_to_hex(&oid));
1434 printf(_("Created autostash: %s\n"), buf.buf);
1435 if (reset_head(&head->object.oid, "reset --hard",
1436 NULL, RESET_HEAD_HARD, NULL, NULL) < 0)
1437 die(_("could not reset --hard"));
1438 printf(_("HEAD is now at %s"),
1439 find_unique_abbrev(&head->object.oid,
1440 DEFAULT_ABBREV));
1441 strbuf_reset(&buf);
1442 pp_commit_easy(CMIT_FMT_ONELINE, head, &buf);
1443 if (buf.len > 0)
1444 printf(" %s", buf.buf);
1445 putchar('\n');
1446 if (discard_index(the_repository->index) < 0 ||
1448 read_index(the_repository->index) < 0)
1449 die(_("could not read index"));
1450 }
1451 }
1452 if (require_clean_work_tree("rebase",
1454 _("Please commit or stash them."), 1, 1)) {
1455 ret = 1;
1456 goto cleanup;
1457 }
1458 /*
1460 * Now we are rebasing commits upstream..orig_head (or with --root,
1461 * everything leading up to orig_head) on top of onto.
1462 */
1463 /*
1465 * Check if we are already based on onto with linear history,
1466 * but this should be done only when upstream and onto are the same
1467 * and if this is not an interactive rebase.
1468 */
1469 if (can_fast_forward(options.onto, &options.orig_head, &merge_base) &&
1470 !is_interactive(&options) && !options.restrict_revision &&
1471 options.upstream &&
1472 !oidcmp(&options.upstream->object.oid, &options.onto->object.oid)) {
1473 int flag;
1474 if (!(options.flags & REBASE_FORCE)) {
1476 /* Lazily switch to the target branch if needed... */
1477 if (options.switch_to) {
1478 struct object_id oid;
1479 if (get_oid(options.switch_to, &oid) < 0) {
1481 ret = !!error(_("could not parse '%s'"),
1482 options.switch_to);
1483 goto cleanup;
1484 }
1485 strbuf_reset(&buf);
1487 strbuf_addf(&buf, "%s: checkout %s",
1488 getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
1489 options.switch_to);
1490 if (reset_head(&oid, "checkout",
1491 options.head_name, 0,
1492 NULL, buf.buf) < 0) {
1493 ret = !!error(_("could not switch to "
1494 "%s"),
1495 options.switch_to);
1496 goto cleanup;
1497 }
1498 }
1499 if (!(options.flags & REBASE_NO_QUIET))
1501 ; /* be quiet */
1502 else if (!strcmp(branch_name, "HEAD") &&
1503 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1504 puts(_("HEAD is up to date."));
1505 else
1506 printf(_("Current branch %s is up to date.\n"),
1507 branch_name);
1508 ret = !!finish_rebase(&options);
1509 goto cleanup;
1510 } else if (!(options.flags & REBASE_NO_QUIET))
1511 ; /* be quiet */
1512 else if (!strcmp(branch_name, "HEAD") &&
1513 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1514 puts(_("HEAD is up to date, rebase forced."));
1515 else
1516 printf(_("Current branch %s is up to date, rebase "
1517 "forced.\n"), branch_name);
1518 }
1519 /* If a hook exists, give it a chance to interrupt*/
1521 if (!ok_to_skip_pre_rebase &&
1522 run_hook_le(NULL, "pre-rebase", options.upstream_arg,
1523 argc ? argv[0] : NULL, NULL))
1524 die(_("The pre-rebase hook refused to rebase."));
1525 if (options.flags & REBASE_DIFFSTAT) {
1527 struct diff_options opts;
1528 if (options.flags & REBASE_VERBOSE) {
1530 if (is_null_oid(&merge_base))
1531 printf(_("Changes to %s:\n"),
1532 oid_to_hex(&options.onto->object.oid));
1533 else
1534 printf(_("Changes from %s to %s:\n"),
1535 oid_to_hex(&merge_base),
1536 oid_to_hex(&options.onto->object.oid));
1537 }
1538 /* We want color (if set), but no pager */
1540 diff_setup(&opts);
1541 opts.stat_width = -1; /* use full terminal width */
1542 opts.stat_graph_width = -1; /* respect statGraphWidth config */
1543 opts.output_format |=
1544 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1545 opts.detect_rename = DIFF_DETECT_RENAME;
1546 diff_setup_done(&opts);
1547 diff_tree_oid(is_null_oid(&merge_base) ?
1548 the_hash_algo->empty_tree : &merge_base,
1549 &options.onto->object.oid, "", &opts);
1550 diffcore_std(&opts);
1551 diff_flush(&opts);
1552 }
1553 if (is_interactive(&options))
1555 goto run_rebase;
1556 /* Detach HEAD and reset the tree */
1558 if (options.flags & REBASE_NO_QUIET)
1559 printf(_("First, rewinding head to replay your work on top of "
1560 "it...\n"));
1561 strbuf_addf(&msg, "%s: checkout %s",
1563 getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
1564 if (reset_head(&options.onto->object.oid, "checkout", NULL,
1565 RESET_HEAD_DETACH, NULL, msg.buf))
1566 die(_("Could not detach HEAD"));
1567 strbuf_release(&msg);
1568 /*
1570 * If the onto is a proper descendant of the tip of the branch, then
1571 * we just fast-forwarded.
1572 */
1573 strbuf_reset(&msg);
1574 if (!oidcmp(&merge_base, &options.orig_head)) {
1575 printf(_("Fast-forwarded %s to %s.\n"),
1576 branch_name, options.onto_name);
1577 strbuf_addf(&msg, "rebase finished: %s onto %s",
1578 options.head_name ? options.head_name : "detached HEAD",
1579 oid_to_hex(&options.onto->object.oid));
1580 reset_head(NULL, "Fast-forwarded", options.head_name, 0,
1581 "HEAD", msg.buf);
1582 strbuf_release(&msg);
1583 ret = !!finish_rebase(&options);
1584 goto cleanup;
1585 }
1586 strbuf_addf(&revisions, "%s..%s",
1588 options.root ? oid_to_hex(&options.onto->object.oid) :
1589 (options.restrict_revision ?
1590 oid_to_hex(&options.restrict_revision->object.oid) :
1591 oid_to_hex(&options.upstream->object.oid)),
1592 oid_to_hex(&options.orig_head));
1593 options.revisions = revisions.buf;
1595run_rebase:
1597 ret = !!run_specific_rebase(&options);
1598cleanup:
1600 strbuf_release(&revisions);
1601 free(options.head_name);
1602 free(options.gpg_sign_opt);
1603 free(options.cmd);
1604 free(squash_onto_name);
1605 return ret;
1606}