pull: add --ff-only to the help text
[git/raj.git] / git-pull.sh
blobd17a461b3d8fd4c35b795ca1855c24e39d2cc908
1 #!/bin/sh
3 # Copyright (c) 2005 Junio C Hamano
5 # Fetch one or more remote refs and merge it/them into the current HEAD.
7 USAGE='[-n | --no-stat] [--[no-]commit] [--[no-]squash] [--[no-]ff|--ff-only] [--[no-]rebase|--rebase=preserve] [-s strategy]... [<fetch-options>] <repo> <head>...'
8 LONG_USAGE='Fetch one or more remote refs and integrate it/them with the current HEAD.'
9 SUBDIRECTORY_OK=Yes
10 OPTIONS_SPEC=
11 . git-sh-setup
12 . git-sh-i18n
13 set_reflog_action "pull${1+ $*}"
14 require_work_tree_exists
15 cd_to_toplevel
18 die_conflict () {
19 git diff-index --cached --name-status -r --ignore-submodules HEAD --
20 if [ $(git config --bool --get advice.resolveConflict || echo true) = "true" ]; then
21 die "$(gettext "Pull is not possible because you have unmerged files.
22 Please, fix them up in the work tree, and then use 'git add/rm <file>'
23 as appropriate to mark resolution, or use 'git commit -a'.")"
24 else
25 die "$(gettext "Pull is not possible because you have unmerged files.")"
29 die_merge () {
30 if [ $(git config --bool --get advice.resolveConflict || echo true) = "true" ]; then
31 die "$(gettext "You have not concluded your merge (MERGE_HEAD exists).
32 Please, commit your changes before you can merge.")"
33 else
34 die "$(gettext "You have not concluded your merge (MERGE_HEAD exists).")"
38 test -z "$(git ls-files -u)" || die_conflict
39 test -f "$GIT_DIR/MERGE_HEAD" && die_merge
41 bool_or_string_config () {
42 git config --bool "$1" 2>/dev/null || git config "$1"
45 strategy_args= diffstat= no_commit= squash= no_ff= ff_only=
46 log_arg= verbosity= progress= recurse_submodules= verify_signatures=
47 merge_args= edit= rebase_args=
48 curr_branch=$(git symbolic-ref -q HEAD)
49 curr_branch_short="${curr_branch#refs/heads/}"
50 rebase=$(bool_or_string_config branch.$curr_branch_short.rebase)
51 if test -z "$rebase"
52 then
53 rebase=$(bool_or_string_config pull.rebase)
56 # Setup default fast-forward options via `pull.ff`
57 pull_ff=$(git config pull.ff)
58 case "$pull_ff" in
59 false)
60 no_ff=--no-ff
61 break
63 only)
64 ff_only=--ff-only
65 break
67 esac
70 dry_run=
71 while :
73 case "$1" in
74 -q|--quiet)
75 verbosity="$verbosity -q" ;;
76 -v|--verbose)
77 verbosity="$verbosity -v" ;;
78 --progress)
79 progress=--progress ;;
80 --no-progress)
81 progress=--no-progress ;;
82 -n|--no-stat|--no-summary)
83 diffstat=--no-stat ;;
84 --stat|--summary)
85 diffstat=--stat ;;
86 --log|--no-log)
87 log_arg=$1 ;;
88 --no-c|--no-co|--no-com|--no-comm|--no-commi|--no-commit)
89 no_commit=--no-commit ;;
90 --c|--co|--com|--comm|--commi|--commit)
91 no_commit=--commit ;;
92 -e|--edit)
93 edit=--edit ;;
94 --no-edit)
95 edit=--no-edit ;;
96 --sq|--squ|--squa|--squas|--squash)
97 squash=--squash ;;
98 --no-sq|--no-squ|--no-squa|--no-squas|--no-squash)
99 squash=--no-squash ;;
100 --ff)
101 no_ff=--ff ;;
102 --no-ff)
103 no_ff=--no-ff ;;
104 --ff-only)
105 ff_only=--ff-only ;;
106 -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
107 --strateg=*|--strategy=*|\
108 -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
109 case "$#,$1" in
110 *,*=*)
111 strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
112 1,*)
113 usage ;;
115 strategy="$2"
116 shift ;;
117 esac
118 strategy_args="${strategy_args}-s $strategy "
120 -X*)
121 case "$#,$1" in
122 1,-X)
123 usage ;;
124 *,-X)
125 xx="-X $(git rev-parse --sq-quote "$2")"
126 shift ;;
127 *,*)
128 xx=$(git rev-parse --sq-quote "$1") ;;
129 esac
130 merge_args="$merge_args$xx "
132 -r=*|--r=*|--re=*|--reb=*|--reba=*|--rebas=*|--rebase=*)
133 rebase="${1#*=}"
135 -r|--r|--re|--reb|--reba|--rebas|--rebase)
136 rebase=true
138 --no-r|--no-re|--no-reb|--no-reba|--no-rebas|--no-rebase)
139 rebase=false
141 --recurse-submodules)
142 recurse_submodules=--recurse-submodules
144 --recurse-submodules=*)
145 recurse_submodules="$1"
147 --no-recurse-submodules)
148 recurse_submodules=--no-recurse-submodules
150 --verify-signatures)
151 verify_signatures=--verify-signatures
153 --no-verify-signatures)
154 verify_signatures=--no-verify-signatures
156 --d|--dr|--dry|--dry-|--dry-r|--dry-ru|--dry-run)
157 dry_run=--dry-run
159 -h|--help-all)
160 usage
163 # Pass thru anything that may be meant for fetch.
164 break
166 esac
167 shift
168 done
170 case "$rebase" in
171 preserve)
172 rebase=true
173 rebase_args=--preserve-merges
175 true|false|'')
178 echo "Invalid value for --rebase, should be true, false, or preserve"
179 usage
180 exit 1
182 esac
184 error_on_no_merge_candidates () {
185 exec >&2
186 for opt
188 case "$opt" in
189 -t|--t|--ta|--tag|--tags)
190 echo "Fetching tags only, you probably meant:"
191 echo " git fetch --tags"
192 exit 1
193 esac
194 done
196 if test true = "$rebase"
197 then
198 op_type=rebase
199 op_prep=against
200 else
201 op_type=merge
202 op_prep=with
205 upstream=$(git config "branch.$curr_branch_short.merge")
206 remote=$(git config "branch.$curr_branch_short.remote")
208 if [ $# -gt 1 ]; then
209 if [ "$rebase" = true ]; then
210 printf "There is no candidate for rebasing against "
211 else
212 printf "There are no candidates for merging "
214 echo "among the refs that you just fetched."
215 echo "Generally this means that you provided a wildcard refspec which had no"
216 echo "matches on the remote end."
217 elif [ $# -gt 0 ] && [ "$1" != "$remote" ]; then
218 echo "You asked to pull from the remote '$1', but did not specify"
219 echo "a branch. Because this is not the default configured remote"
220 echo "for your current branch, you must specify a branch on the command line."
221 elif [ -z "$curr_branch" -o -z "$upstream" ]; then
222 . git-parse-remote
223 error_on_missing_default_upstream "pull" $op_type $op_prep \
224 "git pull <remote> <branch>"
225 else
226 echo "Your configuration specifies to $op_type $op_prep the ref '${upstream#refs/heads/}'"
227 echo "from the remote, but no such ref was fetched."
229 exit 1
232 test true = "$rebase" && {
233 if ! git rev-parse -q --verify HEAD >/dev/null
234 then
235 # On an unborn branch
236 if test -f "$GIT_DIR/index"
237 then
238 die "$(gettext "updating an unborn branch with changes added to the index")"
240 else
241 require_clean_work_tree "pull with rebase" "Please commit or stash them."
243 oldremoteref= &&
244 test -n "$curr_branch" &&
245 . git-parse-remote &&
246 remoteref="$(get_remote_merge_branch "$@" 2>/dev/null)" &&
247 oldremoteref="$(git rev-parse -q --verify "$remoteref")" &&
248 for reflog in $(git rev-list -g $remoteref 2>/dev/null)
250 if test "$reflog" = "$(git merge-base $reflog $curr_branch)"
251 then
252 oldremoteref="$reflog"
253 break
255 done
257 orig_head=$(git rev-parse -q --verify HEAD)
258 git fetch $verbosity $progress $dry_run $recurse_submodules --update-head-ok "$@" || exit 1
259 test -z "$dry_run" || exit 0
261 curr_head=$(git rev-parse -q --verify HEAD)
262 if test -n "$orig_head" && test "$curr_head" != "$orig_head"
263 then
264 # The fetch involved updating the current branch.
266 # The working tree and the index file is still based on the
267 # $orig_head commit, but we are merging into $curr_head.
268 # First update the working tree to match $curr_head.
270 eval_gettextln "Warning: fetch updated the current branch head.
271 Warning: fast-forwarding your working tree from
272 Warning: commit \$orig_head." >&2
273 git update-index -q --refresh
274 git read-tree -u -m "$orig_head" "$curr_head" ||
275 die "$(eval_gettext "Cannot fast-forward your working tree.
276 After making sure that you saved anything precious from
277 $ git diff \$orig_head
278 output, run
279 $ git reset --hard
280 to recover.")"
284 merge_head=$(sed -e '/ not-for-merge /d' \
285 -e 's/ .*//' "$GIT_DIR"/FETCH_HEAD | \
286 tr '\012' ' ')
288 case "$merge_head" in
290 error_on_no_merge_candidates "$@"
292 ?*' '?*)
293 if test -z "$orig_head"
294 then
295 die "$(gettext "Cannot merge multiple branches into empty head")"
297 if test true = "$rebase"
298 then
299 die "$(gettext "Cannot rebase onto multiple branches")"
302 esac
304 # Pulling into unborn branch: a shorthand for branching off
305 # FETCH_HEAD, for lazy typers.
306 if test -z "$orig_head"
307 then
308 # Two-way merge: we claim the index is based on an empty tree,
309 # and try to fast-forward to HEAD. This ensures we will not
310 # lose index/worktree changes that the user already made on
311 # the unborn branch.
312 empty_tree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
313 git read-tree -m -u $empty_tree $merge_head &&
314 git update-ref -m "initial pull" HEAD $merge_head "$curr_head"
315 exit
318 if test true = "$rebase"
319 then
320 o=$(git show-branch --merge-base $curr_branch $merge_head $oldremoteref)
321 if test "$oldremoteref" = "$o"
322 then
323 unset oldremoteref
327 merge_name=$(git fmt-merge-msg $log_arg <"$GIT_DIR/FETCH_HEAD") || exit
328 case "$rebase" in
329 true)
330 eval="git-rebase $diffstat $strategy_args $merge_args $rebase_args $verbosity"
331 eval="$eval --onto $merge_head ${oldremoteref:-$merge_head}"
334 eval="git-merge $diffstat $no_commit $verify_signatures $edit $squash $no_ff $ff_only"
335 eval="$eval $log_arg $strategy_args $merge_args $verbosity $progress"
336 eval="$eval \"\$merge_name\" HEAD $merge_head"
338 esac
339 eval "exec $eval"