Submodules: Add the "fetchRecurseSubmodules" config option
[git] / git-pull.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2005 Junio C Hamano
4 #
5 # Fetch one or more remote refs and merge it/them into the current HEAD.
6
7 USAGE='[-n | --no-stat] [--[no-]commit] [--[no-]squash] [--[no-]ff] [-s strategy]... [<fetch-options>] <repo> <head>...'
8 LONG_USAGE='Fetch one or more remote refs and merge it/them into the current HEAD.'
9 SUBDIRECTORY_OK=Yes
10 OPTIONS_SPEC=
11 . git-sh-setup
12 set_reflog_action "pull $*"
13 require_work_tree
14 cd_to_toplevel
15
16
17 die_conflict () {
18     git diff-index --cached --name-status -r --ignore-submodules HEAD --
19     if [ $(git config --bool --get advice.resolveConflict || echo true) = "true" ]; then
20         die "Pull is not possible because you have unmerged files.
21 Please, fix them up in the work tree, and then use 'git add/rm <file>'
22 as appropriate to mark resolution, or use 'git commit -a'."
23     else
24         die "Pull is not possible because you have unmerged files."
25     fi
26 }
27
28 die_merge () {
29     if [ $(git config --bool --get advice.resolveConflict || echo true) = "true" ]; then
30         die "You have not concluded your merge (MERGE_HEAD exists).
31 Please, commit your changes before you can merge."
32     else
33         die "You have not concluded your merge (MERGE_HEAD exists)."
34     fi
35 }
36
37 test -z "$(git ls-files -u)" || die_conflict
38 test -f "$GIT_DIR/MERGE_HEAD" && die_merge
39
40 strategy_args= diffstat= no_commit= squash= no_ff= ff_only=
41 log_arg= verbosity= progress= recurse_submodules=
42 merge_args=
43 curr_branch=$(git symbolic-ref -q HEAD)
44 curr_branch_short="${curr_branch#refs/heads/}"
45 rebase=$(git config --bool branch.$curr_branch_short.rebase)
46 dry_run=
47 while :
48 do
49         case "$1" in
50         -q|--quiet)
51                 verbosity="$verbosity -q" ;;
52         -v|--verbose)
53                 verbosity="$verbosity -v" ;;
54         --progress)
55                 progress=--progress ;;
56         -n|--no-stat|--no-summary)
57                 diffstat=--no-stat ;;
58         --stat|--summary)
59                 diffstat=--stat ;;
60         --log|--no-log)
61                 log_arg=$1 ;;
62         --no-c|--no-co|--no-com|--no-comm|--no-commi|--no-commit)
63                 no_commit=--no-commit ;;
64         --c|--co|--com|--comm|--commi|--commit)
65                 no_commit=--commit ;;
66         --sq|--squ|--squa|--squas|--squash)
67                 squash=--squash ;;
68         --no-sq|--no-squ|--no-squa|--no-squas|--no-squash)
69                 squash=--no-squash ;;
70         --ff)
71                 no_ff=--ff ;;
72         --no-ff)
73                 no_ff=--no-ff ;;
74         --ff-only)
75                 ff_only=--ff-only ;;
76         -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
77                 --strateg=*|--strategy=*|\
78         -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
79                 case "$#,$1" in
80                 *,*=*)
81                         strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
82                 1,*)
83                         usage ;;
84                 *)
85                         strategy="$2"
86                         shift ;;
87                 esac
88                 strategy_args="${strategy_args}-s $strategy "
89                 ;;
90         -X*)
91                 case "$#,$1" in
92                 1,-X)
93                         usage ;;
94                 *,-X)
95                         xx="-X $(git rev-parse --sq-quote "$2")"
96                         shift ;;
97                 *,*)
98                         xx=$(git rev-parse --sq-quote "$1") ;;
99                 esac
100                 merge_args="$merge_args$xx "
101                 ;;
102         -r|--r|--re|--reb|--reba|--rebas|--rebase)
103                 rebase=true
104                 ;;
105         --no-r|--no-re|--no-reb|--no-reba|--no-rebas|--no-rebase)
106                 rebase=false
107                 ;;
108         --recurse-submodules)
109                 recurse_submodules=--recurse-submodules
110                 ;;
111         --no-recurse-submodules)
112                 recurse_submodules=--no-recurse-submodules
113                 ;;
114         --d|--dr|--dry|--dry-|--dry-r|--dry-ru|--dry-run)
115                 dry_run=--dry-run
116                 ;;
117         -h|--h|--he|--hel|--help)
118                 usage
119                 ;;
120         *)
121                 # Pass thru anything that may be meant for fetch.
122                 break
123                 ;;
124         esac
125         shift
126 done
127
128 error_on_no_merge_candidates () {
129         exec >&2
130         for opt
131         do
132                 case "$opt" in
133                 -t|--t|--ta|--tag|--tags)
134                         echo "Fetching tags only, you probably meant:"
135                         echo "  git fetch --tags"
136                         exit 1
137                 esac
138         done
139
140         if test true = "$rebase"
141         then
142                 op_type=rebase
143                 op_prep=against
144         else
145                 op_type=merge
146                 op_prep=with
147         fi
148
149         curr_branch=${curr_branch#refs/heads/}
150         upstream=$(git config "branch.$curr_branch.merge")
151         remote=$(git config "branch.$curr_branch.remote")
152
153         if [ $# -gt 1 ]; then
154                 if [ "$rebase" = true ]; then
155                         printf "There is no candidate for rebasing against "
156                 else
157                         printf "There are no candidates for merging "
158                 fi
159                 echo "among the refs that you just fetched."
160                 echo "Generally this means that you provided a wildcard refspec which had no"
161                 echo "matches on the remote end."
162         elif [ $# -gt 0 ] && [ "$1" != "$remote" ]; then
163                 echo "You asked to pull from the remote '$1', but did not specify"
164                 echo "a branch. Because this is not the default configured remote"
165                 echo "for your current branch, you must specify a branch on the command line."
166         elif [ -z "$curr_branch" ]; then
167                 echo "You are not currently on a branch, so I cannot use any"
168                 echo "'branch.<branchname>.merge' in your configuration file."
169                 echo "Please specify which remote branch you want to use on the command"
170                 echo "line and try again (e.g. 'git pull <repository> <refspec>')."
171                 echo "See git-pull(1) for details."
172         elif [ -z "$upstream" ]; then
173                 echo "You asked me to pull without telling me which branch you"
174                 echo "want to $op_type $op_prep, and 'branch.${curr_branch}.merge' in"
175                 echo "your configuration file does not tell me, either. Please"
176                 echo "specify which branch you want to use on the command line and"
177                 echo "try again (e.g. 'git pull <repository> <refspec>')."
178                 echo "See git-pull(1) for details."
179                 echo
180                 echo "If you often $op_type $op_prep the same branch, you may want to"
181                 echo "use something like the following in your configuration file:"
182                 echo
183                 echo "    [branch \"${curr_branch}\"]"
184                 echo "    remote = <nickname>"
185                 echo "    merge = <remote-ref>"
186                 test rebase = "$op_type" &&
187                         echo "    rebase = true"
188                 echo
189                 echo "    [remote \"<nickname>\"]"
190                 echo "    url = <url>"
191                 echo "    fetch = <refspec>"
192                 echo
193                 echo "See git-config(1) for details."
194         else
195                 echo "Your configuration specifies to $op_type $op_prep the ref '${upstream#refs/heads/}'"
196                 echo "from the remote, but no such ref was fetched."
197         fi
198         exit 1
199 }
200
201 test true = "$rebase" && {
202         if ! git rev-parse -q --verify HEAD >/dev/null
203         then
204                 # On an unborn branch
205                 if test -f "$GIT_DIR/index"
206                 then
207                         die "updating an unborn branch with changes added to the index"
208                 fi
209         else
210                 git update-index --ignore-submodules --refresh &&
211                 git diff-files --ignore-submodules --quiet &&
212                 git diff-index --ignore-submodules --cached --quiet HEAD -- ||
213                 die "refusing to pull with rebase: your working tree is not up-to-date"
214         fi
215         oldremoteref= &&
216         . git-parse-remote &&
217         remoteref="$(get_remote_merge_branch "$@" 2>/dev/null)" &&
218         oldremoteref="$(git rev-parse -q --verify "$remoteref")" &&
219         for reflog in $(git rev-list -g $remoteref 2>/dev/null)
220         do
221                 if test "$reflog" = "$(git merge-base $reflog $curr_branch)"
222                 then
223                         oldremoteref="$reflog"
224                         break
225                 fi
226         done
227 }
228 orig_head=$(git rev-parse -q --verify HEAD)
229 git fetch $verbosity $progress $dry_run $recurse_submodules --update-head-ok "$@" || exit 1
230 test -z "$dry_run" || exit 0
231
232 curr_head=$(git rev-parse -q --verify HEAD)
233 if test -n "$orig_head" && test "$curr_head" != "$orig_head"
234 then
235         # The fetch involved updating the current branch.
236
237         # The working tree and the index file is still based on the
238         # $orig_head commit, but we are merging into $curr_head.
239         # First update the working tree to match $curr_head.
240
241         echo >&2 "Warning: fetch updated the current branch head."
242         echo >&2 "Warning: fast-forwarding your working tree from"
243         echo >&2 "Warning: commit $orig_head."
244         git update-index -q --refresh
245         git read-tree -u -m "$orig_head" "$curr_head" ||
246                 die 'Cannot fast-forward your working tree.
247 After making sure that you saved anything precious from
248 $ git diff '$orig_head'
249 output, run
250 $ git reset --hard
251 to recover.'
252
253 fi
254
255 merge_head=$(sed -e '/  not-for-merge   /d' \
256         -e 's/  .*//' "$GIT_DIR"/FETCH_HEAD | \
257         tr '\012' ' ')
258
259 case "$merge_head" in
260 '')
261         error_on_no_merge_candidates "$@"
262         ;;
263 ?*' '?*)
264         if test -z "$orig_head"
265         then
266                 die "Cannot merge multiple branches into empty head"
267         fi
268         if test true = "$rebase"
269         then
270                 die "Cannot rebase onto multiple branches"
271         fi
272         ;;
273 esac
274
275 if test -z "$orig_head"
276 then
277         git update-ref -m "initial pull" HEAD $merge_head "$curr_head" &&
278         git read-tree --reset -u HEAD || exit 1
279         exit
280 fi
281
282 if test true = "$rebase"
283 then
284         o=$(git show-branch --merge-base $curr_branch $merge_head $oldremoteref)
285         if test "$oldremoteref" = "$o"
286         then
287                 unset oldremoteref
288         fi
289 fi
290
291 merge_name=$(git fmt-merge-msg $log_arg <"$GIT_DIR/FETCH_HEAD") || exit
292 case "$rebase" in
293 true)
294         eval="git-rebase $diffstat $strategy_args $merge_args"
295         eval="$eval --onto $merge_head ${oldremoteref:-$merge_head}"
296         ;;
297 *)
298         eval="git-merge $diffstat $no_commit $squash $no_ff $ff_only"
299         eval="$eval  $log_arg $strategy_args $merge_args"
300         eval="$eval \"\$merge_name\" HEAD $merge_head $verbosity"
301         ;;
302 esac
303 eval "exec $eval"