Merge branch 'dw/check-ignore-sans-index'
[git] / git-submodule.sh
1 #!/bin/sh
2 #
3 # git-submodule.sh: add, init, update or list git submodules
4 #
5 # Copyright (c) 2007 Lars Hjemli
6
7 dashless=$(basename "$0" | sed -e 's/-/ /')
8 USAGE="[--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
9    or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
10    or: $dashless [--quiet] init [--] [<path>...]
11    or: $dashless [--quiet] deinit [-f|--force] [--] <path>...
12    or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--rebase] [--reference <repository>] [--merge] [--recursive] [--] [<path>...]
13    or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
14    or: $dashless [--quiet] foreach [--recursive] <command>
15    or: $dashless [--quiet] sync [--recursive] [--] [<path>...]"
16 OPTIONS_SPEC=
17 SUBDIRECTORY_OK=Yes
18 . git-sh-setup
19 . git-sh-i18n
20 . git-parse-remote
21 require_work_tree
22 wt_prefix=$(git rev-parse --show-prefix)
23 cd_to_toplevel
24
25 command=
26 branch=
27 force=
28 reference=
29 cached=
30 recursive=
31 init=
32 files=
33 remote=
34 nofetch=
35 update=
36 prefix=
37 custom_name=
38 depth=
39
40 # The function takes at most 2 arguments. The first argument is the
41 # URL that navigates to the submodule origin repo. When relative, this URL
42 # is relative to the superproject origin URL repo. The second up_path
43 # argument, if specified, is the relative path that navigates
44 # from the submodule working tree to the superproject working tree.
45 #
46 # The output of the function is the origin URL of the submodule.
47 #
48 # The output will either be an absolute URL or filesystem path (if the
49 # superproject origin URL is an absolute URL or filesystem path,
50 # respectively) or a relative file system path (if the superproject
51 # origin URL is a relative file system path).
52 #
53 # When the output is a relative file system path, the path is either
54 # relative to the submodule working tree, if up_path is specified, or to
55 # the superproject working tree otherwise.
56 resolve_relative_url ()
57 {
58         remote=$(get_default_remote)
59         remoteurl=$(git config "remote.$remote.url") ||
60                 remoteurl=$(pwd) # the repository is its own authoritative upstream
61         url="$1"
62         remoteurl=${remoteurl%/}
63         sep=/
64         up_path="$2"
65
66         case "$remoteurl" in
67         *:*|/*)
68                 is_relative=
69                 ;;
70         ./*|../*)
71                 is_relative=t
72                 ;;
73         *)
74                 is_relative=t
75                 remoteurl="./$remoteurl"
76                 ;;
77         esac
78
79         while test -n "$url"
80         do
81                 case "$url" in
82                 ../*)
83                         url="${url#../}"
84                         case "$remoteurl" in
85                         */*)
86                                 remoteurl="${remoteurl%/*}"
87                                 ;;
88                         *:*)
89                                 remoteurl="${remoteurl%:*}"
90                                 sep=:
91                                 ;;
92                         *)
93                                 if test -z "$is_relative" || test "." = "$remoteurl"
94                                 then
95                                         die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
96                                 else
97                                         remoteurl=.
98                                 fi
99                                 ;;
100                         esac
101                         ;;
102                 ./*)
103                         url="${url#./}"
104                         ;;
105                 *)
106                         break;;
107                 esac
108         done
109         remoteurl="$remoteurl$sep${url%/}"
110         echo "${is_relative:+${up_path}}${remoteurl#./}"
111 }
112
113 # Resolve a path to be relative to another path.  This is intended for
114 # converting submodule paths when git-submodule is run in a subdirectory
115 # and only handles paths where the directory separator is '/'.
116 #
117 # The output is the first argument as a path relative to the second argument,
118 # which defaults to $wt_prefix if it is omitted.
119 relative_path ()
120 {
121         local target curdir result
122         target=$1
123         curdir=${2-$wt_prefix}
124         curdir=${curdir%/}
125         result=
126
127         while test -n "$curdir"
128         do
129                 case "$target" in
130                 "$curdir/"*)
131                         target=${target#"$curdir"/}
132                         break
133                         ;;
134                 esac
135
136                 result="${result}../"
137                 if test "$curdir" = "${curdir%/*}"
138                 then
139                         curdir=
140                 else
141                         curdir="${curdir%/*}"
142                 fi
143         done
144
145         echo "$result$target"
146 }
147
148 #
149 # Get submodule info for registered submodules
150 # $@ = path to limit submodule list
151 #
152 module_list()
153 {
154         eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
155         (
156                 git ls-files -z --error-unmatch --stage -- "$@" ||
157                 echo "unmatched pathspec exists"
158         ) |
159         perl -e '
160         my %unmerged = ();
161         my ($null_sha1) = ("0" x 40);
162         my @out = ();
163         my $unmatched = 0;
164         $/ = "\0";
165         while (<STDIN>) {
166                 if (/^unmatched pathspec/) {
167                         $unmatched = 1;
168                         next;
169                 }
170                 chomp;
171                 my ($mode, $sha1, $stage, $path) =
172                         /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
173                 next unless $mode eq "160000";
174                 if ($stage ne "0") {
175                         if (!$unmerged{$path}++) {
176                                 push @out, "$mode $null_sha1 U\t$path\n";
177                         }
178                         next;
179                 }
180                 push @out, "$_\n";
181         }
182         if ($unmatched) {
183                 print "#unmatched\n";
184         } else {
185                 print for (@out);
186         }
187         '
188 }
189
190 die_if_unmatched ()
191 {
192         if test "$1" = "#unmatched"
193         then
194                 exit 1
195         fi
196 }
197
198 #
199 # Print a submodule configuration setting
200 #
201 # $1 = submodule name
202 # $2 = option name
203 # $3 = default value
204 #
205 # Checks in the usual git-config places first (for overrides),
206 # otherwise it falls back on .gitmodules.  This allows you to
207 # distribute project-wide defaults in .gitmodules, while still
208 # customizing individual repositories if necessary.  If the option is
209 # not in .gitmodules either, print a default value.
210 #
211 get_submodule_config () {
212         name="$1"
213         option="$2"
214         default="$3"
215         value=$(git config submodule."$name"."$option")
216         if test -z "$value"
217         then
218                 value=$(git config -f .gitmodules submodule."$name"."$option")
219         fi
220         printf '%s' "${value:-$default}"
221 }
222
223
224 #
225 # Map submodule path to submodule name
226 #
227 # $1 = path
228 #
229 module_name()
230 {
231         # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
232         sm_path="$1"
233         re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
234         name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
235                 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
236         test -z "$name" &&
237         die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$sm_path'")"
238         echo "$name"
239 }
240
241 #
242 # Clone a submodule
243 #
244 # Prior to calling, cmd_update checks that a possibly existing
245 # path is not a git repository.
246 # Likewise, cmd_add checks that path does not exist at all,
247 # since it is the location of a new submodule.
248 #
249 module_clone()
250 {
251         sm_path=$1
252         name=$2
253         url=$3
254         reference="$4"
255         depth="$5"
256         quiet=
257         if test -n "$GIT_QUIET"
258         then
259                 quiet=-q
260         fi
261
262         gitdir=
263         gitdir_base=
264         base_name=$(dirname "$name")
265
266         gitdir=$(git rev-parse --git-dir)
267         gitdir_base="$gitdir/modules/$base_name"
268         gitdir="$gitdir/modules/$name"
269
270         if test -d "$gitdir"
271         then
272                 mkdir -p "$sm_path"
273                 rm -f "$gitdir/index"
274         else
275                 mkdir -p "$gitdir_base"
276                 (
277                         clear_local_git_env
278                         git clone $quiet ${depth:+"$depth"} -n ${reference:+"$reference"} \
279                                 --separate-git-dir "$gitdir" "$url" "$sm_path"
280                 ) ||
281                 die "$(eval_gettext "Clone of '\$url' into submodule path '\$sm_path' failed")"
282         fi
283
284         # We already are at the root of the work tree but cd_to_toplevel will
285         # resolve any symlinks that might be present in $PWD
286         a=$(cd_to_toplevel && cd "$gitdir" && pwd)/
287         b=$(cd_to_toplevel && cd "$sm_path" && pwd)/
288         # normalize Windows-style absolute paths to POSIX-style absolute paths
289         case $a in [a-zA-Z]:/*) a=/${a%%:*}${a#*:} ;; esac
290         case $b in [a-zA-Z]:/*) b=/${b%%:*}${b#*:} ;; esac
291         # Remove all common leading directories after a sanity check
292         if test "${a#$b}" != "$a" || test "${b#$a}" != "$b"; then
293                 die "$(eval_gettext "Gitdir '\$a' is part of the submodule path '\$b' or vice versa")"
294         fi
295         while test "${a%%/*}" = "${b%%/*}"
296         do
297                 a=${a#*/}
298                 b=${b#*/}
299         done
300         # Now chop off the trailing '/'s that were added in the beginning
301         a=${a%/}
302         b=${b%/}
303
304         # Turn each leading "*/" component into "../"
305         rel=$(echo $b | sed -e 's|[^/][^/]*|..|g')
306         echo "gitdir: $rel/$a" >"$sm_path/.git"
307
308         rel=$(echo $a | sed -e 's|[^/][^/]*|..|g')
309         (clear_local_git_env; cd "$sm_path" && GIT_WORK_TREE=. git config core.worktree "$rel/$b")
310 }
311
312 isnumber()
313 {
314         n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
315 }
316
317 #
318 # Add a new submodule to the working tree, .gitmodules and the index
319 #
320 # $@ = repo path
321 #
322 # optional branch is stored in global branch variable
323 #
324 cmd_add()
325 {
326         # parse $args after "submodule ... add".
327         reference_path=
328         while test $# -ne 0
329         do
330                 case "$1" in
331                 -b | --branch)
332                         case "$2" in '') usage ;; esac
333                         branch=$2
334                         shift
335                         ;;
336                 -f | --force)
337                         force=$1
338                         ;;
339                 -q|--quiet)
340                         GIT_QUIET=1
341                         ;;
342                 --reference)
343                         case "$2" in '') usage ;; esac
344                         reference_path=$2
345                         shift
346                         ;;
347                 --reference=*)
348                         reference_path="${1#--reference=}"
349                         ;;
350                 --name)
351                         case "$2" in '') usage ;; esac
352                         custom_name=$2
353                         shift
354                         ;;
355                 --depth)
356                         case "$2" in '') usage ;; esac
357                         depth="--depth=$2"
358                         shift
359                         ;;
360                 --depth=*)
361                         depth=$1
362                         ;;
363                 --)
364                         shift
365                         break
366                         ;;
367                 -*)
368                         usage
369                         ;;
370                 *)
371                         break
372                         ;;
373                 esac
374                 shift
375         done
376
377         if test -n "$reference_path"
378         then
379                 is_absolute_path "$reference_path" ||
380                 reference_path="$wt_prefix$reference_path"
381
382                 reference="--reference=$reference_path"
383         fi
384
385         repo=$1
386         sm_path=$2
387
388         if test -z "$sm_path"; then
389                 sm_path=$(echo "$repo" |
390                         sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
391         fi
392
393         if test -z "$repo" -o -z "$sm_path"; then
394                 usage
395         fi
396
397         is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
398
399         # assure repo is absolute or relative to parent
400         case "$repo" in
401         ./*|../*)
402                 test -z "$wt_prefix" ||
403                 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
404
405                 # dereference source url relative to parent's url
406                 realrepo=$(resolve_relative_url "$repo") || exit
407                 ;;
408         *:*|/*)
409                 # absolute url
410                 realrepo=$repo
411                 ;;
412         *)
413                 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
414         ;;
415         esac
416
417         # normalize path:
418         # multiple //; leading ./; /./; /../; trailing /
419         sm_path=$(printf '%s/\n' "$sm_path" |
420                 sed -e '
421                         s|//*|/|g
422                         s|^\(\./\)*||
423                         s|/\./|/|g
424                         :start
425                         s|\([^/]*\)/\.\./||
426                         tstart
427                         s|/*$||
428                 ')
429         git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
430         die "$(eval_gettext "'\$sm_path' already exists in the index")"
431
432         if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
433         then
434                 eval_gettextln "The following path is ignored by one of your .gitignore files:
435 \$sm_path
436 Use -f if you really want to add it." >&2
437                 exit 1
438         fi
439
440         if test -n "$custom_name"
441         then
442                 sm_name="$custom_name"
443         else
444                 sm_name="$sm_path"
445         fi
446
447         # perhaps the path exists and is already a git repo, else clone it
448         if test -e "$sm_path"
449         then
450                 if test -d "$sm_path"/.git -o -f "$sm_path"/.git
451                 then
452                         eval_gettextln "Adding existing repo at '\$sm_path' to the index"
453                 else
454                         die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
455                 fi
456
457         else
458                 if test -d ".git/modules/$sm_name"
459                 then
460                         if test -z "$force"
461                         then
462                                 echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
463                                 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^,"  ", -e s,' (fetch)',, >&2
464                                 echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
465                                 echo >&2 "  $realrepo"
466                                 echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
467                                 die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
468                         else
469                                 echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
470                         fi
471                 fi
472                 module_clone "$sm_path" "$sm_name" "$realrepo" "$reference" "$depth" || exit
473                 (
474                         clear_local_git_env
475                         cd "$sm_path" &&
476                         # ash fails to wordsplit ${branch:+-b "$branch"...}
477                         case "$branch" in
478                         '') git checkout -f -q ;;
479                         ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
480                         esac
481                 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
482         fi
483         git config submodule."$sm_name".url "$realrepo"
484
485         git add $force "$sm_path" ||
486         die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
487
488         git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
489         git config -f .gitmodules submodule."$sm_name".url "$repo" &&
490         if test -n "$branch"
491         then
492                 git config -f .gitmodules submodule."$sm_name".branch "$branch"
493         fi &&
494         git add --force .gitmodules ||
495         die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
496 }
497
498 #
499 # Execute an arbitrary command sequence in each checked out
500 # submodule
501 #
502 # $@ = command to execute
503 #
504 cmd_foreach()
505 {
506         # parse $args after "submodule ... foreach".
507         while test $# -ne 0
508         do
509                 case "$1" in
510                 -q|--quiet)
511                         GIT_QUIET=1
512                         ;;
513                 --recursive)
514                         recursive=1
515                         ;;
516                 -*)
517                         usage
518                         ;;
519                 *)
520                         break
521                         ;;
522                 esac
523                 shift
524         done
525
526         toplevel=$(pwd)
527
528         # dup stdin so that it can be restored when running the external
529         # command in the subshell (and a recursive call to this function)
530         exec 3<&0
531
532         module_list |
533         while read mode sha1 stage sm_path
534         do
535                 die_if_unmatched "$mode"
536                 if test -e "$sm_path"/.git
537                 then
538                         displaypath=$(relative_path "$sm_path")
539                         say "$(eval_gettext "Entering '\$prefix\$displaypath'")"
540                         name=$(module_name "$sm_path")
541                         (
542                                 prefix="$prefix$sm_path/"
543                                 clear_local_git_env
544                                 cd "$sm_path" &&
545                                 sm_path=$(relative_path "$sm_path") &&
546                                 # we make $path available to scripts ...
547                                 path=$sm_path &&
548                                 eval "$@" &&
549                                 if test -n "$recursive"
550                                 then
551                                         cmd_foreach "--recursive" "$@"
552                                 fi
553                         ) <&3 3<&- ||
554                         die "$(eval_gettext "Stopping at '\$prefix\$displaypath'; script returned non-zero status.")"
555                 fi
556         done
557 }
558
559 #
560 # Register submodules in .git/config
561 #
562 # $@ = requested paths (default to all)
563 #
564 cmd_init()
565 {
566         # parse $args after "submodule ... init".
567         while test $# -ne 0
568         do
569                 case "$1" in
570                 -q|--quiet)
571                         GIT_QUIET=1
572                         ;;
573                 --)
574                         shift
575                         break
576                         ;;
577                 -*)
578                         usage
579                         ;;
580                 *)
581                         break
582                         ;;
583                 esac
584                 shift
585         done
586
587         module_list "$@" |
588         while read mode sha1 stage sm_path
589         do
590                 die_if_unmatched "$mode"
591                 name=$(module_name "$sm_path") || exit
592
593                 displaypath=$(relative_path "$sm_path")
594
595                 # Copy url setting when it is not set yet
596                 if test -z "$(git config "submodule.$name.url")"
597                 then
598                         url=$(git config -f .gitmodules submodule."$name".url)
599                         test -z "$url" &&
600                         die "$(eval_gettext "No url found for submodule path '\$displaypath' in .gitmodules")"
601
602                         # Possibly a url relative to parent
603                         case "$url" in
604                         ./*|../*)
605                                 url=$(resolve_relative_url "$url") || exit
606                                 ;;
607                         esac
608                         git config submodule."$name".url "$url" ||
609                         die "$(eval_gettext "Failed to register url for submodule path '\$displaypath'")"
610
611                         say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$displaypath'")"
612                 fi
613
614                 # Copy "update" setting when it is not set yet
615                 upd="$(git config -f .gitmodules submodule."$name".update)"
616                 test -z "$upd" ||
617                 test -n "$(git config submodule."$name".update)" ||
618                 git config submodule."$name".update "$upd" ||
619                 die "$(eval_gettext "Failed to register update mode for submodule path '\$displaypath'")"
620         done
621 }
622
623 #
624 # Unregister submodules from .git/config and remove their work tree
625 #
626 # $@ = requested paths (use '.' to deinit all submodules)
627 #
628 cmd_deinit()
629 {
630         # parse $args after "submodule ... deinit".
631         while test $# -ne 0
632         do
633                 case "$1" in
634                 -f|--force)
635                         force=$1
636                         ;;
637                 -q|--quiet)
638                         GIT_QUIET=1
639                         ;;
640                 --)
641                         shift
642                         break
643                         ;;
644                 -*)
645                         usage
646                         ;;
647                 *)
648                         break
649                         ;;
650                 esac
651                 shift
652         done
653
654         if test $# = 0
655         then
656                 die "$(eval_gettext "Use '.' if you really want to deinitialize all submodules")"
657         fi
658
659         module_list "$@" |
660         while read mode sha1 stage sm_path
661         do
662                 die_if_unmatched "$mode"
663                 name=$(module_name "$sm_path") || exit
664
665                 displaypath=$(relative_path "$sm_path")
666
667                 # Remove the submodule work tree (unless the user already did it)
668                 if test -d "$sm_path"
669                 then
670                         # Protect submodules containing a .git directory
671                         if test -d "$sm_path/.git"
672                         then
673                                 echo >&2 "$(eval_gettext "Submodule work tree '\$displaypath' contains a .git directory")"
674                                 die "$(eval_gettext "(use 'rm -rf' if you really want to remove it including all of its history)")"
675                         fi
676
677                         if test -z "$force"
678                         then
679                                 git rm -qn "$sm_path" ||
680                                 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
681                         fi
682                         rm -rf "$sm_path" &&
683                         say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
684                         say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
685                 fi
686
687                 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
688
689                 # Remove the .git/config entries (unless the user already did it)
690                 if test -n "$(git config --get-regexp submodule."$name\.")"
691                 then
692                         # Remove the whole section so we have a clean state when
693                         # the user later decides to init this submodule again
694                         url=$(git config submodule."$name".url)
695                         git config --remove-section submodule."$name" 2>/dev/null &&
696                         say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
697                 fi
698         done
699 }
700
701 #
702 # Update each submodule path to correct revision, using clone and checkout as needed
703 #
704 # $@ = requested paths (default to all)
705 #
706 cmd_update()
707 {
708         # parse $args after "submodule ... update".
709         orig_flags=
710         while test $# -ne 0
711         do
712                 case "$1" in
713                 -q|--quiet)
714                         GIT_QUIET=1
715                         ;;
716                 -i|--init)
717                         init=1
718                         ;;
719                 --remote)
720                         remote=1
721                         ;;
722                 -N|--no-fetch)
723                         nofetch=1
724                         ;;
725                 -f|--force)
726                         force=$1
727                         ;;
728                 -r|--rebase)
729                         update="rebase"
730                         ;;
731                 --reference)
732                         case "$2" in '') usage ;; esac
733                         reference="--reference=$2"
734                         orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
735                         shift
736                         ;;
737                 --reference=*)
738                         reference="$1"
739                         ;;
740                 -m|--merge)
741                         update="merge"
742                         ;;
743                 --recursive)
744                         recursive=1
745                         ;;
746                 --checkout)
747                         update="checkout"
748                         ;;
749                 --depth)
750                         case "$2" in '') usage ;; esac
751                         depth="--depth=$2"
752                         shift
753                         ;;
754                 --depth=*)
755                         depth=$1
756                         ;;
757                 --)
758                         shift
759                         break
760                         ;;
761                 -*)
762                         usage
763                         ;;
764                 *)
765                         break
766                         ;;
767                 esac
768                 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
769                 shift
770         done
771
772         if test -n "$init"
773         then
774                 cmd_init "--" "$@" || return
775         fi
776
777         cloned_modules=
778         module_list "$@" | {
779         err=
780         while read mode sha1 stage sm_path
781         do
782                 die_if_unmatched "$mode"
783                 if test "$stage" = U
784                 then
785                         echo >&2 "Skipping unmerged submodule $prefix$sm_path"
786                         continue
787                 fi
788                 name=$(module_name "$sm_path") || exit
789                 url=$(git config submodule."$name".url)
790                 branch=$(get_submodule_config "$name" branch master)
791                 if ! test -z "$update"
792                 then
793                         update_module=$update
794                 else
795                         update_module=$(git config submodule."$name".update)
796                 fi
797
798                 displaypath=$(relative_path "$prefix$sm_path")
799
800                 if test "$update_module" = "none"
801                 then
802                         echo "Skipping submodule '$displaypath'"
803                         continue
804                 fi
805
806                 if test -z "$url"
807                 then
808                         # Only mention uninitialized submodules when its
809                         # path have been specified
810                         test "$#" != "0" &&
811                         say "$(eval_gettext "Submodule path '\$displaypath' not initialized
812 Maybe you want to use 'update --init'?")"
813                         continue
814                 fi
815
816                 if ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
817                 then
818                         module_clone "$sm_path" "$name" "$url" "$reference" "$depth" || exit
819                         cloned_modules="$cloned_modules;$name"
820                         subsha1=
821                 else
822                         subsha1=$(clear_local_git_env; cd "$sm_path" &&
823                                 git rev-parse --verify HEAD) ||
824                         die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
825                 fi
826
827                 if test -n "$remote"
828                 then
829                         if test -z "$nofetch"
830                         then
831                                 # Fetch remote before determining tracking $sha1
832                                 (clear_local_git_env; cd "$sm_path" && git-fetch) ||
833                                 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
834                         fi
835                         remote_name=$(clear_local_git_env; cd "$sm_path" && get_default_remote)
836                         sha1=$(clear_local_git_env; cd "$sm_path" &&
837                                 git rev-parse --verify "${remote_name}/${branch}") ||
838                         die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
839                 fi
840
841                 if test "$subsha1" != "$sha1" -o -n "$force"
842                 then
843                         subforce=$force
844                         # If we don't already have a -f flag and the submodule has never been checked out
845                         if test -z "$subsha1" -a -z "$force"
846                         then
847                                 subforce="-f"
848                         fi
849
850                         if test -z "$nofetch"
851                         then
852                                 # Run fetch only if $sha1 isn't present or it
853                                 # is not reachable from a ref.
854                                 (clear_local_git_env; cd "$sm_path" &&
855                                         ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
856                                          test -z "$rev") || git-fetch)) ||
857                                 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
858                         fi
859
860                         # Is this something we just cloned?
861                         case ";$cloned_modules;" in
862                         *";$name;"*)
863                                 # then there is no local change to integrate
864                                 update_module= ;;
865                         esac
866
867                         must_die_on_failure=
868                         case "$update_module" in
869                         rebase)
870                                 command="git rebase"
871                                 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
872                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
873                                 must_die_on_failure=yes
874                                 ;;
875                         merge)
876                                 command="git merge"
877                                 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
878                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
879                                 must_die_on_failure=yes
880                                 ;;
881                         !*)
882                                 command="${update_module#!}"
883                                 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule  path '\$prefix\$sm_path'")"
884                                 say_msg="$(eval_gettext "Submodule path '\$prefix\$sm_path': '\$command \$sha1'")"
885                                 must_die_on_failure=yes
886                                 ;;
887                         *)
888                                 command="git checkout $subforce -q"
889                                 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
890                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
891                                 ;;
892                         esac
893
894                         if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
895                         then
896                                 say "$say_msg"
897                         elif test -n "$must_die_on_failure"
898                         then
899                                 die_with_status 2 "$die_msg"
900                         else
901                                 err="${err};$die_msg"
902                                 continue
903                         fi
904                 fi
905
906                 if test -n "$recursive"
907                 then
908                         (
909                                 prefix="$prefix$sm_path/"
910                                 clear_local_git_env
911                                 cd "$sm_path" &&
912                                 eval cmd_update "$orig_flags"
913                         )
914                         res=$?
915                         if test $res -gt 0
916                         then
917                                 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
918                                 if test $res -eq 1
919                                 then
920                                         err="${err};$die_msg"
921                                         continue
922                                 else
923                                         die_with_status $res "$die_msg"
924                                 fi
925                         fi
926                 fi
927         done
928
929         if test -n "$err"
930         then
931                 OIFS=$IFS
932                 IFS=';'
933                 for e in $err
934                 do
935                         if test -n "$e"
936                         then
937                                 echo >&2 "$e"
938                         fi
939                 done
940                 IFS=$OIFS
941                 exit 1
942         fi
943         }
944 }
945
946 set_name_rev () {
947         revname=$( (
948                 clear_local_git_env
949                 cd "$1" && {
950                         git describe "$2" 2>/dev/null ||
951                         git describe --tags "$2" 2>/dev/null ||
952                         git describe --contains "$2" 2>/dev/null ||
953                         git describe --all --always "$2"
954                 }
955         ) )
956         test -z "$revname" || revname=" ($revname)"
957 }
958 #
959 # Show commit summary for submodules in index or working tree
960 #
961 # If '--cached' is given, show summary between index and given commit,
962 # or between working tree and given commit
963 #
964 # $@ = [commit (default 'HEAD'),] requested paths (default all)
965 #
966 cmd_summary() {
967         summary_limit=-1
968         for_status=
969         diff_cmd=diff-index
970
971         # parse $args after "submodule ... summary".
972         while test $# -ne 0
973         do
974                 case "$1" in
975                 --cached)
976                         cached="$1"
977                         ;;
978                 --files)
979                         files="$1"
980                         ;;
981                 --for-status)
982                         for_status="$1"
983                         ;;
984                 -n|--summary-limit)
985                         summary_limit="$2"
986                         isnumber "$summary_limit" || usage
987                         shift
988                         ;;
989                 --summary-limit=*)
990                         summary_limit="${1#--summary-limit=}"
991                         isnumber "$summary_limit" || usage
992                         ;;
993                 --)
994                         shift
995                         break
996                         ;;
997                 -*)
998                         usage
999                         ;;
1000                 *)
1001                         break
1002                         ;;
1003                 esac
1004                 shift
1005         done
1006
1007         test $summary_limit = 0 && return
1008
1009         if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
1010         then
1011                 head=$rev
1012                 test $# = 0 || shift
1013         elif test -z "$1" -o "$1" = "HEAD"
1014         then
1015                 # before the first commit: compare with an empty tree
1016                 head=$(git hash-object -w -t tree --stdin </dev/null)
1017                 test -z "$1" || shift
1018         else
1019                 head="HEAD"
1020         fi
1021
1022         if [ -n "$files" ]
1023         then
1024                 test -n "$cached" &&
1025                 die "$(gettext "The --cached option cannot be used with the --files option")"
1026                 diff_cmd=diff-files
1027                 head=
1028         fi
1029
1030         cd_to_toplevel
1031         eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
1032         # Get modified modules cared by user
1033         modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
1034                 sane_egrep '^:([0-7]* )?160000' |
1035                 while read mod_src mod_dst sha1_src sha1_dst status name
1036                 do
1037                         # Always show modules deleted or type-changed (blob<->module)
1038                         test $status = D -o $status = T && echo "$name" && continue
1039                         # Also show added or modified modules which are checked out
1040                         GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
1041                         echo "$name"
1042                 done
1043         )
1044
1045         test -z "$modules" && return
1046
1047         git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
1048         sane_egrep '^:([0-7]* )?160000' |
1049         cut -c2- |
1050         while read mod_src mod_dst sha1_src sha1_dst status name
1051         do
1052                 if test -z "$cached" &&
1053                         test $sha1_dst = 0000000000000000000000000000000000000000
1054                 then
1055                         case "$mod_dst" in
1056                         160000)
1057                                 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
1058                                 ;;
1059                         100644 | 100755 | 120000)
1060                                 sha1_dst=$(git hash-object $name)
1061                                 ;;
1062                         000000)
1063                                 ;; # removed
1064                         *)
1065                                 # unexpected type
1066                                 eval_gettextln "unexpected mode \$mod_dst" >&2
1067                                 continue ;;
1068                         esac
1069                 fi
1070                 missing_src=
1071                 missing_dst=
1072
1073                 test $mod_src = 160000 &&
1074                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
1075                 missing_src=t
1076
1077                 test $mod_dst = 160000 &&
1078                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
1079                 missing_dst=t
1080
1081                 display_name=$(relative_path "$name")
1082
1083                 total_commits=
1084                 case "$missing_src,$missing_dst" in
1085                 t,)
1086                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_src")"
1087                         ;;
1088                 ,t)
1089                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_dst")"
1090                         ;;
1091                 t,t)
1092                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
1093                         ;;
1094                 *)
1095                         errmsg=
1096                         total_commits=$(
1097                         if test $mod_src = 160000 -a $mod_dst = 160000
1098                         then
1099                                 range="$sha1_src...$sha1_dst"
1100                         elif test $mod_src = 160000
1101                         then
1102                                 range=$sha1_src
1103                         else
1104                                 range=$sha1_dst
1105                         fi
1106                         GIT_DIR="$name/.git" \
1107                         git rev-list --first-parent $range -- | wc -l
1108                         )
1109                         total_commits=" ($(($total_commits + 0)))"
1110                         ;;
1111                 esac
1112
1113                 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
1114                 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
1115                 if test $status = T
1116                 then
1117                         blob="$(gettext "blob")"
1118                         submodule="$(gettext "submodule")"
1119                         if test $mod_dst = 160000
1120                         then
1121                                 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1122                         else
1123                                 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1124                         fi
1125                 else
1126                         echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1127                 fi
1128                 if test -n "$errmsg"
1129                 then
1130                         # Don't give error msg for modification whose dst is not submodule
1131                         # i.e. deleted or changed to blob
1132                         test $mod_dst = 160000 && echo "$errmsg"
1133                 else
1134                         if test $mod_src = 160000 -a $mod_dst = 160000
1135                         then
1136                                 limit=
1137                                 test $summary_limit -gt 0 && limit="-$summary_limit"
1138                                 GIT_DIR="$name/.git" \
1139                                 git log $limit --pretty='format:  %m %s' \
1140                                 --first-parent $sha1_src...$sha1_dst
1141                         elif test $mod_dst = 160000
1142                         then
1143                                 GIT_DIR="$name/.git" \
1144                                 git log --pretty='format:  > %s' -1 $sha1_dst
1145                         else
1146                                 GIT_DIR="$name/.git" \
1147                                 git log --pretty='format:  < %s' -1 $sha1_src
1148                         fi
1149                         echo
1150                 fi
1151                 echo
1152         done
1153 }
1154 #
1155 # List all submodules, prefixed with:
1156 #  - submodule not initialized
1157 #  + different revision checked out
1158 #
1159 # If --cached was specified the revision in the index will be printed
1160 # instead of the currently checked out revision.
1161 #
1162 # $@ = requested paths (default to all)
1163 #
1164 cmd_status()
1165 {
1166         # parse $args after "submodule ... status".
1167         while test $# -ne 0
1168         do
1169                 case "$1" in
1170                 -q|--quiet)
1171                         GIT_QUIET=1
1172                         ;;
1173                 --cached)
1174                         cached=1
1175                         ;;
1176                 --recursive)
1177                         recursive=1
1178                         ;;
1179                 --)
1180                         shift
1181                         break
1182                         ;;
1183                 -*)
1184                         usage
1185                         ;;
1186                 *)
1187                         break
1188                         ;;
1189                 esac
1190                 shift
1191         done
1192
1193         module_list "$@" |
1194         while read mode sha1 stage sm_path
1195         do
1196                 die_if_unmatched "$mode"
1197                 name=$(module_name "$sm_path") || exit
1198                 url=$(git config submodule."$name".url)
1199                 displaypath=$(relative_path "$prefix$sm_path")
1200                 if test "$stage" = U
1201                 then
1202                         say "U$sha1 $displaypath"
1203                         continue
1204                 fi
1205                 if test -z "$url" || ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
1206                 then
1207                         say "-$sha1 $displaypath"
1208                         continue;
1209                 fi
1210                 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1211                 then
1212                         set_name_rev "$sm_path" "$sha1"
1213                         say " $sha1 $displaypath$revname"
1214                 else
1215                         if test -z "$cached"
1216                         then
1217                                 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1218                         fi
1219                         set_name_rev "$sm_path" "$sha1"
1220                         say "+$sha1 $displaypath$revname"
1221                 fi
1222
1223                 if test -n "$recursive"
1224                 then
1225                         (
1226                                 prefix="$displaypath/"
1227                                 clear_local_git_env
1228                                 cd "$sm_path" &&
1229                                 eval cmd_status
1230                         ) ||
1231                         die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1232                 fi
1233         done
1234 }
1235 #
1236 # Sync remote urls for submodules
1237 # This makes the value for remote.$remote.url match the value
1238 # specified in .gitmodules.
1239 #
1240 cmd_sync()
1241 {
1242         while test $# -ne 0
1243         do
1244                 case "$1" in
1245                 -q|--quiet)
1246                         GIT_QUIET=1
1247                         shift
1248                         ;;
1249                 --recursive)
1250                         recursive=1
1251                         shift
1252                         ;;
1253                 --)
1254                         shift
1255                         break
1256                         ;;
1257                 -*)
1258                         usage
1259                         ;;
1260                 *)
1261                         break
1262                         ;;
1263                 esac
1264         done
1265         cd_to_toplevel
1266         module_list "$@" |
1267         while read mode sha1 stage sm_path
1268         do
1269                 die_if_unmatched "$mode"
1270                 name=$(module_name "$sm_path")
1271                 url=$(git config -f .gitmodules --get submodule."$name".url)
1272
1273                 # Possibly a url relative to parent
1274                 case "$url" in
1275                 ./*|../*)
1276                         # rewrite foo/bar as ../.. to find path from
1277                         # submodule work tree to superproject work tree
1278                         up_path="$(echo "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1279                         # guarantee a trailing /
1280                         up_path=${up_path%/}/ &&
1281                         # path from submodule work tree to submodule origin repo
1282                         sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1283                         # path from superproject work tree to submodule origin repo
1284                         super_config_url=$(resolve_relative_url "$url") || exit
1285                         ;;
1286                 *)
1287                         sub_origin_url="$url"
1288                         super_config_url="$url"
1289                         ;;
1290                 esac
1291
1292                 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1293                 then
1294                         displaypath=$(relative_path "$prefix$sm_path")
1295                         say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1296                         git config submodule."$name".url "$super_config_url"
1297
1298                         if test -e "$sm_path"/.git
1299                         then
1300                         (
1301                                 clear_local_git_env
1302                                 cd "$sm_path"
1303                                 remote=$(get_default_remote)
1304                                 git config remote."$remote".url "$sub_origin_url"
1305
1306                                 if test -n "$recursive"
1307                                 then
1308                                         prefix="$prefix$sm_path/"
1309                                         eval cmd_sync
1310                                 fi
1311                         )
1312                         fi
1313                 fi
1314         done
1315 }
1316
1317 # This loop parses the command line arguments to find the
1318 # subcommand name to dispatch.  Parsing of the subcommand specific
1319 # options are primarily done by the subcommand implementations.
1320 # Subcommand specific options such as --branch and --cached are
1321 # parsed here as well, for backward compatibility.
1322
1323 while test $# != 0 && test -z "$command"
1324 do
1325         case "$1" in
1326         add | foreach | init | deinit | update | status | summary | sync)
1327                 command=$1
1328                 ;;
1329         -q|--quiet)
1330                 GIT_QUIET=1
1331                 ;;
1332         -b|--branch)
1333                 case "$2" in
1334                 '')
1335                         usage
1336                         ;;
1337                 esac
1338                 branch="$2"; shift
1339                 ;;
1340         --cached)
1341                 cached="$1"
1342                 ;;
1343         --)
1344                 break
1345                 ;;
1346         -*)
1347                 usage
1348                 ;;
1349         *)
1350                 break
1351                 ;;
1352         esac
1353         shift
1354 done
1355
1356 # No command word defaults to "status"
1357 if test -z "$command"
1358 then
1359     if test $# = 0
1360     then
1361         command=status
1362     else
1363         usage
1364     fi
1365 fi
1366
1367 # "-b branch" is accepted only by "add"
1368 if test -n "$branch" && test "$command" != add
1369 then
1370         usage
1371 fi
1372
1373 # "--cached" is accepted only by "status" and "summary"
1374 if test -n "$cached" && test "$command" != status -a "$command" != summary
1375 then
1376         usage
1377 fi
1378
1379 "cmd_$command" "$@"