Fix some documentation typos and grammar
[git] / git-fetch.sh
1 #!/bin/sh
2 #
3
4 USAGE='<fetch-options> <repository> <refspec>...'
5 SUBDIRECTORY_OK=Yes
6 . git-sh-setup
7 set_reflog_action "fetch $*"
8 cd_to_toplevel ;# probably unnecessary...
9
10 . git-parse-remote
11 _x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
12 _x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
13
14 LF='
15 '
16 IFS="$LF"
17
18 no_tags=
19 tags=
20 append=
21 force=
22 verbose=
23 update_head_ok=
24 exec=
25 keep=
26 shallow_depth=
27 while case "$#" in 0) break ;; esac
28 do
29         case "$1" in
30         -a|--a|--ap|--app|--appe|--appen|--append)
31                 append=t
32                 ;;
33         --upl|--uplo|--uploa|--upload|--upload-|--upload-p|\
34         --upload-pa|--upload-pac|--upload-pack)
35                 shift
36                 exec="--upload-pack=$1"
37                 ;;
38         --upl=*|--uplo=*|--uploa=*|--upload=*|\
39         --upload-=*|--upload-p=*|--upload-pa=*|--upload-pac=*|--upload-pack=*)
40                 exec=--upload-pack=$(expr "z$1" : 'z-[^=]*=\(.*\)')
41                 shift
42                 ;;
43         -f|--f|--fo|--for|--forc|--force)
44                 force=t
45                 ;;
46         -t|--t|--ta|--tag|--tags)
47                 tags=t
48                 ;;
49         -n|--n|--no|--no-|--no-t|--no-ta|--no-tag|--no-tags)
50                 no_tags=t
51                 ;;
52         -u|--u|--up|--upd|--upda|--updat|--update|--update-|--update-h|\
53         --update-he|--update-hea|--update-head|--update-head-|\
54         --update-head-o|--update-head-ok)
55                 update_head_ok=t
56                 ;;
57         -v|--verbose)
58                 verbose=Yes
59                 ;;
60         -k|--k|--ke|--kee|--keep)
61                 keep='-k -k'
62                 ;;
63         --depth=*)
64                 shallow_depth="--depth=`expr "z$1" : 'z-[^=]*=\(.*\)'`"
65                 ;;
66         --depth)
67                 shift
68                 shallow_depth="--depth=$1"
69                 ;;
70         -*)
71                 usage
72                 ;;
73         *)
74                 break
75                 ;;
76         esac
77         shift
78 done
79
80 case "$#" in
81 0)
82         origin=$(get_default_remote)
83         test -n "$(get_remote_url ${origin})" ||
84                 die "Where do you want to fetch from today?"
85         set x $origin ; shift ;;
86 esac
87
88 if test -z "$exec"
89 then
90         # No command line override and we have configuration for the remote.
91         exec="--upload-pack=$(get_uploadpack $1)"
92 fi
93
94 remote_nick="$1"
95 remote=$(get_remote_url "$@")
96 refs=
97 rref=
98 rsync_slurped_objects=
99
100 if test "" = "$append"
101 then
102         : >"$GIT_DIR/FETCH_HEAD"
103 fi
104
105 # Global that is reused later
106 ls_remote_result=$(git ls-remote $exec "$remote") ||
107         die "Cannot get the repository state from $remote"
108
109 append_fetch_head () {
110     head_="$1"
111     remote_="$2"
112     remote_name_="$3"
113     remote_nick_="$4"
114     local_name_="$5"
115     case "$6" in
116     t) not_for_merge_='not-for-merge' ;;
117     '') not_for_merge_= ;;
118     esac
119
120     # remote-nick is the URL given on the command line (or a shorthand)
121     # remote-name is the $GIT_DIR relative refs/ path we computed
122     # for this refspec.
123
124     # the $note_ variable will be fed to git-fmt-merge-msg for further
125     # processing.
126     case "$remote_name_" in
127     HEAD)
128         note_= ;;
129     refs/heads/*)
130         note_="$(expr "$remote_name_" : 'refs/heads/\(.*\)')"
131         note_="branch '$note_' of " ;;
132     refs/tags/*)
133         note_="$(expr "$remote_name_" : 'refs/tags/\(.*\)')"
134         note_="tag '$note_' of " ;;
135     refs/remotes/*)
136         note_="$(expr "$remote_name_" : 'refs/remotes/\(.*\)')"
137         note_="remote branch '$note_' of " ;;
138     *)
139         note_="$remote_name of " ;;
140     esac
141     remote_1_=$(expr "z$remote_" : 'z\(.*\)\.git/*$') &&
142         remote_="$remote_1_"
143     note_="$note_$remote_"
144
145     # 2.6.11-tree tag would not be happy to be fed to resolve.
146     if git-cat-file commit "$head_" >/dev/null 2>&1
147     then
148         headc_=$(git-rev-parse --verify "$head_^0") || exit
149         echo "$headc_   $not_for_merge_ $note_" >>"$GIT_DIR/FETCH_HEAD"
150     else
151         echo "$head_    not-for-merge   $note_" >>"$GIT_DIR/FETCH_HEAD"
152     fi
153
154     update_local_ref "$local_name_" "$head_" "$note_"
155 }
156
157 update_local_ref () {
158     # If we are storing the head locally make sure that it is
159     # a fast forward (aka "reverse push").
160
161     label_=$(git-cat-file -t $2)
162     newshort_=$(git-rev-parse --short $2)
163     if test -z "$1" ; then
164         [ "$verbose" ] && echo >&2 "* fetched $3"
165         [ "$verbose" ] && echo >&2 "  $label_: $newshort_"
166         return 0
167     fi
168     oldshort_=$(git show-ref --hash --abbrev "$1" 2>/dev/null)
169
170     case "$1" in
171     refs/tags/*)
172         # Tags need not be pointing at commits so there
173         # is no way to guarantee "fast-forward" anyway.
174         if test -n "$oldshort_"
175         then
176                 if now_=$(git show-ref --hash "$1") && test "$now_" = "$2"
177                 then
178                         [ "$verbose" ] && echo >&2 "* $1: same as $3"
179                         [ "$verbose" ] && echo >&2 "  $label_: $newshort_" ||:
180                 else
181                         echo >&2 "* $1: updating with $3"
182                         echo >&2 "  $label_: $newshort_"
183                         git-update-ref -m "$GIT_REFLOG_ACTION: updating tag" "$1" "$2"
184                 fi
185         else
186                 echo >&2 "* $1: storing $3"
187                 echo >&2 "  $label_: $newshort_"
188                 git-update-ref -m "$GIT_REFLOG_ACTION: storing tag" "$1" "$2"
189         fi
190         ;;
191
192     refs/heads/* | refs/remotes/*)
193         # $1 is the ref being updated.
194         # $2 is the new value for the ref.
195         local=$(git-rev-parse --verify "$1^0" 2>/dev/null)
196         if test "$local"
197         then
198             # Require fast-forward.
199             mb=$(git-merge-base "$local" "$2") &&
200             case "$2,$mb" in
201             $local,*)
202                 if test -n "$verbose"
203                 then
204                         echo >&2 "* $1: same as $3"
205                         echo >&2 "  $label_: $newshort_"
206                 fi
207                 ;;
208             *,$local)
209                 echo >&2 "* $1: fast forward to $3"
210                 echo >&2 "  old..new: $oldshort_..$newshort_"
211                 git-update-ref -m "$GIT_REFLOG_ACTION: fast-forward" "$1" "$2" "$local"
212                 ;;
213             *)
214                 false
215                 ;;
216             esac || {
217                 case ",$force,$single_force," in
218                 *,t,*)
219                         echo >&2 "* $1: forcing update to non-fast forward $3"
220                         echo >&2 "  old...new: $oldshort_...$newshort_"
221                         git-update-ref -m "$GIT_REFLOG_ACTION: forced-update" "$1" "$2" "$local"
222                         ;;
223                 *)
224                         echo >&2 "* $1: not updating to non-fast forward $3"
225                         echo >&2 "  old...new: $oldshort_...$newshort_"
226                         exit 1
227                         ;;
228                 esac
229             }
230         else
231             echo >&2 "* $1: storing $3"
232             echo >&2 "  $label_: $newshort_"
233             git-update-ref -m "$GIT_REFLOG_ACTION: storing head" "$1" "$2"
234         fi
235         ;;
236     esac
237 }
238
239 # updating the current HEAD with git-fetch in a bare
240 # repository is always fine.
241 if test -z "$update_head_ok" && test $(is_bare_repository) = false
242 then
243         orig_head=$(git-rev-parse --verify HEAD 2>/dev/null)
244 fi
245
246 # If --tags (and later --heads or --all) is specified, then we are
247 # not talking about defaults stored in Pull: line of remotes or
248 # branches file, and just fetch those and refspecs explicitly given.
249 # Otherwise we do what we always did.
250
251 reflist=$(get_remote_refs_for_fetch "$@")
252 if test "$tags"
253 then
254         taglist=`IFS='  ' &&
255                   echo "$ls_remote_result" |
256                   while read sha1 name
257                   do
258                         case "$sha1" in
259                         fail)
260                                 exit 1
261                         esac
262                         case "$name" in
263                         *^*) continue ;;
264                         refs/tags/*) ;;
265                         *) continue ;;
266                         esac
267                         if git-check-ref-format "$name"
268                         then
269                             echo ".${name}:${name}"
270                         else
271                             echo >&2 "warning: tag ${name} ignored"
272                         fi
273                   done` || exit
274         if test "$#" -gt 1
275         then
276                 # remote URL plus explicit refspecs; we need to merge them.
277                 reflist="$reflist$LF$taglist"
278         else
279                 # No explicit refspecs; fetch tags only.
280                 reflist=$taglist
281         fi
282 fi
283
284 fetch_main () {
285   reflist="$1"
286   refs=
287   rref=
288
289   for ref in $reflist
290   do
291       refs="$refs$LF$ref"
292
293       # These are relative path from $GIT_DIR, typically starting at refs/
294       # but may be HEAD
295       if expr "z$ref" : 'z\.' >/dev/null
296       then
297           not_for_merge=t
298           ref=$(expr "z$ref" : 'z\.\(.*\)')
299       else
300           not_for_merge=
301       fi
302       if expr "z$ref" : 'z+' >/dev/null
303       then
304           single_force=t
305           ref=$(expr "z$ref" : 'z+\(.*\)')
306       else
307           single_force=
308       fi
309       remote_name=$(expr "z$ref" : 'z\([^:]*\):')
310       local_name=$(expr "z$ref" : 'z[^:]*:\(.*\)')
311
312       rref="$rref$LF$remote_name"
313
314       # There are transports that can fetch only one head at a time...
315       case "$remote" in
316       http://* | https://* | ftp://*)
317           test -n "$shallow_depth" &&
318                 die "shallow clone with http not supported"
319           proto=`expr "$remote" : '\([^:]*\):'`
320           if [ -n "$GIT_SSL_NO_VERIFY" ]; then
321               curl_extra_args="-k"
322           fi
323           if [ -n "$GIT_CURL_FTP_NO_EPSV" -o \
324                 "`git-config --bool http.noEPSV`" = true ]; then
325               noepsv_opt="--disable-epsv"
326           fi
327
328           # Find $remote_name from ls-remote output.
329           head=$(
330                 IFS='   '
331                 echo "$ls_remote_result" |
332                 while read sha1 name
333                 do
334                         test "z$name" = "z$remote_name" || continue
335                         echo "$sha1"
336                         break
337                 done
338           )
339           expr "z$head" : "z$_x40\$" >/dev/null ||
340                 die "No such ref $remote_name at $remote"
341           echo >&2 "Fetching $remote_name from $remote using $proto"
342           git-http-fetch -v -a "$head" "$remote/" || exit
343           ;;
344       rsync://*)
345           test -n "$shallow_depth" &&
346                 die "shallow clone with rsync not supported"
347           TMP_HEAD="$GIT_DIR/TMP_HEAD"
348           rsync -L -q "$remote/$remote_name" "$TMP_HEAD" || exit 1
349           head=$(git-rev-parse --verify TMP_HEAD)
350           rm -f "$TMP_HEAD"
351           test "$rsync_slurped_objects" || {
352               rsync -av --ignore-existing --exclude info \
353                   "$remote/objects/" "$GIT_OBJECT_DIRECTORY/" || exit
354
355               # Look at objects/info/alternates for rsync -- http will
356               # support it natively and git native ones will do it on
357               # the remote end.  Not having that file is not a crime.
358               rsync -q "$remote/objects/info/alternates" \
359                   "$GIT_DIR/TMP_ALT" 2>/dev/null ||
360                   rm -f "$GIT_DIR/TMP_ALT"
361               if test -f "$GIT_DIR/TMP_ALT"
362               then
363                   resolve_alternates "$remote" <"$GIT_DIR/TMP_ALT" |
364                   while read alt
365                   do
366                       case "$alt" in 'bad alternate: '*) die "$alt";; esac
367                       echo >&2 "Getting alternate: $alt"
368                       rsync -av --ignore-existing --exclude info \
369                       "$alt" "$GIT_OBJECT_DIRECTORY/" || exit
370                   done
371                   rm -f "$GIT_DIR/TMP_ALT"
372               fi
373               rsync_slurped_objects=t
374           }
375           ;;
376       *)
377           # We will do git native transport with just one call later.
378           continue ;;
379       esac
380
381       append_fetch_head "$head" "$remote" \
382           "$remote_name" "$remote_nick" "$local_name" "$not_for_merge" || exit
383
384   done
385
386   case "$remote" in
387   http://* | https://* | ftp://* | rsync://* )
388       ;; # we are already done.
389   *)
390     ( : subshell because we muck with IFS
391       IFS="     $LF"
392       (
393           git-fetch-pack --thin $exec $keep $shallow_depth "$remote" $rref ||
394           echo failed "$remote"
395       ) |
396       (
397         trap '
398                 if test -n "$keepfile" && test -f "$keepfile"
399                 then
400                         rm -f "$keepfile"
401                 fi
402         ' 0
403
404         keepfile=
405         while read sha1 remote_name
406         do
407           case "$sha1" in
408           failed)
409                   echo >&2 "Fetch failure: $remote"
410                   exit 1 ;;
411           # special line coming from index-pack with the pack name
412           pack)
413                   continue ;;
414           keep)
415                   keepfile="$GIT_OBJECT_DIRECTORY/pack/pack-$remote_name.keep"
416                   continue ;;
417           esac
418           found=
419           single_force=
420           for ref in $refs
421           do
422               case "$ref" in
423               +$remote_name:*)
424                   single_force=t
425                   not_for_merge=
426                   found="$ref"
427                   break ;;
428               .+$remote_name:*)
429                   single_force=t
430                   not_for_merge=t
431                   found="$ref"
432                   break ;;
433               .$remote_name:*)
434                   not_for_merge=t
435                   found="$ref"
436                   break ;;
437               $remote_name:*)
438                   not_for_merge=
439                   found="$ref"
440                   break ;;
441               esac
442           done
443           local_name=$(expr "z$found" : 'z[^:]*:\(.*\)')
444           append_fetch_head "$sha1" "$remote" \
445                   "$remote_name" "$remote_nick" "$local_name" \
446                   "$not_for_merge" || exit
447         done
448       )
449     ) || exit ;;
450   esac
451
452 }
453
454 fetch_main "$reflist" || exit
455
456 # automated tag following
457 case "$no_tags$tags" in
458 '')
459         case "$reflist" in
460         *:refs/*)
461                 # effective only when we are following remote branch
462                 # using local tracking branch.
463                 taglist=$(IFS=' ' &&
464                 echo "$ls_remote_result" |
465                 git-show-ref --exclude-existing=refs/tags/ |
466                 while read sha1 name
467                 do
468                         git-cat-file -t "$sha1" >/dev/null 2>&1 || continue
469                         echo >&2 "Auto-following $name"
470                         echo ".${name}:${name}"
471                 done)
472         esac
473         case "$taglist" in
474         '') ;;
475         ?*)
476                 # do not deepen a shallow tree when following tags
477                 shallow_depth=
478                 fetch_main "$taglist" || exit ;;
479         esac
480 esac
481
482 # If the original head was empty (i.e. no "master" yet), or
483 # if we were told not to worry, we do not have to check.
484 case "$orig_head" in
485 '')
486         ;;
487 ?*)
488         curr_head=$(git-rev-parse --verify HEAD 2>/dev/null)
489         if test "$curr_head" != "$orig_head"
490         then
491             git-update-ref \
492                         -m "$GIT_REFLOG_ACTION: Undoing incorrectly fetched HEAD." \
493                         HEAD "$orig_head"
494                 die "Cannot fetch into the current branch."
495         fi
496         ;;
497 esac