2 * "git rebase" builtin command
4 * Copyright (c) 2018 Pratik Karki
7 #define USE_THE_INDEX_COMPATIBILITY_MACROS
9 #include "run-command.h"
11 #include "argv-array.h"
17 #include "cache-tree.h"
18 #include "unpack-trees.h"
20 #include "parse-options.h"
23 #include "wt-status.h"
25 #include "commit-reach.h"
29 static 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>] "
34 N_("git rebase --continue | --abort | --skip | --edit-todo"),
38 static GIT_PATH_FUNC(apply_dir
, "rebase-apply")
39 static GIT_PATH_FUNC(merge_dir
, "rebase-merge")
42 REBASE_UNSPECIFIED
= -1,
46 REBASE_PRESERVE_MERGES
49 static int use_builtin_rebase(void)
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);
58 argv_array_pushl(&cp
.args
,
59 "config", "--bool", "rebase.usebuiltin", NULL
);
61 if (capture_command(&cp
, &out
, 6)) {
67 ret
= !strcmp("true", out
.buf
);
72 struct 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
;
79 struct object_id orig_head
;
81 const char *onto_name
;
82 const char *revisions
;
83 const char *switch_to
;
85 struct object_id
*squash_onto
;
86 struct commit
*restrict_revision
;
87 int dont_finish_rebase
;
89 REBASE_NO_QUIET
= 1<<0,
90 REBASE_VERBOSE
= 1<<1,
91 REBASE_DIFFSTAT
= 1<<2,
93 REBASE_INTERACTIVE_EXPLICIT
= 1<<4,
95 struct argv_array git_am_opts
;
98 int allow_rerere_autoupdate
;
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
;
111 static int is_interactive(struct rebase_options
*opts
)
113 return opts
->type
== REBASE_INTERACTIVE
||
114 opts
->type
== REBASE_PRESERVE_MERGES
;
117 static void imply_interactive(struct rebase_options
*opts
, const char *option
)
119 switch (opts
->type
) {
121 die(_("%s requires an interactive rebase"), option
);
123 case REBASE_INTERACTIVE
:
124 case REBASE_PRESERVE_MERGES
:
127 /* we now implement --merge via --interactive */
129 opts
->type
= REBASE_INTERACTIVE
; /* implied */
134 /* Returns the filename prefixed by the state_dir */
135 static const char *state_dir_path(const char *filename
, struct rebase_options
*opts
)
137 static struct strbuf path
= STRBUF_INIT
;
138 static size_t prefix_len
;
141 strbuf_addf(&path
, "%s/", opts
->state_dir
);
142 prefix_len
= path
.len
;
145 strbuf_setlen(&path
, prefix_len
);
146 strbuf_addstr(&path
, filename
);
150 /* Read one file, then strip line endings */
151 static int read_one(const char *path
, struct strbuf
*buf
)
153 if (strbuf_read_file(buf
, path
, 0) < 0)
154 return error_errno(_("could not read '%s'"), path
);
155 strbuf_trim_trailing_newline(buf
);
159 /* Initialize the rebase options from the state directory. */
160 static int read_basic_state(struct rebase_options
*opts
)
162 struct strbuf head_name
= STRBUF_INIT
;
163 struct strbuf buf
= STRBUF_INIT
;
164 struct object_id oid
;
166 if (read_one(state_dir_path("head-name", opts
), &head_name
) ||
167 read_one(state_dir_path("onto", opts
), &buf
))
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
);
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.
182 if (file_exists(state_dir_path("orig-head", opts
))) {
183 if (read_one(state_dir_path("orig-head", opts
), &buf
))
185 } else if (read_one(state_dir_path("head", opts
), &buf
))
187 if (get_oid(buf
.buf
, &opts
->orig_head
))
188 return error(_("invalid orig-head: '%s'"), buf
.buf
);
190 if (file_exists(state_dir_path("quiet", opts
)))
191 opts
->flags
&= ~REBASE_NO_QUIET
;
193 opts
->flags
|= REBASE_NO_QUIET
;
195 if (file_exists(state_dir_path("verbose", opts
)))
196 opts
->flags
|= REBASE_VERBOSE
;
198 if (file_exists(state_dir_path("signoff", opts
))) {
200 opts
->flags
|= REBASE_FORCE
;
203 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts
))) {
205 if (read_one(state_dir_path("allow_rerere_autoupdate", opts
),
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;
213 warning(_("ignoring invalid allow_rerere_autoupdate: "
216 opts
->allow_rerere_autoupdate
= -1;
218 if (file_exists(state_dir_path("gpg_sign_opt", opts
))) {
220 if (read_one(state_dir_path("gpg_sign_opt", opts
),
223 free(opts
->gpg_sign_opt
);
224 opts
->gpg_sign_opt
= xstrdup(buf
.buf
);
227 if (file_exists(state_dir_path("strategy", opts
))) {
229 if (read_one(state_dir_path("strategy", opts
), &buf
))
231 free(opts
->strategy
);
232 opts
->strategy
= xstrdup(buf
.buf
);
235 if (file_exists(state_dir_path("strategy_opts", opts
))) {
237 if (read_one(state_dir_path("strategy_opts", opts
), &buf
))
239 free(opts
->strategy_opts
);
240 opts
->strategy_opts
= xstrdup(buf
.buf
);
243 strbuf_release(&buf
);
248 static int write_basic_state(struct rebase_options
*opts
)
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", "");
261 write_file(state_dir_path("strategy", opts
), "%s",
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",
274 write_file(state_dir_path("strategy", opts
), "--signoff");
279 static int apply_autostash(struct rebase_options
*opts
)
281 const char *path
= state_dir_path("autostash", opts
);
282 struct strbuf autostash
= STRBUF_INIT
;
283 struct child_process stash_apply
= CHILD_PROCESS_INIT
;
285 if (!file_exists(path
))
288 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"));
300 struct argv_array args
= ARGV_ARRAY_INIT
;
303 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
);
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\" "
320 strbuf_release(&autostash
);
324 static int finish_rebase(struct rebase_options
*opts
)
326 struct strbuf dir
= STRBUF_INIT
;
327 const char *argv_gc_auto
[] = { "gc", "--auto", NULL
};
329 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
330 apply_autostash(opts
);
331 close_all_packs(the_repository
->objects
);
333 * We ignore errors in 'gc --auto', since the
334 * user should see them.
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
);
344 static struct commit
*peel_committish(const char *name
)
347 struct object_id oid
;
349 if (get_oid(name
, &oid
))
351 obj
= parse_object(the_repository
, &oid
);
352 return (struct commit
*)peel_to_type(name
, 0, obj
, OBJ_COMMIT
);
355 static void add_var(struct strbuf
*buf
, const char *name
, const char *value
)
358 strbuf_addf(buf
, "unset %s; ", name
);
360 strbuf_addf(buf
, "%s=", name
);
361 sq_quote_buf(buf
, value
);
362 strbuf_addstr(buf
, "; ");
366 #define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
368 #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)
372 #define RESET_ORIG_HEAD (1<<4)
374 static int reset_head(struct object_id
*oid
, const char *action
,
375 const char *switch_to_branch
, unsigned flags
,
376 const char *reflog_orig_head
, const char *reflog_head
)
378 unsigned detach_head
= flags
& RESET_HEAD_DETACH
;
379 unsigned reset_hard
= flags
& RESET_HEAD_HARD
;
380 unsigned run_hook
= flags
& RESET_HEAD_RUN_POST_CHECKOUT_HOOK
;
381 unsigned refs_only
= flags
& RESET_HEAD_REFS_ONLY
;
382 unsigned update_orig_head
= flags
& RESET_ORIG_HEAD
;
383 struct object_id head_oid
;
384 struct tree_desc desc
[2] = { { NULL
}, { NULL
} };
385 struct lock_file lock
= LOCK_INIT
;
386 struct unpack_trees_options unpack_tree_opts
;
388 const char *reflog_action
;
389 struct strbuf msg
= STRBUF_INIT
;
391 struct object_id
*orig
= NULL
, oid_orig
,
392 *old_orig
= NULL
, oid_old_orig
;
395 if (switch_to_branch
&& !starts_with(switch_to_branch
, "refs/"))
396 BUG("Not a fully qualified branch: '%s'", switch_to_branch
);
398 if (!refs_only
&& hold_locked_index(&lock
, LOCK_REPORT_ON_ERROR
) < 0) {
400 goto leave_reset_head
;
403 if ((!oid
|| !reset_hard
) && get_oid("HEAD", &head_oid
)) {
404 ret
= error(_("could not determine HEAD revision"));
405 goto leave_reset_head
;
412 goto reset_head_refs
;
414 memset(&unpack_tree_opts
, 0, sizeof(unpack_tree_opts
));
415 setup_unpack_trees_porcelain(&unpack_tree_opts
, action
);
416 unpack_tree_opts
.head_idx
= 1;
417 unpack_tree_opts
.src_index
= the_repository
->index
;
418 unpack_tree_opts
.dst_index
= the_repository
->index
;
419 unpack_tree_opts
.fn
= reset_hard
? oneway_merge
: twoway_merge
;
420 unpack_tree_opts
.update
= 1;
421 unpack_tree_opts
.merge
= 1;
423 unpack_tree_opts
.reset
= 1;
425 if (repo_read_index_unmerged(the_repository
) < 0) {
426 ret
= error(_("could not read index"));
427 goto leave_reset_head
;
430 if (!reset_hard
&& !fill_tree_descriptor(&desc
[nr
++], &head_oid
)) {
431 ret
= error(_("failed to find tree of %s"),
432 oid_to_hex(&head_oid
));
433 goto leave_reset_head
;
436 if (!fill_tree_descriptor(&desc
[nr
++], oid
)) {
437 ret
= error(_("failed to find tree of %s"), oid_to_hex(oid
));
438 goto leave_reset_head
;
441 if (unpack_trees(nr
, desc
, &unpack_tree_opts
)) {
443 goto leave_reset_head
;
446 tree
= parse_tree_indirect(oid
);
447 prime_cache_tree(the_repository
, the_repository
->index
, tree
);
449 if (write_locked_index(the_repository
->index
, &lock
, COMMIT_LOCK
) < 0) {
450 ret
= error(_("could not write index"));
451 goto leave_reset_head
;
455 reflog_action
= getenv(GIT_REFLOG_ACTION_ENVIRONMENT
);
456 strbuf_addf(&msg
, "%s: ", reflog_action
? reflog_action
: "rebase");
457 prefix_len
= msg
.len
;
459 if (update_orig_head
) {
460 if (!get_oid("ORIG_HEAD", &oid_old_orig
))
461 old_orig
= &oid_old_orig
;
462 if (!get_oid("HEAD", &oid_orig
)) {
464 if (!reflog_orig_head
) {
465 strbuf_addstr(&msg
, "updating ORIG_HEAD");
466 reflog_orig_head
= msg
.buf
;
468 update_ref(reflog_orig_head
, "ORIG_HEAD", orig
,
469 old_orig
, 0, UPDATE_REFS_MSG_ON_ERR
);
471 delete_ref(NULL
, "ORIG_HEAD", old_orig
, 0);
475 strbuf_setlen(&msg
, prefix_len
);
476 strbuf_addstr(&msg
, "updating HEAD");
477 reflog_head
= msg
.buf
;
479 if (!switch_to_branch
)
480 ret
= update_ref(reflog_head
, "HEAD", oid
, orig
,
481 detach_head
? REF_NO_DEREF
: 0,
482 UPDATE_REFS_MSG_ON_ERR
);
484 ret
= update_ref(reflog_head
, switch_to_branch
, oid
,
485 NULL
, 0, UPDATE_REFS_MSG_ON_ERR
);
487 ret
= create_symref("HEAD", switch_to_branch
,
491 run_hook_le(NULL
, "post-checkout",
492 oid_to_hex(orig
? orig
: &null_oid
),
493 oid_to_hex(oid
), "1", NULL
);
496 strbuf_release(&msg
);
497 rollback_lock_file(&lock
);
499 free((void *)desc
[--nr
].buffer
);
503 static int move_to_original_branch(struct rebase_options
*opts
)
505 struct strbuf orig_head_reflog
= STRBUF_INIT
, head_reflog
= STRBUF_INIT
;
508 if (!opts
->head_name
)
509 return 0; /* nothing to move back to */
512 BUG("move_to_original_branch without onto");
514 strbuf_addf(&orig_head_reflog
, "rebase finished: %s onto %s",
515 opts
->head_name
, oid_to_hex(&opts
->onto
->object
.oid
));
516 strbuf_addf(&head_reflog
, "rebase finished: returning to %s",
518 ret
= reset_head(NULL
, "", opts
->head_name
, RESET_HEAD_REFS_ONLY
,
519 orig_head_reflog
.buf
, head_reflog
.buf
);
521 strbuf_release(&orig_head_reflog
);
522 strbuf_release(&head_reflog
);
526 static const char *resolvemsg
=
527 N_("Resolve all conflicts manually, mark them as resolved with\n"
528 "\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
529 "You can instead skip this commit: run \"git rebase --skip\".\n"
530 "To abort and get back to the state before \"git rebase\", run "
531 "\"git rebase --abort\".");
533 static int run_am(struct rebase_options
*opts
)
535 struct child_process am
= CHILD_PROCESS_INIT
;
536 struct child_process format_patch
= CHILD_PROCESS_INIT
;
537 struct strbuf revisions
= STRBUF_INIT
;
539 char *rebased_patches
;
542 argv_array_push(&am
.args
, "am");
544 if (opts
->action
&& !strcmp("continue", opts
->action
)) {
545 argv_array_push(&am
.args
, "--resolved");
546 argv_array_pushf(&am
.args
, "--resolvemsg=%s", resolvemsg
);
547 if (opts
->gpg_sign_opt
)
548 argv_array_push(&am
.args
, opts
->gpg_sign_opt
);
549 status
= run_command(&am
);
553 return move_to_original_branch(opts
);
555 if (opts
->action
&& !strcmp("skip", opts
->action
)) {
556 argv_array_push(&am
.args
, "--skip");
557 argv_array_pushf(&am
.args
, "--resolvemsg=%s", resolvemsg
);
558 status
= run_command(&am
);
562 return move_to_original_branch(opts
);
564 if (opts
->action
&& !strcmp("show-current-patch", opts
->action
)) {
565 argv_array_push(&am
.args
, "--show-current-patch");
566 return run_command(&am
);
569 strbuf_addf(&revisions
, "%s...%s",
570 oid_to_hex(opts
->root
?
571 /* this is now equivalent to !opts->upstream */
572 &opts
->onto
->object
.oid
:
573 &opts
->upstream
->object
.oid
),
574 oid_to_hex(&opts
->orig_head
));
576 rebased_patches
= xstrdup(git_path("rebased-patches"));
577 format_patch
.out
= open(rebased_patches
,
578 O_WRONLY
| O_CREAT
| O_TRUNC
, 0666);
579 if (format_patch
.out
< 0) {
580 status
= error_errno(_("could not open '%s' for writing"),
582 free(rebased_patches
);
583 argv_array_clear(&am
.args
);
587 format_patch
.git_cmd
= 1;
588 argv_array_pushl(&format_patch
.args
, "format-patch", "-k", "--stdout",
589 "--full-index", "--cherry-pick", "--right-only",
590 "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
591 "--no-cover-letter", "--pretty=mboxrd", "--topo-order", NULL
);
592 if (opts
->git_format_patch_opt
.len
)
593 argv_array_split(&format_patch
.args
,
594 opts
->git_format_patch_opt
.buf
);
595 argv_array_push(&format_patch
.args
, revisions
.buf
);
596 if (opts
->restrict_revision
)
597 argv_array_pushf(&format_patch
.args
, "^%s",
598 oid_to_hex(&opts
->restrict_revision
->object
.oid
));
600 status
= run_command(&format_patch
);
602 unlink(rebased_patches
);
603 free(rebased_patches
);
604 argv_array_clear(&am
.args
);
606 reset_head(&opts
->orig_head
, "checkout", opts
->head_name
, 0,
608 error(_("\ngit encountered an error while preparing the "
609 "patches to replay\n"
612 "As a result, git cannot rebase them."),
615 strbuf_release(&revisions
);
618 strbuf_release(&revisions
);
620 am
.in
= open(rebased_patches
, O_RDONLY
);
622 status
= error_errno(_("could not open '%s' for reading"),
624 free(rebased_patches
);
625 argv_array_clear(&am
.args
);
629 argv_array_pushv(&am
.args
, opts
->git_am_opts
.argv
);
630 argv_array_push(&am
.args
, "--rebasing");
631 argv_array_pushf(&am
.args
, "--resolvemsg=%s", resolvemsg
);
632 argv_array_push(&am
.args
, "--patch-format=mboxrd");
633 if (opts
->allow_rerere_autoupdate
> 0)
634 argv_array_push(&am
.args
, "--rerere-autoupdate");
635 else if (opts
->allow_rerere_autoupdate
== 0)
636 argv_array_push(&am
.args
, "--no-rerere-autoupdate");
637 if (opts
->gpg_sign_opt
)
638 argv_array_push(&am
.args
, opts
->gpg_sign_opt
);
639 status
= run_command(&am
);
640 unlink(rebased_patches
);
641 free(rebased_patches
);
644 return move_to_original_branch(opts
);
647 if (is_directory(opts
->state_dir
))
648 write_basic_state(opts
);
653 static int run_specific_rebase(struct rebase_options
*opts
)
655 const char *argv
[] = { NULL
, NULL
};
656 struct strbuf script_snippet
= STRBUF_INIT
, buf
= STRBUF_INIT
;
658 const char *backend
, *backend_func
;
660 if (opts
->type
== REBASE_INTERACTIVE
) {
661 /* Run builtin interactive rebase */
662 struct child_process child
= CHILD_PROCESS_INIT
;
664 argv_array_pushf(&child
.env_array
, "GIT_CHERRY_PICK_HELP=%s",
666 if (!(opts
->flags
& REBASE_INTERACTIVE_EXPLICIT
)) {
667 argv_array_push(&child
.env_array
,
668 "GIT_SEQUENCE_EDITOR=:");
669 opts
->autosquash
= 0;
673 argv_array_push(&child
.args
, "rebase--interactive");
676 argv_array_pushf(&child
.args
, "--%s", opts
->action
);
677 if (opts
->keep_empty
)
678 argv_array_push(&child
.args
, "--keep-empty");
679 if (opts
->rebase_merges
)
680 argv_array_push(&child
.args
, "--rebase-merges");
681 if (opts
->rebase_cousins
)
682 argv_array_push(&child
.args
, "--rebase-cousins");
683 if (opts
->autosquash
)
684 argv_array_push(&child
.args
, "--autosquash");
685 if (opts
->flags
& REBASE_VERBOSE
)
686 argv_array_push(&child
.args
, "--verbose");
687 if (opts
->flags
& REBASE_FORCE
)
688 argv_array_push(&child
.args
, "--no-ff");
689 if (opts
->restrict_revision
)
690 argv_array_pushf(&child
.args
,
691 "--restrict-revision=^%s",
692 oid_to_hex(&opts
->restrict_revision
->object
.oid
));
694 argv_array_pushf(&child
.args
, "--upstream=%s",
695 oid_to_hex(&opts
->upstream
->object
.oid
));
697 argv_array_pushf(&child
.args
, "--onto=%s",
698 oid_to_hex(&opts
->onto
->object
.oid
));
699 if (opts
->squash_onto
)
700 argv_array_pushf(&child
.args
, "--squash-onto=%s",
701 oid_to_hex(opts
->squash_onto
));
703 argv_array_pushf(&child
.args
, "--onto-name=%s",
705 argv_array_pushf(&child
.args
, "--head-name=%s",
707 opts
->head_name
: "detached HEAD");
709 argv_array_pushf(&child
.args
, "--strategy=%s",
711 if (opts
->strategy_opts
)
712 argv_array_pushf(&child
.args
, "--strategy-opts=%s",
713 opts
->strategy_opts
);
715 argv_array_pushf(&child
.args
, "--switch-to=%s",
718 argv_array_pushf(&child
.args
, "--cmd=%s", opts
->cmd
);
719 if (opts
->allow_empty_message
)
720 argv_array_push(&child
.args
, "--allow-empty-message");
721 if (opts
->allow_rerere_autoupdate
> 0)
722 argv_array_push(&child
.args
, "--rerere-autoupdate");
723 else if (opts
->allow_rerere_autoupdate
== 0)
724 argv_array_push(&child
.args
, "--no-rerere-autoupdate");
725 if (opts
->gpg_sign_opt
)
726 argv_array_push(&child
.args
, opts
->gpg_sign_opt
);
728 argv_array_push(&child
.args
, "--signoff");
729 if (opts
->reschedule_failed_exec
)
730 argv_array_push(&child
.args
, "--reschedule-failed-exec");
732 status
= run_command(&child
);
733 goto finished_rebase
;
736 if (opts
->type
== REBASE_AM
) {
737 status
= run_am(opts
);
738 goto finished_rebase
;
741 add_var(&script_snippet
, "GIT_DIR", absolute_path(get_git_dir()));
742 add_var(&script_snippet
, "state_dir", opts
->state_dir
);
744 add_var(&script_snippet
, "upstream_name", opts
->upstream_name
);
745 add_var(&script_snippet
, "upstream", opts
->upstream
?
746 oid_to_hex(&opts
->upstream
->object
.oid
) : NULL
);
747 add_var(&script_snippet
, "head_name",
748 opts
->head_name
? opts
->head_name
: "detached HEAD");
749 add_var(&script_snippet
, "orig_head", oid_to_hex(&opts
->orig_head
));
750 add_var(&script_snippet
, "onto", opts
->onto
?
751 oid_to_hex(&opts
->onto
->object
.oid
) : NULL
);
752 add_var(&script_snippet
, "onto_name", opts
->onto_name
);
753 add_var(&script_snippet
, "revisions", opts
->revisions
);
754 add_var(&script_snippet
, "restrict_revision", opts
->restrict_revision
?
755 oid_to_hex(&opts
->restrict_revision
->object
.oid
) : NULL
);
756 add_var(&script_snippet
, "GIT_QUIET",
757 opts
->flags
& REBASE_NO_QUIET
? "" : "t");
758 sq_quote_argv_pretty(&buf
, opts
->git_am_opts
.argv
);
759 add_var(&script_snippet
, "git_am_opt", buf
.buf
);
760 strbuf_release(&buf
);
761 add_var(&script_snippet
, "verbose",
762 opts
->flags
& REBASE_VERBOSE
? "t" : "");
763 add_var(&script_snippet
, "diffstat",
764 opts
->flags
& REBASE_DIFFSTAT
? "t" : "");
765 add_var(&script_snippet
, "force_rebase",
766 opts
->flags
& REBASE_FORCE
? "t" : "");
768 add_var(&script_snippet
, "switch_to", opts
->switch_to
);
769 add_var(&script_snippet
, "action", opts
->action
? opts
->action
: "");
770 add_var(&script_snippet
, "signoff", opts
->signoff
? "--signoff" : "");
771 add_var(&script_snippet
, "allow_rerere_autoupdate",
772 opts
->allow_rerere_autoupdate
< 0 ? "" :
773 opts
->allow_rerere_autoupdate
?
774 "--rerere-autoupdate" : "--no-rerere-autoupdate");
775 add_var(&script_snippet
, "keep_empty", opts
->keep_empty
? "yes" : "");
776 add_var(&script_snippet
, "autosquash", opts
->autosquash
? "t" : "");
777 add_var(&script_snippet
, "gpg_sign_opt", opts
->gpg_sign_opt
);
778 add_var(&script_snippet
, "cmd", opts
->cmd
);
779 add_var(&script_snippet
, "allow_empty_message",
780 opts
->allow_empty_message
? "--allow-empty-message" : "");
781 add_var(&script_snippet
, "rebase_merges",
782 opts
->rebase_merges
? "t" : "");
783 add_var(&script_snippet
, "rebase_cousins",
784 opts
->rebase_cousins
? "t" : "");
785 add_var(&script_snippet
, "strategy", opts
->strategy
);
786 add_var(&script_snippet
, "strategy_opts", opts
->strategy_opts
);
787 add_var(&script_snippet
, "rebase_root", opts
->root
? "t" : "");
788 add_var(&script_snippet
, "squash_onto",
789 opts
->squash_onto
? oid_to_hex(opts
->squash_onto
) : "");
790 add_var(&script_snippet
, "git_format_patch_opt",
791 opts
->git_format_patch_opt
.buf
);
793 if (is_interactive(opts
) &&
794 !(opts
->flags
& REBASE_INTERACTIVE_EXPLICIT
)) {
795 strbuf_addstr(&script_snippet
,
796 "GIT_SEQUENCE_EDITOR=:; export GIT_SEQUENCE_EDITOR; ");
797 opts
->autosquash
= 0;
800 switch (opts
->type
) {
802 backend
= "git-rebase--am";
803 backend_func
= "git_rebase__am";
805 case REBASE_PRESERVE_MERGES
:
806 backend
= "git-rebase--preserve-merges";
807 backend_func
= "git_rebase__preserve_merges";
810 BUG("Unhandled rebase type %d", opts
->type
);
814 strbuf_addf(&script_snippet
,
815 ". git-sh-setup && . git-rebase--common &&"
816 " . %s && %s", backend
, backend_func
);
817 argv
[0] = script_snippet
.buf
;
819 status
= run_command_v_opt(argv
, RUN_USING_SHELL
);
821 if (opts
->dont_finish_rebase
)
823 else if (opts
->type
== REBASE_INTERACTIVE
)
824 ; /* interactive rebase cleans up after itself */
825 else if (status
== 0) {
826 if (!file_exists(state_dir_path("stopped-sha", opts
)))
828 } else if (status
== 2) {
829 struct strbuf dir
= STRBUF_INIT
;
831 apply_autostash(opts
);
832 strbuf_addstr(&dir
, opts
->state_dir
);
833 remove_dir_recursively(&dir
, 0);
834 strbuf_release(&dir
);
835 die("Nothing to do");
838 strbuf_release(&script_snippet
);
840 return status
? -1 : 0;
843 static int rebase_config(const char *var
, const char *value
, void *data
)
845 struct rebase_options
*opts
= data
;
847 if (!strcmp(var
, "rebase.stat")) {
848 if (git_config_bool(var
, value
))
849 opts
->flags
|= REBASE_DIFFSTAT
;
851 opts
->flags
&= !REBASE_DIFFSTAT
;
855 if (!strcmp(var
, "rebase.autosquash")) {
856 opts
->autosquash
= git_config_bool(var
, value
);
860 if (!strcmp(var
, "commit.gpgsign")) {
861 free(opts
->gpg_sign_opt
);
862 opts
->gpg_sign_opt
= git_config_bool(var
, value
) ?
863 xstrdup("-S") : NULL
;
867 if (!strcmp(var
, "rebase.autostash")) {
868 opts
->autostash
= git_config_bool(var
, value
);
872 if (!strcmp(var
, "rebase.reschedulefailedexec")) {
873 opts
->reschedule_failed_exec
= git_config_bool(var
, value
);
877 return git_default_config(var
, value
, data
);
881 * Determines whether the commits in from..to are linear, i.e. contain
882 * no merge commits. This function *expects* `from` to be an ancestor of
885 static int is_linear_history(struct commit
*from
, struct commit
*to
)
887 while (to
&& to
!= from
) {
891 if (to
->parents
->next
)
893 to
= to
->parents
->item
;
898 static int can_fast_forward(struct commit
*onto
, struct object_id
*head_oid
,
899 struct object_id
*merge_base
)
901 struct commit
*head
= lookup_commit(the_repository
, head_oid
);
902 struct commit_list
*merge_bases
;
908 merge_bases
= get_merge_bases(onto
, head
);
909 if (merge_bases
&& !merge_bases
->next
) {
910 oidcpy(merge_base
, &merge_bases
->item
->object
.oid
);
911 res
= oideq(merge_base
, &onto
->object
.oid
);
913 oidcpy(merge_base
, &null_oid
);
916 free_commit_list(merge_bases
);
917 return res
&& is_linear_history(onto
, head
);
920 /* -i followed by -m is still -i */
921 static int parse_opt_merge(const struct option
*opt
, const char *arg
, int unset
)
923 struct rebase_options
*opts
= opt
->value
;
925 BUG_ON_OPT_NEG(unset
);
928 if (!is_interactive(opts
))
929 opts
->type
= REBASE_MERGE
;
934 /* -i followed by -p is still explicitly interactive, but -p alone is not */
935 static int parse_opt_interactive(const struct option
*opt
, const char *arg
,
938 struct rebase_options
*opts
= opt
->value
;
940 BUG_ON_OPT_NEG(unset
);
943 opts
->type
= REBASE_INTERACTIVE
;
944 opts
->flags
|= REBASE_INTERACTIVE_EXPLICIT
;
949 static void NORETURN
error_on_missing_default_upstream(void)
951 struct branch
*current_branch
= branch_get(NULL
);
954 "Please specify which branch you want to rebase against.\n"
955 "See git-rebase(1) for details.\n"
957 " git rebase '<branch>'\n"
959 current_branch
? _("There is no tracking information for "
960 "the current branch.") :
961 _("You are not currently on a branch."));
963 if (current_branch
) {
964 const char *remote
= current_branch
->remote_name
;
967 remote
= _("<remote>");
969 printf(_("If you wish to set tracking information for this "
970 "branch you can do so with:\n"
972 " git branch --set-upstream-to=%s/<branch> %s\n"
974 remote
, current_branch
->name
);
979 static void set_reflog_action(struct rebase_options
*options
)
982 struct strbuf buf
= STRBUF_INIT
;
984 if (!is_interactive(options
))
987 env
= getenv(GIT_REFLOG_ACTION_ENVIRONMENT
);
988 if (env
&& strcmp("rebase", env
))
989 return; /* only override it if it is "rebase" */
991 strbuf_addf(&buf
, "rebase -i (%s)", options
->action
);
992 setenv(GIT_REFLOG_ACTION_ENVIRONMENT
, buf
.buf
, 1);
993 strbuf_release(&buf
);
996 static int check_exec_cmd(const char *cmd
)
998 if (strchr(cmd
, '\n'))
999 return error(_("exec commands cannot contain newlines"));
1001 /* Does the command consist purely of whitespace? */
1002 if (!cmd
[strspn(cmd
, " \t\r\f\v")])
1003 return error(_("empty exec command"));
1009 int cmd_rebase(int argc
, const char **argv
, const char *prefix
)
1011 struct rebase_options options
= {
1012 .type
= REBASE_UNSPECIFIED
,
1013 .flags
= REBASE_NO_QUIET
,
1014 .git_am_opts
= ARGV_ARRAY_INIT
,
1015 .allow_rerere_autoupdate
= -1,
1016 .allow_empty_message
= 1,
1017 .git_format_patch_opt
= STRBUF_INIT
,
1019 const char *branch_name
;
1020 int ret
, flags
, total_argc
, in_progress
= 0;
1021 int ok_to_skip_pre_rebase
= 0;
1022 struct strbuf msg
= STRBUF_INIT
;
1023 struct strbuf revisions
= STRBUF_INIT
;
1024 struct strbuf buf
= STRBUF_INIT
;
1025 struct object_id merge_base
;
1033 ACTION_SHOW_CURRENT_PATCH
,
1034 } action
= NO_ACTION
;
1035 static const char *action_names
[] = { N_("undefined"),
1041 N_("show_current_patch"),
1043 const char *gpg_sign
= NULL
;
1044 struct string_list exec
= STRING_LIST_INIT_NODUP
;
1045 const char *rebase_merges
= NULL
;
1046 int fork_point
= -1;
1047 struct string_list strategy_options
= STRING_LIST_INIT_NODUP
;
1048 struct object_id squash_onto
;
1049 char *squash_onto_name
= NULL
;
1050 struct option builtin_rebase_options
[] = {
1051 OPT_STRING(0, "onto", &options
.onto_name
,
1053 N_("rebase onto given branch instead of upstream")),
1054 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase
,
1055 N_("allow pre-rebase hook to run")),
1056 OPT_NEGBIT('q', "quiet", &options
.flags
,
1057 N_("be quiet. implies --no-stat"),
1058 REBASE_NO_QUIET
| REBASE_VERBOSE
| REBASE_DIFFSTAT
),
1059 OPT_BIT('v', "verbose", &options
.flags
,
1060 N_("display a diffstat of what changed upstream"),
1061 REBASE_NO_QUIET
| REBASE_VERBOSE
| REBASE_DIFFSTAT
),
1062 {OPTION_NEGBIT
, 'n', "no-stat", &options
.flags
, NULL
,
1063 N_("do not show diffstat of what changed upstream"),
1064 PARSE_OPT_NOARG
, NULL
, REBASE_DIFFSTAT
},
1065 OPT_BOOL(0, "signoff", &options
.signoff
,
1066 N_("add a Signed-off-by: line to each commit")),
1067 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options
.git_am_opts
,
1068 NULL
, N_("passed to 'git am'"),
1070 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
1071 &options
.git_am_opts
, NULL
,
1072 N_("passed to 'git am'"), PARSE_OPT_NOARG
),
1073 OPT_PASSTHRU_ARGV(0, "ignore-date", &options
.git_am_opts
, NULL
,
1074 N_("passed to 'git am'"), PARSE_OPT_NOARG
),
1075 OPT_PASSTHRU_ARGV('C', NULL
, &options
.git_am_opts
, N_("n"),
1076 N_("passed to 'git apply'"), 0),
1077 OPT_PASSTHRU_ARGV(0, "whitespace", &options
.git_am_opts
,
1078 N_("action"), N_("passed to 'git apply'"), 0),
1079 OPT_BIT('f', "force-rebase", &options
.flags
,
1080 N_("cherry-pick all commits, even if unchanged"),
1082 OPT_BIT(0, "no-ff", &options
.flags
,
1083 N_("cherry-pick all commits, even if unchanged"),
1085 OPT_CMDMODE(0, "continue", &action
, N_("continue"),
1087 OPT_CMDMODE(0, "skip", &action
,
1088 N_("skip current patch and continue"), ACTION_SKIP
),
1089 OPT_CMDMODE(0, "abort", &action
,
1090 N_("abort and check out the original branch"),
1092 OPT_CMDMODE(0, "quit", &action
,
1093 N_("abort but keep HEAD where it is"), ACTION_QUIT
),
1094 OPT_CMDMODE(0, "edit-todo", &action
, N_("edit the todo list "
1095 "during an interactive rebase"), ACTION_EDIT_TODO
),
1096 OPT_CMDMODE(0, "show-current-patch", &action
,
1097 N_("show the patch file being applied or merged"),
1098 ACTION_SHOW_CURRENT_PATCH
),
1099 { OPTION_CALLBACK
, 'm', "merge", &options
, NULL
,
1100 N_("use merging strategies to rebase"),
1101 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
,
1103 { OPTION_CALLBACK
, 'i', "interactive", &options
, NULL
,
1104 N_("let the user edit the list of commits to rebase"),
1105 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
,
1106 parse_opt_interactive
},
1107 OPT_SET_INT('p', "preserve-merges", &options
.type
,
1108 N_("try to recreate merges instead of ignoring "
1109 "them"), REBASE_PRESERVE_MERGES
),
1110 OPT_BOOL(0, "rerere-autoupdate",
1111 &options
.allow_rerere_autoupdate
,
1112 N_("allow rerere to update index with resolved "
1114 OPT_BOOL('k', "keep-empty", &options
.keep_empty
,
1115 N_("preserve empty commits during rebase")),
1116 OPT_BOOL(0, "autosquash", &options
.autosquash
,
1117 N_("move commits that begin with "
1118 "squash!/fixup! under -i")),
1119 { OPTION_STRING
, 'S', "gpg-sign", &gpg_sign
, N_("key-id"),
1120 N_("GPG-sign commits"),
1121 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
1122 OPT_BOOL(0, "autostash", &options
.autostash
,
1123 N_("automatically stash/stash pop before and after")),
1124 OPT_STRING_LIST('x', "exec", &exec
, N_("exec"),
1125 N_("add exec lines after each commit of the "
1127 OPT_BOOL(0, "allow-empty-message",
1128 &options
.allow_empty_message
,
1129 N_("allow rebasing commits with empty messages")),
1130 {OPTION_STRING
, 'r', "rebase-merges", &rebase_merges
,
1132 N_("try to rebase merges instead of skipping them"),
1133 PARSE_OPT_OPTARG
, NULL
, (intptr_t)""},
1134 OPT_BOOL(0, "fork-point", &fork_point
,
1135 N_("use 'merge-base --fork-point' to refine upstream")),
1136 OPT_STRING('s', "strategy", &options
.strategy
,
1137 N_("strategy"), N_("use the given merge strategy")),
1138 OPT_STRING_LIST('X', "strategy-option", &strategy_options
,
1140 N_("pass the argument through to the merge "
1142 OPT_BOOL(0, "root", &options
.root
,
1143 N_("rebase all reachable commits up to the root(s)")),
1144 OPT_BOOL(0, "reschedule-failed-exec",
1145 &options
.reschedule_failed_exec
,
1146 N_("automatically re-schedule any `exec` that fails")),
1152 * NEEDSWORK: Once the builtin rebase has been tested enough
1153 * and git-legacy-rebase.sh is retired to contrib/, this preamble
1157 if (!use_builtin_rebase()) {
1158 const char *path
= mkpath("%s/git-legacy-rebase",
1161 if (sane_execvp(path
, (char **)argv
) < 0)
1162 die_errno(_("could not exec %s"), path
);
1164 BUG("sane_execvp() returned???");
1167 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1168 usage_with_options(builtin_rebase_usage
,
1169 builtin_rebase_options
);
1171 prefix
= setup_git_directory();
1172 trace_repo_setup(prefix
);
1175 git_config(rebase_config
, &options
);
1178 strbuf_addf(&buf
, "%s/applying", apply_dir());
1179 if(file_exists(buf
.buf
))
1180 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1182 if (is_directory(apply_dir())) {
1183 options
.type
= REBASE_AM
;
1184 options
.state_dir
= apply_dir();
1185 } else if (is_directory(merge_dir())) {
1187 strbuf_addf(&buf
, "%s/rewritten", merge_dir());
1188 if (is_directory(buf
.buf
)) {
1189 options
.type
= REBASE_PRESERVE_MERGES
;
1190 options
.flags
|= REBASE_INTERACTIVE_EXPLICIT
;
1193 strbuf_addf(&buf
, "%s/interactive", merge_dir());
1194 if(file_exists(buf
.buf
)) {
1195 options
.type
= REBASE_INTERACTIVE
;
1196 options
.flags
|= REBASE_INTERACTIVE_EXPLICIT
;
1198 options
.type
= REBASE_MERGE
;
1200 options
.state_dir
= merge_dir();
1203 if (options
.type
!= REBASE_UNSPECIFIED
)
1207 argc
= parse_options(argc
, argv
, prefix
,
1208 builtin_rebase_options
,
1209 builtin_rebase_usage
, 0);
1211 if (action
!= NO_ACTION
&& total_argc
!= 2) {
1212 usage_with_options(builtin_rebase_usage
,
1213 builtin_rebase_options
);
1217 usage_with_options(builtin_rebase_usage
,
1218 builtin_rebase_options
);
1220 if (action
!= NO_ACTION
&& !in_progress
)
1221 die(_("No rebase in progress?"));
1222 setenv(GIT_REFLOG_ACTION_ENVIRONMENT
, "rebase", 0);
1224 if (action
== ACTION_EDIT_TODO
&& !is_interactive(&options
))
1225 die(_("The --edit-todo action can only be used during "
1226 "interactive rebase."));
1228 if (trace2_is_enabled()) {
1229 if (is_interactive(&options
))
1230 trace2_cmd_mode("interactive");
1232 trace2_cmd_mode("interactive-exec");
1234 trace2_cmd_mode(action_names
[action
]);
1238 case ACTION_CONTINUE
: {
1239 struct object_id head
;
1240 struct lock_file lock_file
= LOCK_INIT
;
1243 options
.action
= "continue";
1244 set_reflog_action(&options
);
1247 if (get_oid("HEAD", &head
))
1248 die(_("Cannot read HEAD"));
1250 fd
= hold_locked_index(&lock_file
, 0);
1251 if (repo_read_index(the_repository
) < 0)
1252 die(_("could not read index"));
1253 refresh_index(the_repository
->index
, REFRESH_QUIET
, NULL
, NULL
,
1256 repo_update_index_if_able(the_repository
, &lock_file
);
1257 rollback_lock_file(&lock_file
);
1259 if (has_unstaged_changes(the_repository
, 1)) {
1260 puts(_("You must edit all merge conflicts and then\n"
1261 "mark them as resolved using git add"));
1264 if (read_basic_state(&options
))
1269 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
1271 options
.action
= "skip";
1272 set_reflog_action(&options
);
1274 rerere_clear(the_repository
, &merge_rr
);
1275 string_list_clear(&merge_rr
, 1);
1277 if (reset_head(NULL
, "reset", NULL
, RESET_HEAD_HARD
,
1279 die(_("could not discard worktree changes"));
1280 remove_branch_state(the_repository
);
1281 if (read_basic_state(&options
))
1285 case ACTION_ABORT
: {
1286 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
1287 options
.action
= "abort";
1288 set_reflog_action(&options
);
1290 rerere_clear(the_repository
, &merge_rr
);
1291 string_list_clear(&merge_rr
, 1);
1293 if (read_basic_state(&options
))
1295 if (reset_head(&options
.orig_head
, "reset",
1296 options
.head_name
, RESET_HEAD_HARD
,
1298 die(_("could not move back to %s"),
1299 oid_to_hex(&options
.orig_head
));
1300 remove_branch_state(the_repository
);
1301 ret
= finish_rebase(&options
);
1306 strbuf_addstr(&buf
, options
.state_dir
);
1307 ret
= !!remove_dir_recursively(&buf
, 0);
1309 die(_("could not remove '%s'"), options
.state_dir
);
1312 case ACTION_EDIT_TODO
:
1313 options
.action
= "edit-todo";
1314 options
.dont_finish_rebase
= 1;
1316 case ACTION_SHOW_CURRENT_PATCH
:
1317 options
.action
= "show-current-patch";
1318 options
.dont_finish_rebase
= 1;
1323 BUG("action: %d", action
);
1326 /* Make sure no rebase is in progress */
1328 const char *last_slash
= strrchr(options
.state_dir
, '/');
1329 const char *state_dir_base
=
1330 last_slash
? last_slash
+ 1 : options
.state_dir
;
1331 const char *cmd_live_rebase
=
1332 "git rebase (--continue | --abort | --skip)";
1334 strbuf_addf(&buf
, "rm -fr \"%s\"", options
.state_dir
);
1335 die(_("It seems that there is already a %s directory, and\n"
1336 "I wonder if you are in the middle of another rebase. "
1338 "case, please try\n\t%s\n"
1339 "If that is not the case, please\n\t%s\n"
1340 "and run me again. I am stopping in case you still "
1342 "valuable there.\n"),
1343 state_dir_base
, cmd_live_rebase
, buf
.buf
);
1346 for (i
= 0; i
< options
.git_am_opts
.argc
; i
++) {
1347 const char *option
= options
.git_am_opts
.argv
[i
], *p
;
1348 if (!strcmp(option
, "--committer-date-is-author-date") ||
1349 !strcmp(option
, "--ignore-date") ||
1350 !strcmp(option
, "--whitespace=fix") ||
1351 !strcmp(option
, "--whitespace=strip"))
1352 options
.flags
|= REBASE_FORCE
;
1353 else if (skip_prefix(option
, "-C", &p
)) {
1355 if (!isdigit(*(p
++)))
1356 die(_("switch `C' expects a "
1357 "numerical value"));
1358 } else if (skip_prefix(option
, "--whitespace=", &p
)) {
1359 if (*p
&& strcmp(p
, "warn") && strcmp(p
, "nowarn") &&
1360 strcmp(p
, "error") && strcmp(p
, "error-all"))
1361 die("Invalid whitespace option: '%s'", p
);
1365 for (i
= 0; i
< exec
.nr
; i
++)
1366 if (check_exec_cmd(exec
.items
[i
].string
))
1369 if (!(options
.flags
& REBASE_NO_QUIET
))
1370 argv_array_push(&options
.git_am_opts
, "-q");
1372 if (options
.keep_empty
)
1373 imply_interactive(&options
, "--keep-empty");
1376 free(options
.gpg_sign_opt
);
1377 options
.gpg_sign_opt
= xstrfmt("-S%s", gpg_sign
);
1383 imply_interactive(&options
, "--exec");
1386 for (i
= 0; i
< exec
.nr
; i
++)
1387 strbuf_addf(&buf
, "exec %s\n", exec
.items
[i
].string
);
1388 options
.cmd
= xstrdup(buf
.buf
);
1391 if (rebase_merges
) {
1392 if (!*rebase_merges
)
1393 ; /* default mode; do nothing */
1394 else if (!strcmp("rebase-cousins", rebase_merges
))
1395 options
.rebase_cousins
= 1;
1396 else if (strcmp("no-rebase-cousins", rebase_merges
))
1397 die(_("Unknown mode: %s"), rebase_merges
);
1398 options
.rebase_merges
= 1;
1399 imply_interactive(&options
, "--rebase-merges");
1402 if (strategy_options
.nr
) {
1405 if (!options
.strategy
)
1406 options
.strategy
= "recursive";
1409 for (i
= 0; i
< strategy_options
.nr
; i
++)
1410 strbuf_addf(&buf
, " --%s",
1411 strategy_options
.items
[i
].string
);
1412 options
.strategy_opts
= xstrdup(buf
.buf
);
1415 if (options
.strategy
) {
1416 options
.strategy
= xstrdup(options
.strategy
);
1417 switch (options
.type
) {
1419 die(_("--strategy requires --merge or --interactive"));
1421 case REBASE_INTERACTIVE
:
1422 case REBASE_PRESERVE_MERGES
:
1425 case REBASE_UNSPECIFIED
:
1426 options
.type
= REBASE_MERGE
;
1429 BUG("unhandled rebase type (%d)", options
.type
);
1433 if (options
.type
== REBASE_MERGE
)
1434 imply_interactive(&options
, "--merge");
1436 if (options
.root
&& !options
.onto_name
)
1437 imply_interactive(&options
, "--root without --onto");
1439 if (isatty(2) && options
.flags
& REBASE_NO_QUIET
)
1440 strbuf_addstr(&options
.git_format_patch_opt
, " --progress");
1442 switch (options
.type
) {
1444 case REBASE_INTERACTIVE
:
1445 case REBASE_PRESERVE_MERGES
:
1446 options
.state_dir
= merge_dir();
1449 options
.state_dir
= apply_dir();
1452 /* the default rebase backend is `--am` */
1453 options
.type
= REBASE_AM
;
1454 options
.state_dir
= apply_dir();
1458 if (options
.reschedule_failed_exec
&& !is_interactive(&options
))
1459 die(_("%s requires an interactive rebase"), "--reschedule-failed-exec");
1461 if (options
.git_am_opts
.argc
) {
1462 /* all am options except -q are compatible only with --am */
1463 for (i
= options
.git_am_opts
.argc
- 1; i
>= 0; i
--)
1464 if (strcmp(options
.git_am_opts
.argv
[i
], "-q"))
1467 if (is_interactive(&options
) && i
>= 0)
1468 die(_("cannot combine am options with either "
1469 "interactive or merge options"));
1472 if (options
.signoff
) {
1473 if (options
.type
== REBASE_PRESERVE_MERGES
)
1474 die("cannot combine '--signoff' with "
1475 "'--preserve-merges'");
1476 argv_array_push(&options
.git_am_opts
, "--signoff");
1477 options
.flags
|= REBASE_FORCE
;
1480 if (options
.type
== REBASE_PRESERVE_MERGES
) {
1482 * Note: incompatibility with --signoff handled in signoff block above
1483 * Note: incompatibility with --interactive is just a strong warning;
1484 * git-rebase.txt caveats with "unless you know what you are doing"
1486 if (options
.rebase_merges
)
1487 die(_("cannot combine '--preserve-merges' with "
1488 "'--rebase-merges'"));
1490 if (options
.reschedule_failed_exec
)
1491 die(_("error: cannot combine '--preserve-merges' with "
1492 "'--reschedule-failed-exec'"));
1495 if (options
.rebase_merges
) {
1496 if (strategy_options
.nr
)
1497 die(_("cannot combine '--rebase-merges' with "
1498 "'--strategy-option'"));
1499 if (options
.strategy
)
1500 die(_("cannot combine '--rebase-merges' with "
1504 if (!options
.root
) {
1506 struct branch
*branch
;
1508 branch
= branch_get(NULL
);
1509 options
.upstream_name
= branch_get_upstream(branch
,
1511 if (!options
.upstream_name
)
1512 error_on_missing_default_upstream();
1516 options
.upstream_name
= argv
[0];
1519 if (!strcmp(options
.upstream_name
, "-"))
1520 options
.upstream_name
= "@{-1}";
1522 options
.upstream
= peel_committish(options
.upstream_name
);
1523 if (!options
.upstream
)
1524 die(_("invalid upstream '%s'"), options
.upstream_name
);
1525 options
.upstream_arg
= options
.upstream_name
;
1527 if (!options
.onto_name
) {
1528 if (commit_tree("", 0, the_hash_algo
->empty_tree
, NULL
,
1529 &squash_onto
, NULL
, NULL
) < 0)
1530 die(_("Could not create new root commit"));
1531 options
.squash_onto
= &squash_onto
;
1532 options
.onto_name
= squash_onto_name
=
1533 xstrdup(oid_to_hex(&squash_onto
));
1535 options
.upstream_name
= NULL
;
1536 options
.upstream
= NULL
;
1538 usage_with_options(builtin_rebase_usage
,
1539 builtin_rebase_options
);
1540 options
.upstream_arg
= "--root";
1543 /* Make sure the branch to rebase onto is valid. */
1544 if (!options
.onto_name
)
1545 options
.onto_name
= options
.upstream_name
;
1546 if (strstr(options
.onto_name
, "...")) {
1547 if (get_oid_mb(options
.onto_name
, &merge_base
) < 0)
1548 die(_("'%s': need exactly one merge base"),
1550 options
.onto
= lookup_commit_or_die(&merge_base
,
1553 options
.onto
= peel_committish(options
.onto_name
);
1555 die(_("Does not point to a valid commit '%s'"),
1560 * If the branch to rebase is given, that is the branch we will rebase
1561 * branch_name -- branch/commit being rebased, or
1562 * HEAD (already detached)
1563 * orig_head -- commit object name of tip of the branch before rebasing
1564 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1567 /* Is it "rebase other branchname" or "rebase other commit"? */
1568 branch_name
= argv
[0];
1569 options
.switch_to
= argv
[0];
1571 /* Is it a local branch? */
1573 strbuf_addf(&buf
, "refs/heads/%s", branch_name
);
1574 if (!read_ref(buf
.buf
, &options
.orig_head
))
1575 options
.head_name
= xstrdup(buf
.buf
);
1576 /* If not is it a valid ref (branch or commit)? */
1577 else if (!get_oid(branch_name
, &options
.orig_head
))
1578 options
.head_name
= NULL
;
1580 die(_("fatal: no such branch/commit '%s'"),
1582 } else if (argc
== 0) {
1583 /* Do not need to switch branches, we are already on it. */
1585 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL
,
1587 if (!options
.head_name
)
1588 die(_("No such ref: %s"), "HEAD");
1589 if (flags
& REF_ISSYMREF
) {
1590 if (!skip_prefix(options
.head_name
,
1591 "refs/heads/", &branch_name
))
1592 branch_name
= options
.head_name
;
1595 FREE_AND_NULL(options
.head_name
);
1596 branch_name
= "HEAD";
1598 if (get_oid("HEAD", &options
.orig_head
))
1599 die(_("Could not resolve HEAD to a revision"));
1601 BUG("unexpected number of arguments left to parse");
1603 if (fork_point
> 0) {
1604 struct commit
*head
=
1605 lookup_commit_reference(the_repository
,
1606 &options
.orig_head
);
1607 options
.restrict_revision
=
1608 get_fork_point(options
.upstream_name
, head
);
1611 if (repo_read_index(the_repository
) < 0)
1612 die(_("could not read index"));
1614 if (options
.autostash
) {
1615 struct lock_file lock_file
= LOCK_INIT
;
1618 fd
= hold_locked_index(&lock_file
, 0);
1619 refresh_cache(REFRESH_QUIET
);
1621 repo_update_index_if_able(the_repository
, &lock_file
);
1622 rollback_lock_file(&lock_file
);
1624 if (has_unstaged_changes(the_repository
, 1) ||
1625 has_uncommitted_changes(the_repository
, 1)) {
1626 const char *autostash
=
1627 state_dir_path("autostash", &options
);
1628 struct child_process stash
= CHILD_PROCESS_INIT
;
1629 struct object_id oid
;
1630 struct commit
*head
=
1631 lookup_commit_reference(the_repository
,
1632 &options
.orig_head
);
1634 argv_array_pushl(&stash
.args
,
1635 "stash", "create", "autostash", NULL
);
1639 if (capture_command(&stash
, &buf
, GIT_MAX_HEXSZ
))
1640 die(_("Cannot autostash"));
1641 strbuf_trim_trailing_newline(&buf
);
1642 if (get_oid(buf
.buf
, &oid
))
1643 die(_("Unexpected stash response: '%s'"),
1646 strbuf_add_unique_abbrev(&buf
, &oid
, DEFAULT_ABBREV
);
1648 if (safe_create_leading_directories_const(autostash
))
1649 die(_("Could not create directory for '%s'"),
1651 write_file(autostash
, "%s", oid_to_hex(&oid
));
1652 printf(_("Created autostash: %s\n"), buf
.buf
);
1653 if (reset_head(&head
->object
.oid
, "reset --hard",
1654 NULL
, RESET_HEAD_HARD
, NULL
, NULL
) < 0)
1655 die(_("could not reset --hard"));
1656 printf(_("HEAD is now at %s"),
1657 find_unique_abbrev(&head
->object
.oid
,
1660 pp_commit_easy(CMIT_FMT_ONELINE
, head
, &buf
);
1662 printf(" %s", buf
.buf
);
1665 if (discard_index(the_repository
->index
) < 0 ||
1666 repo_read_index(the_repository
) < 0)
1667 die(_("could not read index"));
1671 if (require_clean_work_tree(the_repository
, "rebase",
1672 _("Please commit or stash them."), 1, 1)) {
1678 * Now we are rebasing commits upstream..orig_head (or with --root,
1679 * everything leading up to orig_head) on top of onto.
1683 * Check if we are already based on onto with linear history,
1684 * but this should be done only when upstream and onto are the same
1685 * and if this is not an interactive rebase.
1687 if (can_fast_forward(options
.onto
, &options
.orig_head
, &merge_base
) &&
1688 !is_interactive(&options
) && !options
.restrict_revision
&&
1690 !oidcmp(&options
.upstream
->object
.oid
, &options
.onto
->object
.oid
)) {
1693 if (!(options
.flags
& REBASE_FORCE
)) {
1694 /* Lazily switch to the target branch if needed... */
1695 if (options
.switch_to
) {
1696 struct object_id oid
;
1698 if (get_oid(options
.switch_to
, &oid
) < 0) {
1699 ret
= !!error(_("could not parse '%s'"),
1705 strbuf_addf(&buf
, "%s: checkout %s",
1706 getenv(GIT_REFLOG_ACTION_ENVIRONMENT
),
1708 if (reset_head(&oid
, "checkout",
1710 RESET_HEAD_RUN_POST_CHECKOUT_HOOK
,
1711 NULL
, buf
.buf
) < 0) {
1712 ret
= !!error(_("could not switch to "
1719 if (!(options
.flags
& REBASE_NO_QUIET
))
1721 else if (!strcmp(branch_name
, "HEAD") &&
1722 resolve_ref_unsafe("HEAD", 0, NULL
, &flag
))
1723 puts(_("HEAD is up to date."));
1725 printf(_("Current branch %s is up to date.\n"),
1727 ret
= !!finish_rebase(&options
);
1729 } else if (!(options
.flags
& REBASE_NO_QUIET
))
1731 else if (!strcmp(branch_name
, "HEAD") &&
1732 resolve_ref_unsafe("HEAD", 0, NULL
, &flag
))
1733 puts(_("HEAD is up to date, rebase forced."));
1735 printf(_("Current branch %s is up to date, rebase "
1736 "forced.\n"), branch_name
);
1739 /* If a hook exists, give it a chance to interrupt*/
1740 if (!ok_to_skip_pre_rebase
&&
1741 run_hook_le(NULL
, "pre-rebase", options
.upstream_arg
,
1742 argc
? argv
[0] : NULL
, NULL
))
1743 die(_("The pre-rebase hook refused to rebase."));
1745 if (options
.flags
& REBASE_DIFFSTAT
) {
1746 struct diff_options opts
;
1748 if (options
.flags
& REBASE_VERBOSE
) {
1749 if (is_null_oid(&merge_base
))
1750 printf(_("Changes to %s:\n"),
1751 oid_to_hex(&options
.onto
->object
.oid
));
1753 printf(_("Changes from %s to %s:\n"),
1754 oid_to_hex(&merge_base
),
1755 oid_to_hex(&options
.onto
->object
.oid
));
1758 /* We want color (if set), but no pager */
1760 opts
.stat_width
= -1; /* use full terminal width */
1761 opts
.stat_graph_width
= -1; /* respect statGraphWidth config */
1762 opts
.output_format
|=
1763 DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1764 opts
.detect_rename
= DIFF_DETECT_RENAME
;
1765 diff_setup_done(&opts
);
1766 diff_tree_oid(is_null_oid(&merge_base
) ?
1767 the_hash_algo
->empty_tree
: &merge_base
,
1768 &options
.onto
->object
.oid
, "", &opts
);
1769 diffcore_std(&opts
);
1773 if (is_interactive(&options
))
1776 /* Detach HEAD and reset the tree */
1777 if (options
.flags
& REBASE_NO_QUIET
)
1778 printf(_("First, rewinding head to replay your work on top of "
1781 strbuf_addf(&msg
, "%s: checkout %s",
1782 getenv(GIT_REFLOG_ACTION_ENVIRONMENT
), options
.onto_name
);
1783 if (reset_head(&options
.onto
->object
.oid
, "checkout", NULL
,
1784 RESET_HEAD_DETACH
| RESET_ORIG_HEAD
|
1785 RESET_HEAD_RUN_POST_CHECKOUT_HOOK
,
1787 die(_("Could not detach HEAD"));
1788 strbuf_release(&msg
);
1791 * If the onto is a proper descendant of the tip of the branch, then
1792 * we just fast-forwarded.
1795 if (oideq(&merge_base
, &options
.orig_head
)) {
1796 printf(_("Fast-forwarded %s to %s.\n"),
1797 branch_name
, options
.onto_name
);
1798 strbuf_addf(&msg
, "rebase finished: %s onto %s",
1799 options
.head_name
? options
.head_name
: "detached HEAD",
1800 oid_to_hex(&options
.onto
->object
.oid
));
1801 reset_head(NULL
, "Fast-forwarded", options
.head_name
,
1802 RESET_HEAD_REFS_ONLY
, "HEAD", msg
.buf
);
1803 strbuf_release(&msg
);
1804 ret
= !!finish_rebase(&options
);
1808 strbuf_addf(&revisions
, "%s..%s",
1809 options
.root
? oid_to_hex(&options
.onto
->object
.oid
) :
1810 (options
.restrict_revision
?
1811 oid_to_hex(&options
.restrict_revision
->object
.oid
) :
1812 oid_to_hex(&options
.upstream
->object
.oid
)),
1813 oid_to_hex(&options
.orig_head
));
1815 options
.revisions
= revisions
.buf
;
1818 ret
= !!run_specific_rebase(&options
);
1821 strbuf_release(&revisions
);
1822 free(options
.head_name
);
1823 free(options
.gpg_sign_opt
);
1825 free(squash_onto_name
);