rebase -p: error out if --signoff is given
[alt-git.git] / git-rebase.sh
blobe65b65acb424c4923a317992ef300323c6b20d48
1 #!/bin/sh
3 # Copyright (c) 2005 Junio C Hamano.
6 SUBDIRECTORY_OK=Yes
7 OPTIONS_KEEPDASHDASH=
8 OPTIONS_STUCKLONG=t
9 OPTIONS_SPEC="\
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
14 Available options are
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
42 Actions:
43 continue! continue
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
49 . git-sh-setup
50 set_reflog_action rebase
51 require_work_tree_exists
52 cd_to_toplevel
54 LF='
56 ok_to_skip_pre_rebase=
57 resolvemsg="
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".')
63 squash_onto=
64 unset onto
65 unset restrict_revision
66 cmd=
67 strategy=
68 strategy_opts=
69 do_merge=
70 merge_dir="$GIT_DIR"/rebase-merge
71 apply_dir="$GIT_DIR"/rebase-apply
72 verbose=
73 diffstat=
74 test "$(git config --bool rebase.stat)" = true && diffstat=t
75 autostash="$(git config --bool rebase.autostash || echo false)"
76 fork_point=auto
77 git_am_opt=
78 git_format_patch_opt=
79 rebase_root=
80 force_rebase=
81 allow_rerere_autoupdate=
82 # Non-empty if a rebase was in progress when 'git rebase' was invoked
83 in_progress=
84 # One of {am, merge, interactive}
85 type=
86 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
87 state_dir=
88 # One of {'', continue, skip, abort}, as parsed from command line
89 action=
90 preserve_merges=
91 autosquash=
92 keep_empty=
93 signoff=
94 test "$(git config --bool rebase.autosquash)" = "true" && autosquash=t
95 case "$(git config --bool commit.gpgsign)" in
96 true) gpg_sign_opt=-S ;;
97 *) gpg_sign_opt= ;;
98 esac
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
109 then
110 orig_head=$(cat "$state_dir"/orig-head)
111 else
112 orig_head=$(cat "$state_dir"/head)
113 fi &&
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)"
125 force_rebase=t
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
144 output () {
145 case "$verbose" in
147 output=$("$@" 2>&1 )
148 status=$?
149 test $status != 0 && printf "%s\n" "$output"
150 return $status
153 "$@"
155 esac
158 move_to_original_branch () {
159 case "$head_name" in
160 refs/*)
161 message="rebase finished: $head_name onto $onto"
162 git update-ref -m "$message" \
163 $head_name $(git rev-parse HEAD) $orig_head &&
164 git symbolic-ref \
165 -m "rebase finished: returning to $head_name" \
166 HEAD $head_name ||
167 die "$(eval_gettext "Could not move back to \$head_name")"
169 esac
172 apply_autostash () {
173 if test -f "$state_dir/autostash"
174 then
175 stash_sha1=$(cat "$state_dir/autostash")
176 if git stash apply $stash_sha1 >/dev/null 2>&1
177 then
178 echo "$(gettext 'Applied autostash.')" >&2
179 else
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.
185 ' >&2
190 finish_rebase () {
191 apply_autostash &&
192 { git gc --auto || true; } &&
193 rm -rf "$state_dir"
196 run_specific_rebase () {
197 if [ "$interactive_rebase" = implied ]; then
198 GIT_EDITOR=:
199 export GIT_EDITOR
200 autosquash=
202 . git-rebase--$type
203 ret=$?
204 if test $ret -eq 0
205 then
206 finish_rebase
207 elif test $ret -eq 2 # special exit status for rebase -i
208 then
209 apply_autostash &&
210 rm -rf "$state_dir" &&
211 die "Nothing to do"
213 exit $ret
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)"
219 then
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"
229 then
230 type=am
231 state_dir="$apply_dir"
232 elif test -d "$merge_dir"
233 then
234 if test -f "$merge_dir"/interactive
235 then
236 type=interactive
237 interactive_rebase=explicit
238 else
239 type=merge
241 state_dir="$merge_dir"
243 test -n "$type" && in_progress=t
245 total_argc=$#
246 while test $# != 0
248 case "$1" in
249 --no-verify)
250 ok_to_skip_pre_rebase=yes
252 --verify)
253 ok_to_skip_pre_rebase=
255 --continue|--skip|--abort|--quit|--edit-todo)
256 test $total_argc -eq 2 || usage
257 action=${1##--}
259 --onto=*)
260 onto="${1#--onto=}"
262 --exec=*)
263 cmd="${cmd}exec ${1#--exec=}${LF}"
264 test -z "$interactive_rebase" && interactive_rebase=implied
266 --interactive)
267 interactive_rebase=explicit
269 --keep-empty)
270 keep_empty=yes
272 --no-keep-empty)
273 keep_empty=
275 --preserve-merges)
276 preserve_merges=t
277 test -z "$interactive_rebase" && interactive_rebase=implied
279 --autosquash)
280 autosquash=t
282 --no-autosquash)
283 autosquash=
285 --fork-point)
286 fork_point=t
288 --no-fork-point)
289 fork_point=
291 --merge)
292 do_merge=t
294 --strategy-option=*)
295 strategy_opts="$strategy_opts $(git rev-parse --sq-quote "--${1#--strategy-option=}")"
296 do_merge=t
297 test -z "$strategy" && strategy=recursive
299 --strategy=*)
300 strategy="${1#--strategy=}"
301 do_merge=t
303 --no-stat)
304 diffstat=
306 --stat)
307 diffstat=t
309 --autostash)
310 autostash=true
312 --no-autostash)
313 autostash=false
315 --verbose)
316 verbose=t
317 diffstat=t
318 GIT_QUIET=
320 --quiet)
321 GIT_QUIET=t
322 git_am_opt="$git_am_opt -q"
323 verbose=
324 diffstat=
326 --whitespace=*)
327 git_am_opt="$git_am_opt --whitespace=${1#--whitespace=}"
328 case "${1#--whitespace=}" in
329 fix|strip)
330 force_rebase=t
332 esac
334 --ignore-whitespace)
335 git_am_opt="$git_am_opt $1"
337 --signoff)
338 signoff=--signoff
340 --no-signoff)
341 signoff=
343 --committer-date-is-author-date|--ignore-date)
344 git_am_opt="$git_am_opt $1"
345 force_rebase=t
347 -C*)
348 git_am_opt="$git_am_opt $1"
350 --root)
351 rebase_root=t
353 --force-rebase|--no-ff)
354 force_rebase=t
356 --rerere-autoupdate|--no-rerere-autoupdate)
357 allow_rerere_autoupdate="$1"
359 --gpg-sign)
360 gpg_sign_opt=-S
362 --gpg-sign=*)
363 gpg_sign_opt="-S${1#--gpg-sign=}"
366 shift
367 break
370 usage
372 esac
373 shift
374 done
375 test $# -gt 2 && usage
377 if test -n "$action"
378 then
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
382 then
383 GIT_REFLOG_ACTION="rebase -i ($action)"
384 export GIT_REFLOG_ACTION
388 if test "$action" = "edit-todo" && test "$type" != "interactive"
389 then
390 die "$(gettext "The --edit-todo action can only be used during interactive rebase.")"
393 case "$action" in
394 continue)
395 # Sanity check
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")"
402 exit 1
404 read_basic_state
405 run_specific_rebase
407 skip)
408 output git reset --hard HEAD || exit $?
409 read_basic_state
410 run_specific_rebase
412 abort)
413 git rerere clear
414 read_basic_state
415 case "$head_name" in
416 refs/*)
417 git symbolic-ref -m "rebase: aborting" HEAD $head_name ||
418 die "$(eval_gettext "Could not move back to \$head_name")"
420 esac
421 output git reset --hard $orig_head
422 finish_rebase
423 exit
425 quit)
426 exec rm -rf "$state_dir"
428 edit-todo)
429 run_specific_rebase
431 esac
433 # Make sure no rebase is in progress
434 if test -n "$in_progress"
435 then
436 state_dir_base=${state_dir##*/}
437 cmd_live_rebase="git rebase (--continue | --abort | --skip)"
438 cmd_clear_stale_rebase="rm -fr \"$state_dir\""
439 die "
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
442 case, please try
443 $cmd_live_rebase
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
447 valuable there.')"
450 if test -n "$rebase_root" && test -z "$onto"
451 then
452 test -z "$interactive_rebase" && interactive_rebase=implied
455 if test -n "$interactive_rebase"
456 then
457 type=interactive
458 state_dir="$merge_dir"
459 elif test -n "$do_merge"
460 then
461 type=merge
462 state_dir="$merge_dir"
463 else
464 type=am
465 state_dir="$apply_dir"
468 if test -t 2 && test -z "$GIT_QUIET"
469 then
470 git_format_patch_opt="$git_format_patch_opt --progress"
473 if test -n "$signoff"
474 then
475 test -n "$preserve_merges" &&
476 die "$(gettext "error: cannot combine '--signoff' with '--preserve-merges'")"
477 git_am_opt="$git_am_opt $signoff"
478 force_rebase=t
481 if test -z "$rebase_root"
482 then
483 case "$#" in
485 if ! upstream_name=$(git rev-parse --symbolic-full-name \
486 --verify -q @{upstream} 2>/dev/null)
487 then
488 . git-parse-remote
489 error_on_missing_default_upstream "rebase" "rebase" \
490 "against" "git rebase $(gettext '<branch>')"
493 test "$fork_point" = auto && fork_point=t
495 *) upstream_name="$1"
496 if test "$upstream_name" = "-"
497 then
498 upstream_name="@{-1}"
500 shift
502 esac
503 upstream=$(peel_committish "${upstream_name}") ||
504 die "$(eval_gettext "invalid upstream '\$upstream_name'")"
505 upstream_arg="$upstream_name"
506 else
507 if test -z "$onto"
508 then
509 empty_tree=$(git hash-object -t tree /dev/null)
510 onto=$(git commit-tree $empty_tree </dev/null)
511 squash_onto="$onto"
513 unset upstream_name
514 unset upstream
515 test $# -gt 1 && usage
516 upstream_arg=--root
519 # Make sure the branch to rebase onto is valid.
520 onto_name=${onto-"$upstream_name"}
521 case "$onto_name" in
522 *...*)
523 if left=${onto_name%...*} right=${onto_name#*...} &&
524 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
525 then
526 case "$onto" in
527 ?*"$LF"?*)
528 die "$(eval_gettext "\$onto_name: there are more than one merge bases")"
531 die "$(eval_gettext "\$onto_name: there is no merge base")"
533 esac
534 else
535 die "$(eval_gettext "\$onto_name: there is no merge base")"
539 onto=$(peel_committish "$onto_name") ||
540 die "$(eval_gettext "Does not point to a valid commit: \$onto_name")"
542 esac
544 # If the branch to rebase is given, that is the branch we will rebase
545 # $branch_name -- branch/commit being rebased, or HEAD (already detached)
546 # $orig_head -- commit object name of tip of the branch before rebasing
547 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
548 switch_to=
549 case "$#" in
551 # Is it "rebase other $branchname" or "rebase other $commit"?
552 branch_name="$1"
553 switch_to="$1"
555 # Is it a local branch?
556 if git show-ref --verify --quiet -- "refs/heads/$branch_name" &&
557 orig_head=$(git rev-parse -q --verify "refs/heads/$branch_name")
558 then
559 head_name="refs/heads/$branch_name"
560 # If not is it a valid ref (branch or commit)?
561 elif orig_head=$(git rev-parse -q --verify "$branch_name")
562 then
563 head_name="detached HEAD"
565 else
566 die "$(eval_gettext "fatal: no such branch/commit '\$branch_name'")"
570 # Do not need to switch branches, we are already on it.
571 if branch_name=$(git symbolic-ref -q HEAD)
572 then
573 head_name=$branch_name
574 branch_name=$(expr "z$branch_name" : 'zrefs/heads/\(.*\)')
575 else
576 head_name="detached HEAD"
577 branch_name=HEAD
579 orig_head=$(git rev-parse --verify HEAD) || exit
582 die "BUG: unexpected number of arguments left to parse"
584 esac
586 if test "$fork_point" = t
587 then
588 new_upstream=$(git merge-base --fork-point "$upstream_name" \
589 "${switch_to:-HEAD}")
590 if test -n "$new_upstream"
591 then
592 restrict_revision=$new_upstream
596 if test "$autostash" = true && ! (require_clean_work_tree) 2>/dev/null
597 then
598 stash_sha1=$(git stash create "autostash") ||
599 die "$(gettext 'Cannot autostash')"
601 mkdir -p "$state_dir" &&
602 echo $stash_sha1 >"$state_dir/autostash" &&
603 stash_abbrev=$(git rev-parse --short $stash_sha1) &&
604 echo "$(eval_gettext 'Created autostash: $stash_abbrev')" &&
605 git reset --hard
608 require_clean_work_tree "rebase" "$(gettext "Please commit or stash them.")"
610 # Now we are rebasing commits $upstream..$orig_head (or with --root,
611 # everything leading up to $orig_head) on top of $onto
613 # Check if we are already based on $onto with linear history,
614 # but this should be done only when upstream and onto are the same
615 # and if this is not an interactive rebase.
616 mb=$(git merge-base "$onto" "$orig_head")
617 if test "$type" != interactive && test "$upstream" = "$onto" &&
618 test "$mb" = "$onto" && test -z "$restrict_revision" &&
619 # linear history?
620 ! (git rev-list --parents "$onto".."$orig_head" | sane_grep " .* ") > /dev/null
621 then
622 if test -z "$force_rebase"
623 then
624 # Lazily switch to the target branch if needed...
625 test -z "$switch_to" ||
626 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to" \
627 git checkout -q "$switch_to" --
628 if test "$branch_name" = "HEAD" &&
629 ! git symbolic-ref -q HEAD
630 then
631 say "$(eval_gettext "HEAD is up to date.")"
632 else
633 say "$(eval_gettext "Current branch \$branch_name is up to date.")"
635 finish_rebase
636 exit 0
637 else
638 if test "$branch_name" = "HEAD" &&
639 ! git symbolic-ref -q HEAD
640 then
641 say "$(eval_gettext "HEAD is up to date, rebase forced.")"
642 else
643 say "$(eval_gettext "Current branch \$branch_name is up to date, rebase forced.")"
648 # If a hook exists, give it a chance to interrupt
649 run_pre_rebase_hook "$upstream_arg" "$@"
651 if test -n "$diffstat"
652 then
653 if test -n "$verbose"
654 then
655 echo "$(eval_gettext "Changes from \$mb to \$onto:")"
657 # We want color (if set), but no pager
658 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
661 test "$type" = interactive && run_specific_rebase
663 # Detach HEAD and reset the tree
664 say "$(gettext "First, rewinding head to replay your work on top of it...")"
666 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name" \
667 git checkout -q "$onto^0" || die "could not detach HEAD"
668 git update-ref ORIG_HEAD $orig_head
670 # If the $onto is a proper descendant of the tip of the branch, then
671 # we just fast-forwarded.
672 if test "$mb" = "$orig_head"
673 then
674 say "$(eval_gettext "Fast-forwarded \$branch_name to \$onto_name.")"
675 move_to_original_branch
676 finish_rebase
677 exit 0
680 if test -n "$rebase_root"
681 then
682 revisions="$onto..$orig_head"
683 else
684 revisions="${restrict_revision-$upstream}..$orig_head"
687 run_specific_rebase