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
53 set_reflog_action rebase
54 require_work_tree_exists
59 ok_to_skip_pre_rebase=
63 unset restrict_revision
68 merge_dir="$GIT_DIR"/rebase-merge
69 apply_dir="$GIT_DIR"/rebase-apply
72 test "$(git config --bool rebase.stat)" = true && diffstat=t
73 autostash="$(git config --bool rebase.autostash || echo false)"
79 allow_rerere_autoupdate=
80 # Non-empty if a rebase was in progress when 'git rebase' was invoked
82 # One of {am, merge, interactive}
84 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
86 # One of {'', continue, skip, abort}, as parsed from command line
93 allow_empty_message=--allow-empty-message
95 test "$(git config --bool rebase.autosquash)" = "true" && autosquash=t
96 case "$(git config --bool commit.gpgsign)" in
97 true) gpg_sign_opt=-S ;;
102 read_basic_state () {
103 test -f "$state_dir/head-name" &&
104 test -f "$state_dir/onto" &&
105 head_name=$(cat "$state_dir"/head-name) &&
106 onto=$(cat "$state_dir"/onto) &&
107 # We always write to orig-head, but interactive rebase used to write to
108 # head. Fall back to reading from head to cover for the case that the
109 # user upgraded git with an ongoing interactive rebase.
110 if test -f "$state_dir"/orig-head
112 orig_head=$(cat "$state_dir"/orig-head)
114 orig_head=$(cat "$state_dir"/head)
116 GIT_QUIET=$(cat "$state_dir"/quiet) &&
117 test -f "$state_dir"/verbose && verbose=t
118 test -f "$state_dir"/strategy && strategy="$(cat "$state_dir"/strategy)"
119 test -f "$state_dir"/strategy_opts &&
120 strategy_opts="$(cat "$state_dir"/strategy_opts)"
121 test -f "$state_dir"/allow_rerere_autoupdate &&
122 allow_rerere_autoupdate="$(cat "$state_dir"/allow_rerere_autoupdate)"
123 test -f "$state_dir"/gpg_sign_opt &&
124 gpg_sign_opt="$(cat "$state_dir"/gpg_sign_opt)"
125 test -f "$state_dir"/signoff && {
126 signoff="$(cat "$state_dir"/signoff)"
132 rm -f "$(git rev-parse --git-path REBASE_HEAD)"
134 { git gc --auto || true; } &&
139 GIT_CHERRY_PICK_HELP="$resolvemsg"
140 export GIT_CHERRY_PICK_HELP
142 test -n "$keep_empty" && keep_empty="--keep-empty"
143 test -n "$rebase_merges" && rebase_merges="--rebase-merges"
144 test -n "$rebase_cousins" && rebase_cousins="--rebase-cousins"
145 test -n "$autosquash" && autosquash="--autosquash"
146 test -n "$verbose" && verbose="--verbose"
147 test -n "$force_rebase" && force_rebase="--no-ff"
148 test -n "$restrict_revision" && \
149 restrict_revision="--restrict-revision=^$restrict_revision"
150 test -n "$upstream" && upstream="--upstream=$upstream"
151 test -n "$onto" && onto="--onto=$onto"
152 test -n "$squash_onto" && squash_onto="--squash-onto=$squash_onto"
153 test -n "$onto_name" && onto_name="--onto-name=$onto_name"
154 test -n "$head_name" && head_name="--head-name=$head_name"
155 test -n "$strategy" && strategy="--strategy=$strategy"
156 test -n "$strategy_opts" && strategy_opts="--strategy-opts=$strategy_opts"
157 test -n "$switch_to" && switch_to="--switch-to=$switch_to"
158 test -n "$cmd" && cmd="--cmd=$cmd"
159 test -n "$action" && action="--$action"
161 exec git rebase--interactive "$action" "$keep_empty" "$rebase_merges" "$rebase_cousins" \
162 "$upstream" "$onto" "$squash_onto" "$restrict_revision" \
163 "$allow_empty_message" "$autosquash" "$verbose" \
164 "$force_rebase" "$onto_name" "$head_name" "$strategy" \
165 "$strategy_opts" "$cmd" "$switch_to" \
166 "$allow_rerere_autoupdate" "$gpg_sign_opt" "$signoff"
169 run_specific_rebase () {
170 if [ "$interactive_rebase" = implied ]; then
176 if test -n "$interactive_rebase" -a -z "$preserve_merges"
182 if test -z "$preserve_merges"
186 git_rebase__preserve_merges
194 elif test $ret -eq 2 # special exit status for rebase -p
197 rm -rf "$state_dir" &&
203 run_pre_rebase_hook () {
204 if test -z "$ok_to_skip_pre_rebase" &&
205 test -x "$(git rev-parse --git-path hooks/pre-rebase)"
207 "$(git rev-parse --git-path hooks/pre-rebase)" ${1+"$@"} ||
208 die "$(gettext "The pre-rebase hook refused to rebase.")"
212 test -f "$apply_dir"/applying &&
213 die "$(gettext "It looks like 'git am' is in progress. Cannot rebase.")"
215 if test -d "$apply_dir"
218 state_dir="$apply_dir"
219 elif test -d "$merge_dir"
221 if test -d "$merge_dir"/rewritten
224 interactive_rebase=explicit
226 elif test -f "$merge_dir"/interactive
229 interactive_rebase=explicit
233 state_dir="$merge_dir"
235 test -n "$type" && in_progress=t
242 ok_to_skip_pre_rebase=yes
245 ok_to_skip_pre_rebase=
247 --continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)
248 test $total_argc -eq 2 || usage
255 cmd="${cmd}exec ${1#--exec=}${LF}"
256 test -z "$interactive_rebase" && interactive_rebase=implied
259 interactive_rebase=explicit
264 --allow-empty-message)
265 allow_empty_message=--allow-empty-message
272 test -z "$interactive_rebase" && interactive_rebase=implied
277 rebase-cousins) rebase_cousins=t;;
278 no-rebase-cousins) rebase_cousins=;;
279 *) die "Unknown mode: $1";;
281 test -z "$interactive_rebase" && interactive_rebase=implied
285 test -z "$interactive_rebase" && interactive_rebase=implied
303 strategy_opts="$strategy_opts $(git rev-parse --sq-quote "--${1#--strategy-option=}" | sed -e s/^.//)"
305 test -z "$strategy" && strategy=recursive
308 strategy="${1#--strategy=}"
330 git_am_opt="$git_am_opt -q"
335 git_am_opt="$git_am_opt --whitespace=${1#--whitespace=}"
336 case "${1#--whitespace=}" in
340 warn|nowarn|error|error-all)
341 ;; # okay, known whitespace option
343 die "fatal: Invalid whitespace option: '${1#*=}'"
348 git_am_opt="$git_am_opt $1"
356 --committer-date-is-author-date|--ignore-date)
357 git_am_opt="$git_am_opt $1"
361 die "fatal: switch \`C' expects a numerical value"
364 git_am_opt="$git_am_opt $1"
369 --force-rebase|--no-ff)
372 --rerere-autoupdate|--no-rerere-autoupdate)
373 allow_rerere_autoupdate="$1"
379 gpg_sign_opt="-S${1#--gpg-sign=}"
391 test $# -gt 2 && usage
395 test -z "$in_progress" && die "$(gettext "No rebase in progress?")"
396 # Only interactive rebase uses detailed reflog messages
397 if test -n "$interactive_rebase" && test "$GIT_REFLOG_ACTION" = rebase
399 GIT_REFLOG_ACTION="rebase -i ($action)"
400 export GIT_REFLOG_ACTION
404 if test "$action" = "edit-todo" && test -z "$interactive_rebase"
406 die "$(gettext "The --edit-todo action can only be used during interactive rebase.")"
412 git rev-parse --verify HEAD >/dev/null ||
413 die "$(gettext "Cannot read HEAD")"
414 git update-index --ignore-submodules --refresh &&
415 git diff-files --quiet --ignore-submodules || {
416 echo "$(gettext "You must edit all merge conflicts and then
417 mark them as resolved using git add")"
424 output git reset --hard HEAD || exit $?
433 git symbolic-ref -m "rebase: aborting" HEAD $head_name ||
434 die "$(eval_gettext "Could not move back to \$head_name")"
437 output git reset --hard $orig_head
442 exec rm -rf "$state_dir"
449 die "BUG: run_specific_rebase is not supposed to return here"
453 # Make sure no rebase is in progress
454 if test -n "$in_progress"
456 state_dir_base=${state_dir##*/}
457 cmd_live_rebase="git rebase (--continue | --abort | --skip)"
458 cmd_clear_stale_rebase="rm -fr \"$state_dir\""
460 $(eval_gettext 'It seems that there is already a $state_dir_base directory, and
461 I wonder if you are in the middle of another rebase. If that is the
464 If that is not the case, please
465 $cmd_clear_stale_rebase
466 and run me again. I am stopping in case you still have something
470 if test -n "$rebase_root" && test -z "$onto"
472 test -z "$interactive_rebase" && interactive_rebase=implied
475 if test -n "$keep_empty"
477 test -z "$interactive_rebase" && interactive_rebase=implied
480 if test -n "$interactive_rebase"
482 if test -z "$preserve_merges"
489 state_dir="$merge_dir"
490 elif test -n "$do_merge"
493 state_dir="$merge_dir"
496 state_dir="$apply_dir"
499 if test -t 2 && test -z "$GIT_QUIET"
501 git_format_patch_opt="$git_format_patch_opt --progress"
504 if test -n "$git_am_opt"; then
505 incompatible_opts=$(echo " $git_am_opt " | \
506 sed -e 's/ -q / /g' -e 's/^ \(.*\) $/\1/')
507 if test -n "$interactive_rebase"
509 if test -n "$incompatible_opts"
511 die "$(gettext "error: cannot combine interactive options (--interactive, --exec, --rebase-merges, --preserve-merges, --keep-empty, --root + --onto) with am options ($incompatible_opts)")"
514 if test -n "$do_merge"; then
515 if test -n "$incompatible_opts"
517 die "$(gettext "error: cannot combine merge options (--merge, --strategy, --strategy-option) with am options ($incompatible_opts)")"
522 if test -n "$signoff"
524 test -n "$preserve_merges" &&
525 die "$(gettext "error: cannot combine '--signoff' with '--preserve-merges'")"
526 git_am_opt="$git_am_opt $signoff"
530 if test -n "$preserve_merges"
532 # Note: incompatibility with --signoff handled in signoff block above
533 # Note: incompatibility with --interactive is just a strong warning;
534 # git-rebase.txt caveats with "unless you know what you are doing"
535 test -n "$rebase_merges" &&
536 die "$(gettext "error: cannot combine '--preserve-merges' with '--rebase-merges'")"
539 if test -n "$rebase_merges"
541 test -n "$strategy_opts" &&
542 die "$(gettext "error: cannot combine '--rebase-merges' with '--strategy-option'")"
543 test -n "$strategy" &&
544 die "$(gettext "error: cannot combine '--rebase-merges' with '--strategy'")"
547 if test -z "$rebase_root"
551 if ! upstream_name=$(git rev-parse --symbolic-full-name \
552 --verify -q @{upstream} 2>/dev/null)
555 error_on_missing_default_upstream "rebase" "rebase" \
556 "against" "git rebase $(gettext '<branch>')"
559 test "$fork_point" = auto && fork_point=t
561 *) upstream_name="$1"
562 if test "$upstream_name" = "-"
564 upstream_name="@{-1}"
569 upstream=$(peel_committish "${upstream_name}") ||
570 die "$(eval_gettext "invalid upstream '\$upstream_name'")"
571 upstream_arg="$upstream_name"
575 empty_tree=$(git hash-object -t tree /dev/null)
576 onto=$(git commit-tree $empty_tree </dev/null)
581 test $# -gt 1 && usage
585 # Make sure the branch to rebase onto is valid.
586 onto_name=${onto-"$upstream_name"}
589 if left=${onto_name%...*} right=${onto_name#*...} &&
590 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
594 die "$(eval_gettext "\$onto_name: there are more than one merge bases")"
597 die "$(eval_gettext "\$onto_name: there is no merge base")"
601 die "$(eval_gettext "\$onto_name: there is no merge base")"
605 onto=$(peel_committish "$onto_name") ||
606 die "$(eval_gettext "Does not point to a valid commit: \$onto_name")"
610 # If the branch to rebase is given, that is the branch we will rebase
611 # $branch_name -- branch/commit being rebased, or HEAD (already detached)
612 # $orig_head -- commit object name of tip of the branch before rebasing
613 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
617 # Is it "rebase other $branchname" or "rebase other $commit"?
621 # Is it a local branch?
622 if git show-ref --verify --quiet -- "refs/heads/$branch_name" &&
623 orig_head=$(git rev-parse -q --verify "refs/heads/$branch_name")
625 head_name="refs/heads/$branch_name"
626 # If not is it a valid ref (branch or commit)?
627 elif orig_head=$(git rev-parse -q --verify "$branch_name")
629 head_name="detached HEAD"
632 die "$(eval_gettext "fatal: no such branch/commit '\$branch_name'")"
636 # Do not need to switch branches, we are already on it.
637 if branch_name=$(git symbolic-ref -q HEAD)
639 head_name=$branch_name
640 branch_name=$(expr "z$branch_name" : 'zrefs/heads/\(.*\)')
642 head_name="detached HEAD"
645 orig_head=$(git rev-parse --verify HEAD) || exit
648 die "BUG: unexpected number of arguments left to parse"
652 if test "$fork_point" = t
654 new_upstream=$(git merge-base --fork-point "$upstream_name" \
655 "${switch_to:-HEAD}")
656 if test -n "$new_upstream"
658 restrict_revision=$new_upstream
662 if test "$autostash" = true && ! (require_clean_work_tree) 2>/dev/null
664 stash_sha1=$(git stash create "autostash") ||
665 die "$(gettext 'Cannot autostash')"
667 mkdir -p "$state_dir" &&
668 echo $stash_sha1 >"$state_dir/autostash" &&
669 stash_abbrev=$(git rev-parse --short $stash_sha1) &&
670 echo "$(eval_gettext 'Created autostash: $stash_abbrev')" &&
674 require_clean_work_tree "rebase" "$(gettext "Please commit or stash them.")"
676 # Now we are rebasing commits $upstream..$orig_head (or with --root,
677 # everything leading up to $orig_head) on top of $onto
679 # Check if we are already based on $onto with linear history,
680 # but this should be done only when upstream and onto are the same
681 # and if this is not an interactive rebase.
682 mb=$(git merge-base "$onto" "$orig_head")
683 if test -z "$interactive_rebase" && test "$upstream" = "$onto" &&
684 test "$mb" = "$onto" && test -z "$restrict_revision" &&
686 ! (git rev-list --parents "$onto".."$orig_head" | sane_grep " .* ") > /dev/null
688 if test -z "$force_rebase"
690 # Lazily switch to the target branch if needed...
691 test -z "$switch_to" ||
692 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to" \
693 git checkout -q "$switch_to" --
694 if test "$branch_name" = "HEAD" &&
695 ! git symbolic-ref -q HEAD
697 say "$(eval_gettext "HEAD is up to date.")"
699 say "$(eval_gettext "Current branch \$branch_name is up to date.")"
704 if test "$branch_name" = "HEAD" &&
705 ! git symbolic-ref -q HEAD
707 say "$(eval_gettext "HEAD is up to date, rebase forced.")"
709 say "$(eval_gettext "Current branch \$branch_name is up to date, rebase forced.")"
714 # If a hook exists, give it a chance to interrupt
715 run_pre_rebase_hook "$upstream_arg" "$@"
717 if test -n "$diffstat"
719 if test -n "$verbose"
723 echo "$(eval_gettext "Changes to \$onto:")"
725 echo "$(eval_gettext "Changes from \$mb to \$onto:")"
728 mb_tree="${mb:-$(git hash-object -t tree /dev/null)}"
729 # We want color (if set), but no pager
730 GIT_PAGER='' git diff --stat --summary "$mb_tree" "$onto"
733 test -n "$interactive_rebase" && run_specific_rebase
735 # Detach HEAD and reset the tree
736 say "$(gettext "First, rewinding head to replay your work on top of it...")"
738 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name" \
739 git checkout -q "$onto^0" || die "could not detach HEAD"
740 git update-ref ORIG_HEAD $orig_head
742 # If the $onto is a proper descendant of the tip of the branch, then
743 # we just fast-forwarded.
744 if test "$mb" = "$orig_head"
746 say "$(eval_gettext "Fast-forwarded \$branch_name to \$onto_name.")"
747 move_to_original_branch
752 if test -n "$rebase_root"
754 revisions="$onto..$orig_head"
756 revisions="${restrict_revision-$upstream}..$orig_head"