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 p,preserve-merges! try to recreate merges instead of ignoring them
21 s,strategy=! use the given merge strategy
22 no-ff! cherry-pick all commits, even if unchanged
23 m,merge! use merging strategies to rebase
24 i,interactive! let the user edit the list of commits to rebase
25 x,exec=! add exec lines after each commit of the editable list
26 k,keep-empty preserve empty commits during rebase
27 f,force-rebase! force rebase even if branch is up to date
28 X,strategy-option=! pass the argument through to the merge strategy
29 stat! display a diffstat of what changed upstream
30 n,no-stat! do not show diffstat of what changed upstream
31 verify allow pre-rebase hook to run
32 rerere-autoupdate allow rerere to update index with resolved conflicts
33 root! rebase all reachable commits up to the root(s)
34 autosquash move commits that begin with squash!/fixup! under -i
35 committer-date-is-author-date! passed to 'git am'
36 ignore-date! passed to 'git am'
37 signoff passed to 'git am'
38 whitespace=! passed to 'git apply'
39 ignore-whitespace! passed to 'git apply'
40 C=! passed to 'git apply'
41 S,gpg-sign? GPG-sign commits
44 abort! abort and check out the original branch
45 skip! skip current patch and continue
46 edit-todo! edit the todo list during an interactive rebase
47 quit! abort but keep HEAD where it is
50 set_reflog_action rebase
51 require_work_tree_exists
56 ok_to_skip_pre_rebase
=
58 $(gettext 'Resolve all conflicts manually, mark them as resolved with
59 "git add
/rm <conflicted_files
>", then run "git rebase
--continue".
60 You can instead skip this commit: run "git rebase
--skip".
61 To abort and get back to the state before "git rebase
", run "git rebase
--abort".')
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
94 test "$(git config --bool rebase.autosquash)" = "true" && autosquash
=t
95 case "$(git config --bool commit.gpgsign)" in
96 true
) gpg_sign_opt
=-S ;;
100 read_basic_state
() {
101 test -f "$state_dir/head-name" &&
102 test -f "$state_dir/onto" &&
103 head_name
=$
(cat "$state_dir"/head-name
) &&
104 onto
=$
(cat "$state_dir"/onto
) &&
105 # We always write to orig-head, but interactive rebase used to write to
106 # head. Fall back to reading from head to cover for the case that the
107 # user upgraded git with an ongoing interactive rebase.
108 if test -f "$state_dir"/orig-head
110 orig_head
=$
(cat "$state_dir"/orig-head
)
112 orig_head
=$
(cat "$state_dir"/head)
114 GIT_QUIET
=$
(cat "$state_dir"/quiet
) &&
115 test -f "$state_dir"/verbose
&& verbose
=t
116 test -f "$state_dir"/strategy
&& strategy
="$(cat "$state_dir"/strategy)"
117 test -f "$state_dir"/strategy_opts
&&
118 strategy_opts
="$(cat "$state_dir"/strategy_opts)"
119 test -f "$state_dir"/allow_rerere_autoupdate
&&
120 allow_rerere_autoupdate
="$(cat "$state_dir"/allow_rerere_autoupdate)"
121 test -f "$state_dir"/gpg_sign_opt
&&
122 gpg_sign_opt
="$(cat "$state_dir"/gpg_sign_opt)"
123 test -f "$state_dir"/signoff
&& {
124 signoff
="$(cat "$state_dir"/signoff)"
129 write_basic_state
() {
130 echo "$head_name" > "$state_dir"/head-name
&&
131 echo "$onto" > "$state_dir"/onto
&&
132 echo "$orig_head" > "$state_dir"/orig-head
&&
133 echo "$GIT_QUIET" > "$state_dir"/quiet
&&
134 test t
= "$verbose" && : > "$state_dir"/verbose
135 test -n "$strategy" && echo "$strategy" > "$state_dir"/strategy
136 test -n "$strategy_opts" && echo "$strategy_opts" > \
137 "$state_dir"/strategy_opts
138 test -n "$allow_rerere_autoupdate" && echo "$allow_rerere_autoupdate" > \
139 "$state_dir"/allow_rerere_autoupdate
140 test -n "$gpg_sign_opt" && echo "$gpg_sign_opt" > "$state_dir"/gpg_sign_opt
141 test -n "$signoff" && echo "$signoff" >"$state_dir"/signoff
149 test $status != 0 && printf "%s\n" "$output"
158 move_to_original_branch
() {
161 message
="rebase finished: $head_name onto $onto"
162 git update-ref
-m "$message" \
163 $head_name $
(git rev-parse HEAD
) $orig_head &&
165 -m "rebase finished: returning to $head_name" \
167 die
"$(eval_gettext "Could not move back to \
$head_name")"
173 if test -f "$state_dir/autostash"
175 stash_sha1
=$
(cat "$state_dir/autostash")
176 if git stash apply
$stash_sha1 >/dev
/null
2>&1
178 echo "$(gettext 'Applied autostash.')" >&2
180 git stash store
-m "autostash" -q $stash_sha1 ||
181 die
"$(eval_gettext "Cannot store \
$stash_sha1")"
182 gettext 'Applying autostash resulted in conflicts.
183 Your changes are safe in the stash.
184 You can run "git stash pop" or "git stash drop" at any time.
192 { git gc
--auto || true
; } &&
196 run_specific_rebase
() {
197 if [ "$interactive_rebase" = implied
]; then
207 elif test $ret -eq 2 # special exit status for rebase -i
210 rm -rf "$state_dir" &&
216 run_pre_rebase_hook
() {
217 if test -z "$ok_to_skip_pre_rebase" &&
218 test -x "$(git rev-parse --git-path hooks/pre-rebase)"
220 "$(git rev-parse --git-path hooks/pre-rebase)" ${1+"$@"} ||
221 die
"$(gettext "The pre-rebase hook refused to rebase.
")"
225 test -f "$apply_dir"/applying
&&
226 die
"$(gettext "It looks like
'git am' is
in progress. Cannot rebase.
")"
228 if test -d "$apply_dir"
231 state_dir
="$apply_dir"
232 elif test -d "$merge_dir"
234 if test -f "$merge_dir"/interactive
237 interactive_rebase
=explicit
241 state_dir
="$merge_dir"
243 test -n "$type" && in_progress
=t
250 ok_to_skip_pre_rebase
=yes
253 ok_to_skip_pre_rebase
=
255 --continue|
--skip|
--abort|
--quit|
--edit-todo)
256 test $total_argc -eq 2 || usage
263 cmd
="${cmd}exec ${1#--exec=}${LF}"
264 test -z "$interactive_rebase" && interactive_rebase
=implied
267 interactive_rebase
=explicit
277 test -z "$interactive_rebase" && interactive_rebase
=implied
295 strategy_opts
="$strategy_opts $(git rev-parse --sq-quote "--${1#--strategy-option=}")"
297 test -z "$strategy" && strategy
=recursive
300 strategy
="${1#--strategy=}"
322 git_am_opt
="$git_am_opt -q"
327 git_am_opt
="$git_am_opt --whitespace=${1#--whitespace=}"
328 case "${1#--whitespace=}" in
335 git_am_opt
="$git_am_opt $1"
343 --committer-date-is-author-date|
--ignore-date)
344 git_am_opt
="$git_am_opt $1"
348 git_am_opt
="$git_am_opt $1"
353 --force-rebase|
--no-ff)
356 --rerere-autoupdate|
--no-rerere-autoupdate)
357 allow_rerere_autoupdate
="$1"
363 gpg_sign_opt
="-S${1#--gpg-sign=}"
375 test $# -gt 2 && usage
379 test -z "$in_progress" && die
"$(gettext "No rebase
in progress?
")"
380 # Only interactive rebase uses detailed reflog messages
381 if test "$type" = interactive
&& test "$GIT_REFLOG_ACTION" = rebase
383 GIT_REFLOG_ACTION
="rebase -i ($action)"
384 export GIT_REFLOG_ACTION
388 if test "$action" = "edit-todo" && test "$type" != "interactive"
390 die
"$(gettext "The
--edit-todo action can only be used during interactive rebase.
")"
396 git rev-parse
--verify HEAD
>/dev
/null ||
397 die
"$(gettext "Cannot
read HEAD
")"
398 git update-index
--ignore-submodules --refresh &&
399 git diff-files
--quiet --ignore-submodules ||
{
400 echo "$(gettext "You must edit all merge conflicts and
then
401 mark them as resolved using git add
")"
408 output git
reset --hard HEAD ||
exit $?
417 git symbolic-ref
-m "rebase: aborting" HEAD
$head_name ||
418 die
"$(eval_gettext "Could not move back to \
$head_name")"
421 output git
reset --hard $orig_head
426 exec rm -rf "$state_dir"
433 # Make sure no rebase is in progress
434 if test -n "$in_progress"
436 state_dir_base
=${state_dir##*/}
437 cmd_live_rebase
="git rebase (--continue | --abort | --skip)"
438 cmd_clear_stale_rebase
="rm -fr \"$state_dir\""
440 $(eval_gettext 'It seems that there is already a $state_dir_base directory, and
441 I wonder if you are in the middle of another rebase. If that is the
444 If that is not the case, please
445 $cmd_clear_stale_rebase
446 and run me again. I am stopping in case you still have something
450 if test -n "$rebase_root" && test -z "$onto"
452 test -z "$interactive_rebase" && interactive_rebase
=implied
455 if test -n "$interactive_rebase"
458 state_dir
="$merge_dir"
459 elif test -n "$do_merge"
462 state_dir
="$merge_dir"
465 state_dir
="$apply_dir"
468 if test -t 2 && test -z "$GIT_QUIET"
470 git_format_patch_opt
="$git_format_patch_opt --progress"
473 if test -n "$signoff"
475 git_am_opt
="$git_am_opt $signoff"
479 if test -z "$rebase_root"
483 if ! upstream_name
=$
(git rev-parse
--symbolic-full-name \
484 --verify -q @
{upstream
} 2>/dev
/null
)
487 error_on_missing_default_upstream
"rebase" "rebase" \
488 "against" "git rebase $(gettext '<branch>')"
491 test "$fork_point" = auto
&& fork_point
=t
493 *) upstream_name
="$1"
494 if test "$upstream_name" = "-"
496 upstream_name
="@{-1}"
501 upstream
=$
(peel_committish
"${upstream_name}") ||
502 die
"$(eval_gettext "invalid upstream
'\$upstream_name'")"
503 upstream_arg
="$upstream_name"
507 empty_tree
=$
(git hash-object
-t tree
/dev
/null
)
508 onto
=$
(git commit-tree
$empty_tree </dev
/null
)
513 test $# -gt 1 && usage
517 # Make sure the branch to rebase onto is valid.
518 onto_name
=${onto-"$upstream_name"}
521 if left
=${onto_name%...*} right
=${onto_name#*...} &&
522 onto
=$
(git merge-base
--all ${left:-HEAD} ${right:-HEAD})
526 die
"$(eval_gettext "\
$onto_name: there are
more than one merge bases
")"
529 die
"$(eval_gettext "\
$onto_name: there is no merge base
")"
533 die
"$(eval_gettext "\
$onto_name: there is no merge base
")"
537 onto
=$
(peel_committish
"$onto_name") ||
538 die
"$(eval_gettext "Does not point to a valid commit
: \
$onto_name")"
542 # If the branch to rebase is given, that is the branch we will rebase
543 # $branch_name -- branch/commit being rebased, or HEAD (already detached)
544 # $orig_head -- commit object name of tip of the branch before rebasing
545 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
549 # Is it "rebase other $branchname" or "rebase other $commit"?
553 # Is it a local branch?
554 if git show-ref
--verify --quiet -- "refs/heads/$branch_name" &&
555 orig_head
=$
(git rev-parse
-q --verify "refs/heads/$branch_name")
557 head_name
="refs/heads/$branch_name"
558 # If not is it a valid ref (branch or commit)?
559 elif orig_head
=$
(git rev-parse
-q --verify "$branch_name")
561 head_name
="detached HEAD"
564 die
"$(eval_gettext "fatal
: no such branch
/commit
'\$branch_name'")"
568 # Do not need to switch branches, we are already on it.
569 if branch_name
=$
(git symbolic-ref
-q HEAD
)
571 head_name
=$branch_name
572 branch_name
=$
(expr "z$branch_name" : 'zrefs/heads/\(.*\)')
574 head_name
="detached HEAD"
577 orig_head
=$
(git rev-parse
--verify HEAD
) ||
exit
580 die
"BUG: unexpected number of arguments left to parse"
584 if test "$fork_point" = t
586 new_upstream
=$
(git merge-base
--fork-point "$upstream_name" \
587 "${switch_to:-HEAD}")
588 if test -n "$new_upstream"
590 restrict_revision
=$new_upstream
594 if test "$autostash" = true
&& ! (require_clean_work_tree
) 2>/dev
/null
596 stash_sha1
=$
(git stash create
"autostash") ||
597 die
"$(gettext 'Cannot autostash')"
599 mkdir
-p "$state_dir" &&
600 echo $stash_sha1 >"$state_dir/autostash" &&
601 stash_abbrev
=$
(git rev-parse
--short $stash_sha1) &&
602 echo "$(eval_gettext 'Created autostash: $stash_abbrev')" &&
606 require_clean_work_tree
"rebase" "$(gettext "Please commit or stash them.
")"
608 # Now we are rebasing commits $upstream..$orig_head (or with --root,
609 # everything leading up to $orig_head) on top of $onto
611 # Check if we are already based on $onto with linear history,
612 # but this should be done only when upstream and onto are the same
613 # and if this is not an interactive rebase.
614 mb
=$
(git merge-base
"$onto" "$orig_head")
615 if test "$type" != interactive
&& test "$upstream" = "$onto" &&
616 test "$mb" = "$onto" && test -z "$restrict_revision" &&
618 ! (git rev-list
--parents "$onto"..
"$orig_head" | sane_grep
" .* ") > /dev
/null
620 if test -z "$force_rebase"
622 # Lazily switch to the target branch if needed...
623 test -z "$switch_to" ||
624 GIT_REFLOG_ACTION
="$GIT_REFLOG_ACTION: checkout $switch_to" \
625 git checkout
-q "$switch_to" --
626 if test "$branch_name" = "HEAD" &&
627 ! git symbolic-ref
-q HEAD
629 say
"$(eval_gettext "HEAD is up to
date.
")"
631 say
"$(eval_gettext "Current branch \
$branch_name is up to
date.
")"
636 if test "$branch_name" = "HEAD" &&
637 ! git symbolic-ref
-q HEAD
639 say
"$(eval_gettext "HEAD is up to
date, rebase forced.
")"
641 say
"$(eval_gettext "Current branch \
$branch_name is up to
date, rebase forced.
")"
646 # If a hook exists, give it a chance to interrupt
647 run_pre_rebase_hook
"$upstream_arg" "$@"
649 if test -n "$diffstat"
651 if test -n "$verbose"
653 echo "$(eval_gettext "Changes from \
$mb to \
$onto:")"
655 # We want color (if set), but no pager
656 GIT_PAGER
='' git
diff --stat --summary "$mb" "$onto"
659 test "$type" = interactive
&& run_specific_rebase
661 # Detach HEAD and reset the tree
662 say
"$(gettext "First
, rewinding
head to replay your work on top of it...
")"
664 GIT_REFLOG_ACTION
="$GIT_REFLOG_ACTION: checkout $onto_name" \
665 git checkout
-q "$onto^0" || die
"could not detach HEAD"
666 git update-ref ORIG_HEAD
$orig_head
668 # If the $onto is a proper descendant of the tip of the branch, then
669 # we just fast-forwarded.
670 if test "$mb" = "$orig_head"
672 say
"$(eval_gettext "Fast-forwarded \
$branch_name to \
$onto_name.
")"
673 move_to_original_branch
678 if test -n "$rebase_root"
680 revisions
="$onto..$orig_head"
682 revisions
="${restrict_revision-$upstream}..$orig_head"