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 GIT_QUIET
=$
(cat "$state_dir"/quiet
) &&
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
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"
228 if test -d "$merge_dir"/rewritten
231 interactive_rebase
=explicit
233 elif test -f "$merge_dir"/interactive
236 interactive_rebase
=explicit
240 state_dir
="$merge_dir"
242 test -n "$type" && in_progress
=t
249 ok_to_skip_pre_rebase
=yes
252 ok_to_skip_pre_rebase
=
254 --continue|
--skip|
--abort|
--quit|
--edit-todo|
--show-current-patch)
255 test $total_argc -eq 2 || usage
262 cmd
="${cmd}exec ${1#--exec=}${LF}"
263 test -z "$interactive_rebase" && interactive_rebase
=implied
266 interactive_rebase
=explicit
271 --allow-empty-message)
272 allow_empty_message
=--allow-empty-message
279 test -z "$interactive_rebase" && interactive_rebase
=implied
284 rebase-cousins
) rebase_cousins
=t
;;
285 no-rebase-cousins
) rebase_cousins
=;;
286 *) die
"Unknown mode: $1";;
288 test -z "$interactive_rebase" && interactive_rebase
=implied
292 test -z "$interactive_rebase" && interactive_rebase
=implied
310 strategy_opts
="$strategy_opts $(git rev-parse --sq-quote "--${1#--strategy-option=}" | sed -e s/^.//)"
312 test -z "$strategy" && strategy
=recursive
315 strategy
="${1#--strategy=}"
337 git_am_opt
="$git_am_opt -q"
342 git_am_opt
="$git_am_opt --whitespace=${1#--whitespace=}"
343 case "${1#--whitespace=}" in
347 warn|nowarn|error|error-all
)
348 ;; # okay, known whitespace option
350 die
"fatal: Invalid whitespace option: '${1#*=}'"
355 git_am_opt
="$git_am_opt $1"
363 --committer-date-is-author-date|
--ignore-date)
364 git_am_opt
="$git_am_opt $1"
368 die
"fatal: switch \`C' expects a numerical value"
371 git_am_opt
="$git_am_opt $1"
376 --force-rebase|
--no-ff)
379 --rerere-autoupdate|
--no-rerere-autoupdate)
380 allow_rerere_autoupdate
="$1"
386 gpg_sign_opt
="-S${1#--gpg-sign=}"
388 --reschedule-failed-exec)
389 reschedule_failed_exec
=--reschedule-failed-exec
391 --no-reschedule-failed-exec)
392 reschedule_failed_exec
=
404 test $# -gt 2 && usage
408 test -z "$in_progress" && die
"$(gettext "No rebase
in progress?
")"
409 # Only interactive rebase uses detailed reflog messages
410 if test -n "$interactive_rebase" && test "$GIT_REFLOG_ACTION" = rebase
412 GIT_REFLOG_ACTION
="rebase -i ($action)"
413 export GIT_REFLOG_ACTION
417 if test "$action" = "edit-todo" && test -z "$interactive_rebase"
419 die
"$(gettext "The
--edit-todo action can only be used during interactive rebase.
")"
425 git rev-parse
--verify HEAD
>/dev
/null ||
426 die
"$(gettext "Cannot
read HEAD
")"
427 git update-index
--ignore-submodules --refresh &&
428 git diff-files
--quiet --ignore-submodules ||
{
429 echo "$(gettext "You must edit all merge conflicts and
then
430 mark them as resolved using git add
")"
437 output git
reset --hard HEAD ||
exit $?
446 git symbolic-ref
-m "rebase: aborting" HEAD
$head_name ||
447 die
"$(eval_gettext "Could not move back to \
$head_name")"
450 output git
reset --hard $orig_head
455 exec rm -rf "$state_dir"
462 die
"BUG: run_specific_rebase is not supposed to return here"
466 # Make sure no rebase is in progress
467 if test -n "$in_progress"
469 state_dir_base
=${state_dir##*/}
470 cmd_live_rebase
="git rebase (--continue | --abort | --skip)"
471 cmd_clear_stale_rebase
="rm -fr \"$state_dir\""
473 $(eval_gettext 'It seems that there is already a $state_dir_base directory, and
474 I wonder if you are in the middle of another rebase. If that is the
477 If that is not the case, please
478 $cmd_clear_stale_rebase
479 and run me again. I am stopping in case you still have something
483 if test -n "$rebase_root" && test -z "$onto"
485 test -z "$interactive_rebase" && interactive_rebase
=implied
488 if test -n "$keep_empty"
490 test -z "$interactive_rebase" && interactive_rebase
=implied
493 if test -n "$interactive_rebase"
495 if test -z "$preserve_merges"
502 state_dir
="$merge_dir"
503 elif test -n "$do_merge"
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 if test -n "$git_am_opt"; then
518 incompatible_opts
=$
(echo " $git_am_opt " | \
519 sed -e 's/ -q / /g' -e 's/^ \(.*\) $/\1/')
520 if test -n "$interactive_rebase"
522 if test -n "$incompatible_opts"
524 die
"$(gettext "error
: cannot combine interactive options
(--interactive, --exec, --rebase-merges, --preserve-merges, --keep-empty, --root + --onto) with am options
($incompatible_opts)")"
527 if test -n "$do_merge"; then
528 if test -n "$incompatible_opts"
530 die
"$(gettext "error
: cannot combine merge options
(--merge, --strategy, --strategy-option) with am options
($incompatible_opts)")"
535 if test -n "$signoff"
537 test -n "$preserve_merges" &&
538 die
"$(gettext "error
: cannot combine
'--signoff' with
'--preserve-merges'")"
539 git_am_opt
="$git_am_opt $signoff"
543 if test -n "$preserve_merges"
545 # Note: incompatibility with --signoff handled in signoff block above
546 # Note: incompatibility with --interactive is just a strong warning;
547 # git-rebase.txt caveats with "unless you know what you are doing"
548 test -n "$rebase_merges" &&
549 die
"$(gettext "error
: cannot combine
'--preserve-merges' with
'--rebase-merges'")"
551 test -n "$reschedule_failed_exec" &&
552 die
"$(gettext "error
: cannot combine
'--preserve-merges' with
'--reschedule-failed-exec'")"
555 if test -n "$rebase_merges"
557 test -n "$strategy_opts" &&
558 die
"$(gettext "error
: cannot combine
'--rebase-merges' with
'--strategy-option'")"
559 test -n "$strategy" &&
560 die
"$(gettext "error
: cannot combine
'--rebase-merges' with
'--strategy'")"
563 if test -z "$rebase_root"
567 if ! upstream_name
=$
(git rev-parse
--symbolic-full-name \
568 --verify -q @
{upstream
} 2>/dev
/null
)
571 error_on_missing_default_upstream
"rebase" "rebase" \
572 "against" "git rebase $(gettext '<branch>')"
575 test "$fork_point" = auto
&& fork_point
=t
577 *) upstream_name
="$1"
578 if test "$upstream_name" = "-"
580 upstream_name
="@{-1}"
585 upstream
=$
(peel_committish
"${upstream_name}") ||
586 die
"$(eval_gettext "invalid upstream
'\$upstream_name'")"
587 upstream_arg
="$upstream_name"
591 empty_tree
=$
(git hash-object
-t tree
/dev
/null
)
592 onto
=$
(git commit-tree
$empty_tree </dev
/null
)
597 test $# -gt 1 && usage
601 # Make sure the branch to rebase onto is valid.
602 onto_name
=${onto-"$upstream_name"}
605 if left
=${onto_name%...*} right
=${onto_name#*...} &&
606 onto
=$
(git merge-base
--all ${left:-HEAD} ${right:-HEAD})
610 die
"$(eval_gettext "\
$onto_name: there are
more than one merge bases
")"
613 die
"$(eval_gettext "\
$onto_name: there is no merge base
")"
617 die
"$(eval_gettext "\
$onto_name: there is no merge base
")"
621 onto
=$
(peel_committish
"$onto_name") ||
622 die
"$(eval_gettext "Does not point to a valid commit
: \
$onto_name")"
626 # If the branch to rebase is given, that is the branch we will rebase
627 # $branch_name -- branch/commit being rebased, or HEAD (already detached)
628 # $orig_head -- commit object name of tip of the branch before rebasing
629 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
633 # Is it "rebase other $branchname" or "rebase other $commit"?
637 # Is it a local branch?
638 if git show-ref
--verify --quiet -- "refs/heads/$branch_name" &&
639 orig_head
=$
(git rev-parse
-q --verify "refs/heads/$branch_name")
641 head_name
="refs/heads/$branch_name"
642 # If not is it a valid ref (branch or commit)?
643 elif orig_head
=$
(git rev-parse
-q --verify "$branch_name")
645 head_name
="detached HEAD"
648 die
"$(eval_gettext "fatal
: no such branch
/commit
'\$branch_name'")"
652 # Do not need to switch branches, we are already on it.
653 if branch_name
=$
(git symbolic-ref
-q HEAD
)
655 head_name
=$branch_name
656 branch_name
=$
(expr "z$branch_name" : 'zrefs/heads/\(.*\)')
658 head_name
="detached HEAD"
661 orig_head
=$
(git rev-parse
--verify HEAD
) ||
exit
664 die
"BUG: unexpected number of arguments left to parse"
668 if test "$fork_point" = t
670 new_upstream
=$
(git merge-base
--fork-point "$upstream_name" \
671 "${switch_to:-HEAD}")
672 if test -n "$new_upstream"
674 restrict_revision
=$new_upstream
678 if test "$autostash" = true
&& ! (require_clean_work_tree
) 2>/dev
/null
680 stash_sha1
=$
(git stash create
"autostash") ||
681 die
"$(gettext 'Cannot autostash')"
683 mkdir
-p "$state_dir" &&
684 echo $stash_sha1 >"$state_dir/autostash" &&
685 stash_abbrev
=$
(git rev-parse
--short $stash_sha1) &&
686 echo "$(eval_gettext 'Created autostash: $stash_abbrev')" &&
690 require_clean_work_tree
"rebase" "$(gettext "Please commit or stash them.
")"
692 # Now we are rebasing commits $upstream..$orig_head (or with --root,
693 # everything leading up to $orig_head) on top of $onto
695 # Check if we are already based on $onto with linear history,
696 # but this should be done only when upstream and onto are the same
697 # and if this is not an interactive rebase.
698 mb
=$
(git merge-base
"$onto" "$orig_head")
699 if test -z "$interactive_rebase" && test "$upstream" = "$onto" &&
700 test "$mb" = "$onto" && test -z "$restrict_revision" &&
702 ! (git rev-list
--parents "$onto"..
"$orig_head" | sane_grep
" .* ") > /dev
/null
704 if test -z "$force_rebase"
706 # Lazily switch to the target branch if needed...
707 test -z "$switch_to" ||
708 GIT_REFLOG_ACTION
="$GIT_REFLOG_ACTION: checkout $switch_to" \
709 git checkout
-q "$switch_to" --
710 if test "$branch_name" = "HEAD" &&
711 ! git symbolic-ref
-q HEAD
713 say
"$(eval_gettext "HEAD is up to
date.
")"
715 say
"$(eval_gettext "Current branch \
$branch_name is up to
date.
")"
720 if test "$branch_name" = "HEAD" &&
721 ! git symbolic-ref
-q HEAD
723 say
"$(eval_gettext "HEAD is up to
date, rebase forced.
")"
725 say
"$(eval_gettext "Current branch \
$branch_name is up to
date, rebase forced.
")"
730 # If a hook exists, give it a chance to interrupt
731 run_pre_rebase_hook
"$upstream_arg" "$@"
733 if test -n "$diffstat"
735 if test -n "$verbose"
739 echo "$(eval_gettext "Changes to \
$onto:")"
741 echo "$(eval_gettext "Changes from \
$mb to \
$onto:")"
744 mb_tree
="${mb:-$(git hash-object -t tree /dev/null)}"
745 # We want color (if set), but no pager
746 GIT_PAGER
='' git
diff --stat --summary "$mb_tree" "$onto"
749 test -n "$interactive_rebase" && run_specific_rebase
751 # Detach HEAD and reset the tree
752 say
"$(gettext "First
, rewinding
head to replay your work on top of it...
")"
754 GIT_REFLOG_ACTION
="$GIT_REFLOG_ACTION: checkout $onto_name" \
755 git checkout
-q "$onto^0" || die
"could not detach HEAD"
756 git update-ref ORIG_HEAD
$orig_head
758 # If the $onto is a proper descendant of the tip of the branch, then
759 # we just fast-forwarded.
760 if test "$mb" = "$orig_head"
762 say
"$(eval_gettext "Fast-forwarded \
$branch_name to \
$onto_name.
")"
763 move_to_original_branch
768 if test -n "$rebase_root"
770 revisions
="$onto..$orig_head"
772 revisions
="${restrict_revision-$upstream}..$orig_head"