3 # Copyright (c) 2005 Junio C Hamano.
10 git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] [<upstream>] [<branch>]
11 git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] --root [<branch>]
12 git rebase --continue | --abort | --skip | --edit-todo
15 v,verbose! display a diffstat of what changed upstream
16 q,quiet! be quiet. implies --no-stat
17 autostash automatically stash/stash pop before and after
18 fork-point use 'merge-base --fork-point' to refine upstream
19 onto=! rebase onto given branch instead of upstream
20 r,rebase-merges? try to rebase merges instead of skipping them
21 p,preserve-merges! try to recreate merges instead of ignoring them
22 s,strategy=! use the given merge strategy
23 X,strategy-option=! pass the argument through to the merge strategy
24 no-ff! cherry-pick all commits, even if unchanged
25 f,force-rebase! cherry-pick all commits, even if unchanged
26 m,merge! use merging strategies to rebase
27 i,interactive! let the user edit the list of commits to rebase
28 x,exec=! add exec lines after each commit of the editable list
29 k,keep-empty preserve empty commits during rebase
30 allow-empty-message allow rebasing commits with empty messages
31 stat! display a diffstat of what changed upstream
32 n,no-stat! do not show diffstat of what changed upstream
33 verify allow pre-rebase hook to run
34 rerere-autoupdate allow rerere to update index with resolved conflicts
35 root! rebase all reachable commits up to the root(s)
36 autosquash move commits that begin with squash!/fixup! under -i
37 signoff add a Signed-off-by: line to each commit
38 committer-date-is-author-date! passed to 'git am'
39 ignore-date! passed to 'git am'
40 whitespace=! passed to 'git apply'
41 ignore-whitespace! passed to 'git apply'
42 C=! passed to 'git apply'
43 S,gpg-sign? GPG-sign commits
46 abort! abort and check out the original branch
47 skip! skip current patch and continue
48 edit-todo! edit the todo list during an interactive rebase
49 quit! abort but keep HEAD where it is
50 show-current-patch! show the patch file being applied or merged
51 reschedule-failed-exec automatically reschedule failed exec commands
54 set_reflog_action rebase
55 require_work_tree_exists
60 ok_to_skip_pre_rebase=
64 unset restrict_revision
69 merge_dir="$GIT_DIR"/rebase-merge
70 apply_dir="$GIT_DIR"/rebase-apply
73 test "$(git config --bool rebase.stat)" = true && diffstat=t
74 autostash="$(git config --bool rebase.autostash || echo false)"
80 allow_rerere_autoupdate=
81 # Non-empty if a rebase was in progress when 'git rebase' was invoked
83 # One of {am, merge, interactive}
85 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
87 # One of {'', continue, skip, abort}, as parsed from command line
94 allow_empty_message=--allow-empty-message
96 reschedule_failed_exec=
97 test "$(git config --bool rebase.autosquash)" = "true" && autosquash=t
98 case "$(git config --bool commit.gpgsign)" in
99 true) gpg_sign_opt=-S ;;
102 test "$(git config --bool rebase.reschedulefailedexec)" = "true" &&
103 reschedule_failed_exec=--reschedule-failed-exec
106 read_basic_state () {
107 test -f "$state_dir/head-name" &&
108 test -f "$state_dir/onto" &&
109 head_name=$(cat "$state_dir"/head-name) &&
110 onto=$(cat "$state_dir"/onto) &&
111 # We always write to orig-head, but interactive rebase used to write to
112 # head. Fall back to reading from head to cover for the case that the
113 # user upgraded git with an ongoing interactive rebase.
114 if test -f "$state_dir"/orig-head
116 orig_head=$(cat "$state_dir"/orig-head)
118 orig_head=$(cat "$state_dir"/head)
120 test -f "$state_dir"/quiet && GIT_QUIET=t
121 test -f "$state_dir"/verbose && verbose=t
122 test -f "$state_dir"/strategy && strategy="$(cat "$state_dir"/strategy)"
123 test -f "$state_dir"/strategy_opts &&
124 strategy_opts="$(cat "$state_dir"/strategy_opts)"
125 test -f "$state_dir"/allow_rerere_autoupdate &&
126 allow_rerere_autoupdate="$(cat "$state_dir"/allow_rerere_autoupdate)"
127 test -f "$state_dir"/gpg_sign_opt &&
128 gpg_sign_opt="$(cat "$state_dir"/gpg_sign_opt)"
129 test -f "$state_dir"/signoff && {
130 signoff="$(cat "$state_dir"/signoff)"
133 test -f "$state_dir"/reschedule-failed-exec &&
134 reschedule_failed_exec=t
138 rm -f "$(git rev-parse --git-path REBASE_HEAD)"
140 { git gc --auto || true; } &&
145 GIT_CHERRY_PICK_HELP="$resolvemsg"
146 export GIT_CHERRY_PICK_HELP
148 test -n "$keep_empty" && keep_empty="--keep-empty"
149 test -n "$rebase_merges" && rebase_merges="--rebase-merges"
150 test -n "$rebase_cousins" && rebase_cousins="--rebase-cousins"
151 test -n "$autosquash" && autosquash="--autosquash"
152 test -n "$verbose" && verbose="--verbose"
153 test -n "$force_rebase" && force_rebase="--no-ff"
154 test -n "$restrict_revision" && \
155 restrict_revision="--restrict-revision=^$restrict_revision"
156 test -n "$upstream" && upstream="--upstream=$upstream"
157 test -n "$onto" && onto="--onto=$onto"
158 test -n "$squash_onto" && squash_onto="--squash-onto=$squash_onto"
159 test -n "$onto_name" && onto_name="--onto-name=$onto_name"
160 test -n "$head_name" && head_name="--head-name=$head_name"
161 test -n "$strategy" && strategy="--strategy=$strategy"
162 test -n "$strategy_opts" && strategy_opts="--strategy-opts=$strategy_opts"
163 test -n "$switch_to" && switch_to="--switch-to=$switch_to"
164 test -n "$cmd" && cmd="--cmd=$cmd"
165 test -n "$action" && action="--$action"
167 exec git rebase--interactive "$action" "$keep_empty" "$rebase_merges" "$rebase_cousins" \
168 "$upstream" "$onto" "$squash_onto" "$restrict_revision" \
169 "$allow_empty_message" "$autosquash" "$verbose" \
170 "$force_rebase" "$onto_name" "$head_name" "$strategy" \
171 "$strategy_opts" "$cmd" "$switch_to" \
172 "$allow_rerere_autoupdate" "$gpg_sign_opt" "$signoff" \
173 "$reschedule_failed_exec"
176 run_specific_rebase () {
177 if [ "$interactive_rebase" = implied ]; then
178 GIT_SEQUENCE_EDITOR=:
179 export GIT_SEQUENCE_EDITOR
183 if test -n "$interactive_rebase" -a -z "$preserve_merges"
189 if test -z "$preserve_merges"
193 git_rebase__preserve_merges
201 elif test $ret -eq 2 # special exit status for rebase -p
204 rm -rf "$state_dir" &&
210 run_pre_rebase_hook () {
211 if test -z "$ok_to_skip_pre_rebase" &&
212 test -x "$(git rev-parse --git-path hooks/pre-rebase)"
214 "$(git rev-parse --git-path hooks/pre-rebase)" ${1+"$@"} ||
215 die "$(gettext "The pre-rebase hook refused to rebase.")"
219 test -f "$apply_dir"/applying &&
220 die "$(gettext "It looks like 'git am' is in progress. Cannot rebase.")"
222 if test -d "$apply_dir"
225 state_dir="$apply_dir"
226 elif test -d "$merge_dir"
229 if test -d "$merge_dir"/rewritten
232 interactive_rebase=explicit
234 elif test -f "$merge_dir"/interactive
236 interactive_rebase=explicit
238 state_dir="$merge_dir"
240 test -n "$type" && in_progress=t
247 ok_to_skip_pre_rebase=yes
250 ok_to_skip_pre_rebase=
252 --continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)
253 test $total_argc -eq 2 || usage
260 cmd="${cmd}exec ${1#--exec=}${LF}"
261 test -z "$interactive_rebase" && interactive_rebase=implied
264 interactive_rebase=explicit
269 --allow-empty-message)
270 allow_empty_message=--allow-empty-message
277 test -z "$interactive_rebase" && interactive_rebase=implied
282 rebase-cousins) rebase_cousins=t;;
283 no-rebase-cousins) rebase_cousins=;;
284 *) die "Unknown mode: $1";;
286 test -z "$interactive_rebase" && interactive_rebase=implied
290 test -z "$interactive_rebase" && interactive_rebase=implied
308 strategy_opts="$strategy_opts $(git rev-parse --sq-quote "--${1#--strategy-option=}" | sed -e s/^.//)"
310 test -z "$strategy" && strategy=recursive
313 strategy="${1#--strategy=}"
335 git_am_opt="$git_am_opt -q"
340 git_am_opt="$git_am_opt --whitespace=${1#--whitespace=}"
341 case "${1#--whitespace=}" in
345 warn|nowarn|error|error-all)
346 ;; # okay, known whitespace option
348 die "fatal: Invalid whitespace option: '${1#*=}'"
353 git_am_opt="$git_am_opt $1"
361 --committer-date-is-author-date|--ignore-date)
362 git_am_opt="$git_am_opt $1"
366 die "fatal: switch \`C' expects a numerical value"
369 git_am_opt="$git_am_opt $1"
374 --force-rebase|--no-ff)
377 --rerere-autoupdate|--no-rerere-autoupdate)
378 allow_rerere_autoupdate="$1"
384 gpg_sign_opt="-S${1#--gpg-sign=}"
386 --reschedule-failed-exec)
387 reschedule_failed_exec=--reschedule-failed-exec
389 --no-reschedule-failed-exec)
390 reschedule_failed_exec=
402 test $# -gt 2 && usage
406 test -z "$in_progress" && die "$(gettext "No rebase in progress?")"
407 # Only interactive rebase uses detailed reflog messages
408 if test -n "$interactive_rebase" && test "$GIT_REFLOG_ACTION" = rebase
410 GIT_REFLOG_ACTION="rebase -i ($action)"
411 export GIT_REFLOG_ACTION
415 if test "$action" = "edit-todo" && test -z "$interactive_rebase"
417 die "$(gettext "The --edit-todo action can only be used during interactive rebase.")"
423 git rev-parse --verify HEAD >/dev/null ||
424 die "$(gettext "Cannot read HEAD")"
425 git update-index --ignore-submodules --refresh &&
426 git diff-files --quiet --ignore-submodules || {
427 echo "$(gettext "You must edit all merge conflicts and then
428 mark them as resolved using git add")"
435 output git reset --hard HEAD || exit $?
444 git symbolic-ref -m "rebase: aborting" HEAD $head_name ||
445 die "$(eval_gettext "Could not move back to \$head_name")"
448 output git reset --hard $orig_head
453 exec rm -rf "$state_dir"
460 die "BUG: run_specific_rebase is not supposed to return here"
464 # Make sure no rebase is in progress
465 if test -n "$in_progress"
467 state_dir_base=${state_dir##*/}
468 cmd_live_rebase="git rebase (--continue | --abort | --skip)"
469 cmd_clear_stale_rebase="rm -fr \"$state_dir\""
471 $(eval_gettext 'It seems that there is already a $state_dir_base directory, and
472 I wonder if you are in the middle of another rebase. If that is the
475 If that is not the case, please
476 $cmd_clear_stale_rebase
477 and run me again. I am stopping in case you still have something
481 if test -n "$rebase_root" && test -z "$onto"
483 test -z "$interactive_rebase" && interactive_rebase=implied
486 if test -n "$keep_empty"
488 test -z "$interactive_rebase" && interactive_rebase=implied
491 actually_interactive=
492 if test -n "$interactive_rebase"
494 if test -z "$preserve_merges"
500 actually_interactive=t
501 state_dir="$merge_dir"
502 elif test -n "$do_merge"
504 interactive_rebase=implied
506 state_dir="$merge_dir"
509 state_dir="$apply_dir"
512 if test -t 2 && test -z "$GIT_QUIET"
514 git_format_patch_opt="$git_format_patch_opt --progress"
517 incompatible_opts=$(echo " $git_am_opt " | \
518 sed -e 's/ -q / /g' -e 's/^ \(.*\) $/\1/')
519 if test -n "$incompatible_opts"
521 if test -n "$actually_interactive" || test "$do_merge"
523 die "$(gettext "fatal: cannot combine am options with either interactive or merge options")"
527 if test -n "$signoff"
529 test -n "$preserve_merges" &&
530 die "$(gettext "fatal: cannot combine '--signoff' with '--preserve-merges'")"
531 git_am_opt="$git_am_opt $signoff"
535 if test -n "$preserve_merges"
537 # Note: incompatibility with --signoff handled in signoff block above
538 # Note: incompatibility with --interactive is just a strong warning;
539 # git-rebase.txt caveats with "unless you know what you are doing"
540 test -n "$rebase_merges" &&
541 die "$(gettext "fatal: cannot combine '--preserve-merges' with '--rebase-merges'")"
543 test -n "$reschedule_failed_exec" &&
544 die "$(gettext "error: cannot combine '--preserve-merges' with '--reschedule-failed-exec'")"
547 if test -n "$rebase_merges"
549 test -n "$strategy_opts" &&
550 die "$(gettext "fatal: cannot combine '--rebase-merges' with '--strategy-option'")"
551 test -n "$strategy" &&
552 die "$(gettext "fatal: cannot combine '--rebase-merges' with '--strategy'")"
555 if test -z "$rebase_root"
559 if ! upstream_name=$(git rev-parse --symbolic-full-name \
560 --verify -q @{upstream} 2>/dev/null)
563 error_on_missing_default_upstream "rebase" "rebase" \
564 "against" "git rebase $(gettext '<branch>')"
567 test "$fork_point" = auto && fork_point=t
569 *) upstream_name="$1"
570 if test "$upstream_name" = "-"
572 upstream_name="@{-1}"
577 upstream=$(peel_committish "${upstream_name}") ||
578 die "$(eval_gettext "invalid upstream '\$upstream_name'")"
579 upstream_arg="$upstream_name"
583 empty_tree=$(git hash-object -t tree /dev/null)
584 onto=$(git commit-tree $empty_tree </dev/null)
589 test $# -gt 1 && usage
593 # Make sure the branch to rebase onto is valid.
594 onto_name=${onto-"$upstream_name"}
597 if left=${onto_name%...*} right=${onto_name#*...} &&
598 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
602 die "$(eval_gettext "\$onto_name: there are more than one merge bases")"
605 die "$(eval_gettext "\$onto_name: there is no merge base")"
609 die "$(eval_gettext "\$onto_name: there is no merge base")"
613 onto=$(peel_committish "$onto_name") ||
614 die "$(eval_gettext "Does not point to a valid commit: \$onto_name")"
618 # If the branch to rebase is given, that is the branch we will rebase
619 # $branch_name -- branch/commit being rebased, or HEAD (already detached)
620 # $orig_head -- commit object name of tip of the branch before rebasing
621 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
625 # Is it "rebase other $branchname" or "rebase other $commit"?
629 # Is it a local branch?
630 if git show-ref --verify --quiet -- "refs/heads/$branch_name" &&
631 orig_head=$(git rev-parse -q --verify "refs/heads/$branch_name")
633 head_name="refs/heads/$branch_name"
634 # If not is it a valid ref (branch or commit)?
635 elif orig_head=$(git rev-parse -q --verify "$branch_name")
637 head_name="detached HEAD"
640 die "$(eval_gettext "fatal: no such branch/commit '\$branch_name'")"
644 # Do not need to switch branches, we are already on it.
645 if branch_name=$(git symbolic-ref -q HEAD)
647 head_name=$branch_name
648 branch_name=$(expr "z$branch_name" : 'zrefs/heads/\(.*\)')
650 head_name="detached HEAD"
653 orig_head=$(git rev-parse --verify HEAD) || exit
656 die "BUG: unexpected number of arguments left to parse"
660 if test "$fork_point" = t
662 new_upstream=$(git merge-base --fork-point "$upstream_name" \
663 "${switch_to:-HEAD}")
664 if test -n "$new_upstream"
666 restrict_revision=$new_upstream
670 if test "$autostash" = true && ! (require_clean_work_tree) 2>/dev/null
672 stash_sha1=$(git stash create "autostash") ||
673 die "$(gettext 'Cannot autostash')"
675 mkdir -p "$state_dir" &&
676 echo $stash_sha1 >"$state_dir/autostash" &&
677 stash_abbrev=$(git rev-parse --short $stash_sha1) &&
678 echo "$(eval_gettext 'Created autostash: $stash_abbrev')" &&
682 require_clean_work_tree "rebase" "$(gettext "Please commit or stash them.")"
684 # Now we are rebasing commits $upstream..$orig_head (or with --root,
685 # everything leading up to $orig_head) on top of $onto
687 # Check if we are already based on $onto with linear history,
688 # but this should be done only when upstream and onto are the same
689 # and if this is not an interactive rebase.
690 mb=$(git merge-base "$onto" "$orig_head")
691 if test -z "$actually_interactive" && test "$upstream" = "$onto" &&
692 test "$mb" = "$onto" && test -z "$restrict_revision" &&
694 ! (git rev-list --parents "$onto".."$orig_head" | sane_grep " .* ") > /dev/null
696 if test -z "$force_rebase"
698 # Lazily switch to the target branch if needed...
699 test -z "$switch_to" ||
700 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to" \
701 git checkout -q "$switch_to" --
702 if test "$branch_name" = "HEAD" &&
703 ! git symbolic-ref -q HEAD
705 say "$(eval_gettext "HEAD is up to date.")"
707 say "$(eval_gettext "Current branch \$branch_name is up to date.")"
712 if test "$branch_name" = "HEAD" &&
713 ! git symbolic-ref -q HEAD
715 say "$(eval_gettext "HEAD is up to date, rebase forced.")"
717 say "$(eval_gettext "Current branch \$branch_name is up to date, rebase forced.")"
722 # If a hook exists, give it a chance to interrupt
723 run_pre_rebase_hook "$upstream_arg" "$@"
725 if test -n "$diffstat"
727 if test -n "$verbose"
731 echo "$(eval_gettext "Changes to \$onto:")"
733 echo "$(eval_gettext "Changes from \$mb to \$onto:")"
736 mb_tree="${mb:-$(git hash-object -t tree /dev/null)}"
737 # We want color (if set), but no pager
738 GIT_PAGER='' git diff --stat --summary "$mb_tree" "$onto"
741 if test -z "$actually_interactive" && test "$mb" = "$orig_head"
743 say "$(eval_gettext "Fast-forwarded \$branch_name to \$onto_name.")"
744 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name" \
745 git checkout -q "$onto^0" || die "could not detach HEAD"
746 # If the $onto is a proper descendant of the tip of the branch, then
747 # we just fast-forwarded.
748 git update-ref ORIG_HEAD $orig_head
749 move_to_original_branch
754 test -n "$interactive_rebase" && run_specific_rebase
756 # Detach HEAD and reset the tree
757 say "$(gettext "First, rewinding head to replay your work on top of it...")"
759 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name" \
760 git checkout -q "$onto^0" || die "could not detach HEAD"
761 git update-ref ORIG_HEAD $orig_head
763 if test -n "$rebase_root"
765 revisions="$onto..$orig_head"
767 revisions="${restrict_revision-$upstream}..$orig_head"