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