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 y=! same as --reschedule-failed-exec -x
30 k,keep-empty preserve empty commits during rebase
31 allow-empty-message allow rebasing commits with empty messages
32 stat! display a diffstat of what changed upstream
33 n,no-stat! do not show diffstat of what changed upstream
34 verify allow pre-rebase hook to run
35 rerere-autoupdate allow rerere to update index with resolved conflicts
36 root! rebase all reachable commits up to the root(s)
37 autosquash move commits that begin with squash!/fixup! under -i
38 signoff add a Signed-off-by: line to each commit
39 committer-date-is-author-date! passed to 'git am'
40 ignore-date! passed to 'git am'
41 whitespace=! passed to 'git apply'
42 ignore-whitespace! passed to 'git apply'
43 C=! passed to 'git apply'
44 S,gpg-sign? GPG-sign commits
47 abort! abort and check out the original branch
48 skip! skip current patch and continue
49 edit-todo! edit the todo list during an interactive rebase
50 quit! abort but keep HEAD where it is
51 show-current-patch! show the patch file being applied or merged
52 reschedule-failed-exec automatically reschedule failed exec commands
55 set_reflog_action rebase
56 require_work_tree_exists
61 ok_to_skip_pre_rebase=
65 unset restrict_revision
70 merge_dir="$GIT_DIR"/rebase-merge
71 apply_dir="$GIT_DIR"/rebase-apply
74 test "$(git config --bool rebase.stat)" = true && diffstat=t
75 autostash="$(git config --bool rebase.autostash || echo false)"
81 allow_rerere_autoupdate=
82 # Non-empty if a rebase was in progress when 'git rebase' was invoked
84 # One of {am, merge, interactive}
86 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
88 # One of {'', continue, skip, abort}, as parsed from command line
95 allow_empty_message=--allow-empty-message
97 reschedule_failed_exec=
98 test "$(git config --bool rebase.autosquash)" = "true" && autosquash=t
99 case "$(git config --bool commit.gpgsign)" in
100 true) gpg_sign_opt=-S ;;
103 test "$(git config --bool rebase.reschedulefailedexec)" = "true" &&
104 reschedule_failed_exec=--reschedule-failed-exec
107 read_basic_state () {
108 test -f "$state_dir/head-name" &&
109 test -f "$state_dir/onto" &&
110 head_name=$(cat "$state_dir"/head-name) &&
111 onto=$(cat "$state_dir"/onto) &&
112 # We always write to orig-head, but interactive rebase used to write to
113 # head. Fall back to reading from head to cover for the case that the
114 # user upgraded git with an ongoing interactive rebase.
115 if test -f "$state_dir"/orig-head
117 orig_head=$(cat "$state_dir"/orig-head)
119 orig_head=$(cat "$state_dir"/head)
121 test -f "$state_dir"/quiet && GIT_QUIET=t
122 test -f "$state_dir"/verbose && verbose=t
123 test -f "$state_dir"/strategy && strategy="$(cat "$state_dir"/strategy)"
124 test -f "$state_dir"/strategy_opts &&
125 strategy_opts="$(cat "$state_dir"/strategy_opts)"
126 test -f "$state_dir"/allow_rerere_autoupdate &&
127 allow_rerere_autoupdate="$(cat "$state_dir"/allow_rerere_autoupdate)"
128 test -f "$state_dir"/gpg_sign_opt &&
129 gpg_sign_opt="$(cat "$state_dir"/gpg_sign_opt)"
130 test -f "$state_dir"/signoff && {
131 signoff="$(cat "$state_dir"/signoff)"
134 test -f "$state_dir"/reschedule-failed-exec &&
135 reschedule_failed_exec=t
139 rm -f "$(git rev-parse --git-path REBASE_HEAD)"
141 { git gc --auto || true; } &&
146 GIT_CHERRY_PICK_HELP="$resolvemsg"
147 export GIT_CHERRY_PICK_HELP
149 test -n "$keep_empty" && keep_empty="--keep-empty"
150 test -n "$rebase_merges" && rebase_merges="--rebase-merges"
151 test -n "$rebase_cousins" && rebase_cousins="--rebase-cousins"
152 test -n "$autosquash" && autosquash="--autosquash"
153 test -n "$verbose" && verbose="--verbose"
154 test -n "$force_rebase" && force_rebase="--no-ff"
155 test -n "$restrict_revision" && \
156 restrict_revision="--restrict-revision=^$restrict_revision"
157 test -n "$upstream" && upstream="--upstream=$upstream"
158 test -n "$onto" && onto="--onto=$onto"
159 test -n "$squash_onto" && squash_onto="--squash-onto=$squash_onto"
160 test -n "$onto_name" && onto_name="--onto-name=$onto_name"
161 test -n "$head_name" && head_name="--head-name=$head_name"
162 test -n "$strategy" && strategy="--strategy=$strategy"
163 test -n "$strategy_opts" && strategy_opts="--strategy-opts=$strategy_opts"
164 test -n "$switch_to" && switch_to="--switch-to=$switch_to"
165 test -n "$cmd" && cmd="--cmd=$cmd"
166 test -n "$action" && action="--$action"
168 exec git rebase--interactive "$action" "$keep_empty" "$rebase_merges" "$rebase_cousins" \
169 "$upstream" "$onto" "$squash_onto" "$restrict_revision" \
170 "$allow_empty_message" "$autosquash" "$verbose" \
171 "$force_rebase" "$onto_name" "$head_name" "$strategy" \
172 "$strategy_opts" "$cmd" "$switch_to" \
173 "$allow_rerere_autoupdate" "$gpg_sign_opt" "$signoff" \
174 "$reschedule_failed_exec"
177 run_specific_rebase () {
178 if [ "$interactive_rebase" = implied ]; then
179 GIT_SEQUENCE_EDITOR=:
180 export GIT_SEQUENCE_EDITOR
184 if test -n "$interactive_rebase" -a -z "$preserve_merges"
190 if test -z "$preserve_merges"
194 git_rebase__preserve_merges
202 elif test $ret -eq 2 # special exit status for rebase -p
205 rm -rf "$state_dir" &&
211 run_pre_rebase_hook () {
212 if test -z "$ok_to_skip_pre_rebase" &&
213 test -x "$(git rev-parse --git-path hooks/pre-rebase)"
215 "$(git rev-parse --git-path hooks/pre-rebase)" ${1+"$@"} ||
216 die "$(gettext "The pre-rebase hook refused to rebase.")"
220 test -f "$apply_dir"/applying &&
221 die "$(gettext "It looks like 'git am' is in progress. Cannot rebase.")"
223 if test -d "$apply_dir"
226 state_dir="$apply_dir"
227 elif test -d "$merge_dir"
230 if test -d "$merge_dir"/rewritten
233 interactive_rebase=explicit
235 elif test -f "$merge_dir"/interactive
237 interactive_rebase=explicit
239 state_dir="$merge_dir"
241 test -n "$type" && in_progress=t
248 ok_to_skip_pre_rebase=yes
251 ok_to_skip_pre_rebase=
253 --continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)
254 test $total_argc -eq 2 || usage
261 cmd="${cmd}exec ${1#--exec=}${LF}"
262 test -z "$interactive_rebase" && interactive_rebase=implied
265 reschedule_failed_exec=--reschedule-failed-exec
266 cmd="${cmd}exec ${1#-y}${LF}"
267 test -z "$interactive_rebase" && interactive_rebase=implied
270 interactive_rebase=explicit
275 --allow-empty-message)
276 allow_empty_message=--allow-empty-message
283 test -z "$interactive_rebase" && interactive_rebase=implied
288 rebase-cousins) rebase_cousins=t;;
289 no-rebase-cousins) rebase_cousins=;;
290 *) die "Unknown mode: $1";;
292 test -z "$interactive_rebase" && interactive_rebase=implied
296 test -z "$interactive_rebase" && interactive_rebase=implied
314 strategy_opts="$strategy_opts $(git rev-parse --sq-quote "--${1#--strategy-option=}" | sed -e s/^.//)"
316 test -z "$strategy" && strategy=recursive
319 strategy="${1#--strategy=}"
341 git_am_opt="$git_am_opt -q"
346 git_am_opt="$git_am_opt --whitespace=${1#--whitespace=}"
347 case "${1#--whitespace=}" in
351 warn|nowarn|error|error-all)
352 ;; # okay, known whitespace option
354 die "fatal: Invalid whitespace option: '${1#*=}'"
359 git_am_opt="$git_am_opt $1"
367 --committer-date-is-author-date|--ignore-date)
368 git_am_opt="$git_am_opt $1"
372 die "fatal: switch \`C' expects a numerical value"
375 git_am_opt="$git_am_opt $1"
380 --force-rebase|--no-ff)
383 --rerere-autoupdate|--no-rerere-autoupdate)
384 allow_rerere_autoupdate="$1"
390 gpg_sign_opt="-S${1#--gpg-sign=}"
392 --reschedule-failed-exec)
393 reschedule_failed_exec=--reschedule-failed-exec
395 --no-reschedule-failed-exec)
396 reschedule_failed_exec=
408 test $# -gt 2 && usage
412 test -z "$in_progress" && die "$(gettext "No rebase in progress?")"
413 # Only interactive rebase uses detailed reflog messages
414 if test -n "$interactive_rebase" && test "$GIT_REFLOG_ACTION" = rebase
416 GIT_REFLOG_ACTION="rebase -i ($action)"
417 export GIT_REFLOG_ACTION
421 if test "$action" = "edit-todo" && test -z "$interactive_rebase"
423 die "$(gettext "The --edit-todo action can only be used during interactive rebase.")"
429 git rev-parse --verify HEAD >/dev/null ||
430 die "$(gettext "Cannot read HEAD")"
431 git update-index --ignore-submodules --refresh &&
432 git diff-files --quiet --ignore-submodules || {
433 echo "$(gettext "You must edit all merge conflicts and then
434 mark them as resolved using git add")"
441 output git reset --hard HEAD || exit $?
450 git symbolic-ref -m "rebase: aborting" HEAD $head_name ||
451 die "$(eval_gettext "Could not move back to \$head_name")"
454 output git reset --hard $orig_head
459 exec rm -rf "$state_dir"
466 die "BUG: run_specific_rebase is not supposed to return here"
470 # Make sure no rebase is in progress
471 if test -n "$in_progress"
473 state_dir_base=${state_dir##*/}
474 cmd_live_rebase="git rebase (--continue | --abort | --skip)"
475 cmd_clear_stale_rebase="rm -fr \"$state_dir\""
477 $(eval_gettext 'It seems that there is already a $state_dir_base directory, and
478 I wonder if you are in the middle of another rebase. If that is the
481 If that is not the case, please
482 $cmd_clear_stale_rebase
483 and run me again. I am stopping in case you still have something
487 if test -n "$rebase_root" && test -z "$onto"
489 test -z "$interactive_rebase" && interactive_rebase=implied
492 if test -n "$keep_empty"
494 test -z "$interactive_rebase" && interactive_rebase=implied
497 actually_interactive=
498 if test -n "$interactive_rebase"
500 if test -z "$preserve_merges"
506 actually_interactive=t
507 state_dir="$merge_dir"
508 elif test -n "$do_merge"
510 interactive_rebase=implied
512 state_dir="$merge_dir"
515 state_dir="$apply_dir"
518 if test -t 2 && test -z "$GIT_QUIET"
520 git_format_patch_opt="$git_format_patch_opt --progress"
523 incompatible_opts=$(echo " $git_am_opt " | \
524 sed -e 's/ -q / /g' -e 's/^ \(.*\) $/\1/')
525 if test -n "$incompatible_opts"
527 if test -n "$actually_interactive" || test "$do_merge"
529 die "$(gettext "fatal: cannot combine am options with either interactive or merge options")"
533 if test -n "$signoff"
535 test -n "$preserve_merges" &&
536 die "$(gettext "fatal: cannot combine '--signoff' with '--preserve-merges'")"
537 git_am_opt="$git_am_opt $signoff"
541 if test -n "$preserve_merges"
543 # Note: incompatibility with --signoff handled in signoff block above
544 # Note: incompatibility with --interactive is just a strong warning;
545 # git-rebase.txt caveats with "unless you know what you are doing"
546 test -n "$rebase_merges" &&
547 die "$(gettext "fatal: cannot combine '--preserve-merges' with '--rebase-merges'")"
549 test -n "$reschedule_failed_exec" &&
550 die "$(gettext "error: cannot combine '--preserve-merges' with '--reschedule-failed-exec'")"
553 if test -n "$rebase_merges"
555 test -n "$strategy_opts" &&
556 die "$(gettext "fatal: cannot combine '--rebase-merges' with '--strategy-option'")"
557 test -n "$strategy" &&
558 die "$(gettext "fatal: cannot combine '--rebase-merges' with '--strategy'")"
561 if test -z "$rebase_root"
565 if ! upstream_name=$(git rev-parse --symbolic-full-name \
566 --verify -q @{upstream} 2>/dev/null)
569 error_on_missing_default_upstream "rebase" "rebase" \
570 "against" "git rebase $(gettext '<branch>')"
573 test "$fork_point" = auto && fork_point=t
575 *) upstream_name="$1"
576 if test "$upstream_name" = "-"
578 upstream_name="@{-1}"
583 upstream=$(peel_committish "${upstream_name}") ||
584 die "$(eval_gettext "invalid upstream '\$upstream_name'")"
585 upstream_arg="$upstream_name"
589 empty_tree=$(git hash-object -t tree /dev/null)
590 onto=$(git commit-tree $empty_tree </dev/null)
595 test $# -gt 1 && usage
599 # Make sure the branch to rebase onto is valid.
600 onto_name=${onto-"$upstream_name"}
603 if left=${onto_name%...*} right=${onto_name#*...} &&
604 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
608 die "$(eval_gettext "\$onto_name: there are more than one merge bases")"
611 die "$(eval_gettext "\$onto_name: there is no merge base")"
615 die "$(eval_gettext "\$onto_name: there is no merge base")"
619 onto=$(peel_committish "$onto_name") ||
620 die "$(eval_gettext "Does not point to a valid commit: \$onto_name")"
624 # If the branch to rebase is given, that is the branch we will rebase
625 # $branch_name -- branch/commit being rebased, or HEAD (already detached)
626 # $orig_head -- commit object name of tip of the branch before rebasing
627 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
631 # Is it "rebase other $branchname" or "rebase other $commit"?
635 # Is it a local branch?
636 if git show-ref --verify --quiet -- "refs/heads/$branch_name" &&
637 orig_head=$(git rev-parse -q --verify "refs/heads/$branch_name")
639 head_name="refs/heads/$branch_name"
640 # If not is it a valid ref (branch or commit)?
641 elif orig_head=$(git rev-parse -q --verify "$branch_name")
643 head_name="detached HEAD"
646 die "$(eval_gettext "fatal: no such branch/commit '\$branch_name'")"
650 # Do not need to switch branches, we are already on it.
651 if branch_name=$(git symbolic-ref -q HEAD)
653 head_name=$branch_name
654 branch_name=$(expr "z$branch_name" : 'zrefs/heads/\(.*\)')
656 head_name="detached HEAD"
659 orig_head=$(git rev-parse --verify HEAD) || exit
662 die "BUG: unexpected number of arguments left to parse"
666 if test "$fork_point" = t
668 new_upstream=$(git merge-base --fork-point "$upstream_name" \
669 "${switch_to:-HEAD}")
670 if test -n "$new_upstream"
672 restrict_revision=$new_upstream
676 if test "$autostash" = true && ! (require_clean_work_tree) 2>/dev/null
678 stash_sha1=$(git stash create "autostash") ||
679 die "$(gettext 'Cannot autostash')"
681 mkdir -p "$state_dir" &&
682 echo $stash_sha1 >"$state_dir/autostash" &&
683 stash_abbrev=$(git rev-parse --short $stash_sha1) &&
684 echo "$(eval_gettext 'Created autostash: $stash_abbrev')" &&
688 require_clean_work_tree "rebase" "$(gettext "Please commit or stash them.")"
690 # Now we are rebasing commits $upstream..$orig_head (or with --root,
691 # everything leading up to $orig_head) on top of $onto
693 # Check if we are already based on $onto with linear history,
694 # but this should be done only when upstream and onto are the same
695 # and if this is not an interactive rebase.
696 mb=$(git merge-base "$onto" "$orig_head")
697 if test -z "$actually_interactive" && test "$upstream" = "$onto" &&
698 test "$mb" = "$onto" && test -z "$restrict_revision" &&
700 ! (git rev-list --parents "$onto".."$orig_head" | sane_grep " .* ") > /dev/null
702 if test -z "$force_rebase"
704 # Lazily switch to the target branch if needed...
705 test -z "$switch_to" ||
706 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to" \
707 git checkout -q "$switch_to" --
708 if test "$branch_name" = "HEAD" &&
709 ! git symbolic-ref -q HEAD
711 say "$(eval_gettext "HEAD is up to date.")"
713 say "$(eval_gettext "Current branch \$branch_name is up to date.")"
718 if test "$branch_name" = "HEAD" &&
719 ! git symbolic-ref -q HEAD
721 say "$(eval_gettext "HEAD is up to date, rebase forced.")"
723 say "$(eval_gettext "Current branch \$branch_name is up to date, rebase forced.")"
728 # If a hook exists, give it a chance to interrupt
729 run_pre_rebase_hook "$upstream_arg" "$@"
731 if test -n "$diffstat"
733 if test -n "$verbose"
737 echo "$(eval_gettext "Changes to \$onto:")"
739 echo "$(eval_gettext "Changes from \$mb to \$onto:")"
742 mb_tree="${mb:-$(git hash-object -t tree /dev/null)}"
743 # We want color (if set), but no pager
744 GIT_PAGER='' git diff --stat --summary "$mb_tree" "$onto"
747 if test -z "$actually_interactive" && test "$mb" = "$orig_head"
749 say "$(eval_gettext "Fast-forwarded \$branch_name to \$onto_name.")"
750 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name" \
751 git checkout -q "$onto^0" || die "could not detach HEAD"
752 # If the $onto is a proper descendant of the tip of the branch, then
753 # we just fast-forwarded.
754 git update-ref ORIG_HEAD $orig_head
755 move_to_original_branch
760 test -n "$interactive_rebase" && run_specific_rebase
762 # Detach HEAD and reset the tree
763 say "$(gettext "First, rewinding head to replay your work on top of it...")"
765 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name" \
766 git checkout -q "$onto^0" || die "could not detach HEAD"
767 git update-ref ORIG_HEAD $orig_head
769 if test -n "$rebase_root"
771 revisions="$onto..$orig_head"
773 revisions="${restrict_revision-$upstream}..$orig_head"