1#!/bin/sh
2#
3# git-submodule.sh: add, init, update or list git submodules
4#
5# Copyright (c) 2007 Lars Hjemli
6dashless=$(basename "$0" | sed -e 's/-/ /')
8USAGE="[--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>...]"
16OPTIONS_SPEC=
17SUBDIRECTORY_OK=Yes
18. git-sh-setup
19. git-parse-remote
20require_work_tree
21wt_prefix=$(git rev-parse --show-prefix)
22cd_to_toplevel
23# 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}
31export GIT_ALLOW_PROTOCOL
32command=
34branch=
35force=
36reference=
37cached=
38recursive=
39init=
40files=
41remote=
42nofetch=
43update=
44prefix=
45custom_name=
46depth=
47die_if_unmatched ()
49{
50 if test "$1" = "#unmatched"
51 then
52 exit ${2:-1}
53 fi
54}
55#
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#
69get_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}
80isnumber()
82{
83 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
84}
85# 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.
89sanitize_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#
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#
104cmd_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 if test -n "$reference_path"
158 then
159 is_absolute_path "$reference_path" ||
160 reference_path="$wt_prefix$reference_path"
161 reference="--reference=$reference_path"
163 fi
164 repo=$1
166 sm_path=$2
167 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 if test -z "$repo" || test -z "$sm_path"; then
174 usage
175 fi
176 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
178 # 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 # 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 # 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 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
216Use -f if you really want to add it." >&2
217 exit 1
218 fi
219 if test -n "$custom_name"
221 then
222 sm_name="$custom_name"
223 else
224 sm_name="$sm_path"
225 fi
226 # 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 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 "\
245If you want to reuse this local git directory instead of cloning again from
246 \$realrepo
247use the '--force' option. If the local git directory is not the correct repo
248or 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 git add $force "$sm_path" ||
267 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
268 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#
280# Execute an arbitrary command sequence in each checked out
281# submodule
282#
283# $@ = command to execute
284#
285cmd_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 toplevel=$(pwd)
308 # 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 {
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" "$sha1"
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#
349# Register submodules in .git/config
350#
351# $@ = requested paths (default to all)
352#
353cmd_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 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper init ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} "$@"
377}
378#
380# Unregister submodules from .git/config and remove their work tree
381#
382cmd_deinit()
383{
384 # parse $args after "submodule ... deinit".
385 deinit_all=
386 while test $# -ne 0
387 do
388 case "$1" in
389 -f|--force)
390 force=$1
391 ;;
392 -q|--quiet)
393 GIT_QUIET=1
394 ;;
395 --all)
396 deinit_all=t
397 ;;
398 --)
399 shift
400 break
401 ;;
402 -*)
403 usage
404 ;;
405 *)
406 break
407 ;;
408 esac
409 shift
410 done
411 if test -n "$deinit_all" && test "$#" -ne 0
413 then
414 echo >&2 "$(eval_gettext "pathspec and --all are incompatible")"
415 usage
416 fi
417 if test $# = 0 && test -z "$deinit_all"
418 then
419 die "$(eval_gettext "Use '--all' if you really want to deinitialize all submodules")"
420 fi
421 {
423 git submodule--helper list --prefix "$wt_prefix" "$@" ||
424 echo "#unmatched" $?
425 } |
426 while read mode sha1 stage sm_path
427 do
428 die_if_unmatched "$mode" "$sha1"
429 name=$(git submodule--helper name "$sm_path") || exit
430 displaypath=$(git submodule--helper relative-path "$sm_path" "$wt_prefix")
432 # Remove the submodule work tree (unless the user already did it)
434 if test -d "$sm_path"
435 then
436 # Protect submodules containing a .git directory
437 if test -d "$sm_path/.git"
438 then
439 die "$(eval_gettext "\
440Submodule work tree '\$displaypath' contains a .git directory
441(use 'rm -rf' if you really want to remove it including all of its history)")"
442 fi
443 if test -z "$force"
445 then
446 git rm -qn "$sm_path" ||
447 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
448 fi
449 rm -rf "$sm_path" &&
450 say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
451 say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
452 fi
453 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
455 # Remove the .git/config entries (unless the user already did it)
457 if test -n "$(git config --get-regexp submodule."$name\.")"
458 then
459 # Remove the whole section so we have a clean state when
460 # the user later decides to init this submodule again
461 url=$(git config submodule."$name".url)
462 git config --remove-section submodule."$name" 2>/dev/null &&
463 say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
464 fi
465 done
466}
467is_tip_reachable () (
469 sanitize_submodule_env &&
470 cd "$1" &&
471 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
472 test -z "$rev"
473)
474fetch_in_submodule () (
476 sanitize_submodule_env &&
477 cd "$1" &&
478 case "$2" in
479 '')
480 git fetch ;;
481 *)
482 shift
483 git fetch $(get_default_remote) "$@" ;;
484 esac
485)
486#
488# Update each submodule path to correct revision, using clone and checkout as needed
489#
490# $@ = requested paths (default to all)
491#
492cmd_update()
493{
494 # parse $args after "submodule ... update".
495 while test $# -ne 0
496 do
497 case "$1" in
498 -q|--quiet)
499 GIT_QUIET=1
500 ;;
501 -i|--init)
502 init=1
503 ;;
504 --remote)
505 remote=1
506 ;;
507 -N|--no-fetch)
508 nofetch=1
509 ;;
510 -f|--force)
511 force=$1
512 ;;
513 -r|--rebase)
514 update="rebase"
515 ;;
516 --reference)
517 case "$2" in '') usage ;; esac
518 reference="--reference=$2"
519 shift
520 ;;
521 --reference=*)
522 reference="$1"
523 ;;
524 -m|--merge)
525 update="merge"
526 ;;
527 --recursive)
528 recursive=1
529 ;;
530 --checkout)
531 update="checkout"
532 ;;
533 --recommend-shallow)
534 recommend_shallow="--recommend-shallow"
535 ;;
536 --no-recommend-shallow)
537 recommend_shallow="--no-recommend-shallow"
538 ;;
539 --depth)
540 case "$2" in '') usage ;; esac
541 depth="--depth=$2"
542 shift
543 ;;
544 --depth=*)
545 depth=$1
546 ;;
547 -j|--jobs)
548 case "$2" in '') usage ;; esac
549 jobs="--jobs=$2"
550 shift
551 ;;
552 --jobs=*)
553 jobs=$1
554 ;;
555 --)
556 shift
557 break
558 ;;
559 -*)
560 usage
561 ;;
562 *)
563 break
564 ;;
565 esac
566 shift
567 done
568 if test -n "$init"
570 then
571 cmd_init "--" "$@" || return
572 fi
573 {
575 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
576 ${wt_prefix:+--prefix "$wt_prefix"} \
577 ${prefix:+--recursive-prefix "$prefix"} \
578 ${update:+--update "$update"} \
579 ${reference:+"$reference"} \
580 ${depth:+--depth "$depth"} \
581 ${recommend_shallow:+"$recommend_shallow"} \
582 ${jobs:+$jobs} \
583 "$@" || echo "#unmatched" $?
584 } | {
585 err=
586 while read mode sha1 stage just_cloned sm_path
587 do
588 die_if_unmatched "$mode" "$sha1"
589 name=$(git submodule--helper name "$sm_path") || exit
591 url=$(git config submodule."$name".url)
592 if ! test -z "$update"
593 then
594 update_module=$update
595 else
596 update_module=$(git config submodule."$name".update)
597 if test -z "$update_module"
598 then
599 update_module="checkout"
600 fi
601 fi
602 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
604 if test $just_cloned -eq 1
606 then
607 subsha1=
608 update_module=checkout
609 else
610 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
611 git rev-parse --verify HEAD) ||
612 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
613 fi
614 if test -n "$remote"
616 then
617 branch=$(git submodule--helper remote-branch "$sm_path")
618 if test -z "$nofetch"
619 then
620 # Fetch remote before determining tracking $sha1
621 fetch_in_submodule "$sm_path" $depth ||
622 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
623 fi
624 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
625 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
626 git rev-parse --verify "${remote_name}/${branch}") ||
627 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
628 fi
629 if test "$subsha1" != "$sha1" || test -n "$force"
631 then
632 subforce=$force
633 # If we don't already have a -f flag and the submodule has never been checked out
634 if test -z "$subsha1" && test -z "$force"
635 then
636 subforce="-f"
637 fi
638 if test -z "$nofetch"
640 then
641 # Run fetch only if $sha1 isn't present or it
642 # is not reachable from a ref.
643 is_tip_reachable "$sm_path" "$sha1" ||
644 fetch_in_submodule "$sm_path" $depth ||
645 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
646 # Now we tried the usual fetch, but $sha1 may
648 # not be reachable from any of the refs
649 is_tip_reachable "$sm_path" "$sha1" ||
650 fetch_in_submodule "$sm_path" $depth "$sha1" ||
651 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
652 fi
653 must_die_on_failure=
655 case "$update_module" in
656 checkout)
657 command="git checkout $subforce -q"
658 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
659 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
660 ;;
661 rebase)
662 command="git rebase"
663 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
664 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
665 must_die_on_failure=yes
666 ;;
667 merge)
668 command="git merge"
669 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
670 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
671 must_die_on_failure=yes
672 ;;
673 !*)
674 command="${update_module#!}"
675 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
676 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
677 must_die_on_failure=yes
678 ;;
679 *)
680 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
681 esac
682 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
684 then
685 say "$say_msg"
686 elif test -n "$must_die_on_failure"
687 then
688 die_with_status 2 "$die_msg"
689 else
690 err="${err};$die_msg"
691 continue
692 fi
693 fi
694 if test -n "$recursive"
696 then
697 (
698 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
699 wt_prefix=
700 sanitize_submodule_env
701 cd "$sm_path" &&
702 eval cmd_update
703 )
704 res=$?
705 if test $res -gt 0
706 then
707 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
708 if test $res -ne 2
709 then
710 err="${err};$die_msg"
711 continue
712 else
713 die_with_status $res "$die_msg"
714 fi
715 fi
716 fi
717 done
718 if test -n "$err"
720 then
721 OIFS=$IFS
722 IFS=';'
723 for e in $err
724 do
725 if test -n "$e"
726 then
727 echo >&2 "$e"
728 fi
729 done
730 IFS=$OIFS
731 exit 1
732 fi
733 }
734}
735set_name_rev () {
737 revname=$( (
738 sanitize_submodule_env
739 cd "$1" && {
740 git describe "$2" 2>/dev/null ||
741 git describe --tags "$2" 2>/dev/null ||
742 git describe --contains "$2" 2>/dev/null ||
743 git describe --all --always "$2"
744 }
745 ) )
746 test -z "$revname" || revname=" ($revname)"
747}
748#
749# Show commit summary for submodules in index or working tree
750#
751# If '--cached' is given, show summary between index and given commit,
752# or between working tree and given commit
753#
754# $@ = [commit (default 'HEAD'),] requested paths (default all)
755#
756cmd_summary() {
757 summary_limit=-1
758 for_status=
759 diff_cmd=diff-index
760 # parse $args after "submodule ... summary".
762 while test $# -ne 0
763 do
764 case "$1" in
765 --cached)
766 cached="$1"
767 ;;
768 --files)
769 files="$1"
770 ;;
771 --for-status)
772 for_status="$1"
773 ;;
774 -n|--summary-limit)
775 summary_limit="$2"
776 isnumber "$summary_limit" || usage
777 shift
778 ;;
779 --summary-limit=*)
780 summary_limit="${1#--summary-limit=}"
781 isnumber "$summary_limit" || usage
782 ;;
783 --)
784 shift
785 break
786 ;;
787 -*)
788 usage
789 ;;
790 *)
791 break
792 ;;
793 esac
794 shift
795 done
796 test $summary_limit = 0 && return
798 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
800 then
801 head=$rev
802 test $# = 0 || shift
803 elif test -z "$1" || test "$1" = "HEAD"
804 then
805 # before the first commit: compare with an empty tree
806 head=$(git hash-object -w -t tree --stdin </dev/null)
807 test -z "$1" || shift
808 else
809 head="HEAD"
810 fi
811 if [ -n "$files" ]
813 then
814 test -n "$cached" &&
815 die "$(gettext "The --cached option cannot be used with the --files option")"
816 diff_cmd=diff-files
817 head=
818 fi
819 cd_to_toplevel
821 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
822 # Get modified modules cared by user
823 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
824 sane_egrep '^:([0-7]* )?160000' |
825 while read mod_src mod_dst sha1_src sha1_dst status sm_path
826 do
827 # Always show modules deleted or type-changed (blob<->module)
828 if test "$status" = D || test "$status" = T
829 then
830 printf '%s\n' "$sm_path"
831 continue
832 fi
833 # Respect the ignore setting for --for-status.
834 if test -n "$for_status"
835 then
836 name=$(git submodule--helper name "$sm_path")
837 ignore_config=$(get_submodule_config "$name" ignore none)
838 test $status != A && test $ignore_config = all && continue
839 fi
840 # Also show added or modified modules which are checked out
841 GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
842 printf '%s\n' "$sm_path"
843 done
844 )
845 test -z "$modules" && return
847 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
849 sane_egrep '^:([0-7]* )?160000' |
850 cut -c2- |
851 while read mod_src mod_dst sha1_src sha1_dst status name
852 do
853 if test -z "$cached" &&
854 test $sha1_dst = 0000000000000000000000000000000000000000
855 then
856 case "$mod_dst" in
857 160000)
858 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
859 ;;
860 100644 | 100755 | 120000)
861 sha1_dst=$(git hash-object $name)
862 ;;
863 000000)
864 ;; # removed
865 *)
866 # unexpected type
867 eval_gettextln "unexpected mode \$mod_dst" >&2
868 continue ;;
869 esac
870 fi
871 missing_src=
872 missing_dst=
873 test $mod_src = 160000 &&
875 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
876 missing_src=t
877 test $mod_dst = 160000 &&
879 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
880 missing_dst=t
881 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
883 total_commits=
885 case "$missing_src,$missing_dst" in
886 t,)
887 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
888 ;;
889 ,t)
890 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
891 ;;
892 t,t)
893 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
894 ;;
895 *)
896 errmsg=
897 total_commits=$(
898 if test $mod_src = 160000 && test $mod_dst = 160000
899 then
900 range="$sha1_src...$sha1_dst"
901 elif test $mod_src = 160000
902 then
903 range=$sha1_src
904 else
905 range=$sha1_dst
906 fi
907 GIT_DIR="$name/.git" \
908 git rev-list --first-parent $range -- | wc -l
909 )
910 total_commits=" ($(($total_commits + 0)))"
911 ;;
912 esac
913 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
915 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
916 if test $status = T
917 then
918 blob="$(gettext "blob")"
919 submodule="$(gettext "submodule")"
920 if test $mod_dst = 160000
921 then
922 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
923 else
924 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
925 fi
926 else
927 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
928 fi
929 if test -n "$errmsg"
930 then
931 # Don't give error msg for modification whose dst is not submodule
932 # i.e. deleted or changed to blob
933 test $mod_dst = 160000 && echo "$errmsg"
934 else
935 if test $mod_src = 160000 && test $mod_dst = 160000
936 then
937 limit=
938 test $summary_limit -gt 0 && limit="-$summary_limit"
939 GIT_DIR="$name/.git" \
940 git log $limit --pretty='format: %m %s' \
941 --first-parent $sha1_src...$sha1_dst
942 elif test $mod_dst = 160000
943 then
944 GIT_DIR="$name/.git" \
945 git log --pretty='format: > %s' -1 $sha1_dst
946 else
947 GIT_DIR="$name/.git" \
948 git log --pretty='format: < %s' -1 $sha1_src
949 fi
950 echo
951 fi
952 echo
953 done
954}
955#
956# List all submodules, prefixed with:
957# - submodule not initialized
958# + different revision checked out
959#
960# If --cached was specified the revision in the index will be printed
961# instead of the currently checked out revision.
962#
963# $@ = requested paths (default to all)
964#
965cmd_status()
966{
967 # parse $args after "submodule ... status".
968 while test $# -ne 0
969 do
970 case "$1" in
971 -q|--quiet)
972 GIT_QUIET=1
973 ;;
974 --cached)
975 cached=1
976 ;;
977 --recursive)
978 recursive=1
979 ;;
980 --)
981 shift
982 break
983 ;;
984 -*)
985 usage
986 ;;
987 *)
988 break
989 ;;
990 esac
991 shift
992 done
993 {
995 git submodule--helper list --prefix "$wt_prefix" "$@" ||
996 echo "#unmatched" $?
997 } |
998 while read mode sha1 stage sm_path
999 do
1000 die_if_unmatched "$mode" "$sha1"
1001 name=$(git submodule--helper name "$sm_path") || exit
1002 url=$(git config submodule."$name".url)
1003 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
1004 if test "$stage" = U
1005 then
1006 say "U$sha1 $displaypath"
1007 continue
1008 fi
1009 if test -z "$url" ||
1010 {
1011 ! test -d "$sm_path"/.git &&
1012 ! test -f "$sm_path"/.git
1013 }
1014 then
1015 say "-$sha1 $displaypath"
1016 continue;
1017 fi
1018 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1019 then
1020 set_name_rev "$sm_path" "$sha1"
1021 say " $sha1 $displaypath$revname"
1022 else
1023 if test -z "$cached"
1024 then
1025 sha1=$(sanitize_submodule_env; cd "$sm_path" && git rev-parse --verify HEAD)
1026 fi
1027 set_name_rev "$sm_path" "$sha1"
1028 say "+$sha1 $displaypath$revname"
1029 fi
1030 if test -n "$recursive"
1032 then
1033 (
1034 prefix="$displaypath/"
1035 sanitize_submodule_env
1036 wt_prefix=
1037 cd "$sm_path" &&
1038 eval cmd_status
1039 ) ||
1040 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1041 fi
1042 done
1043}
1044#
1045# Sync remote urls for submodules
1046# This makes the value for remote.$remote.url match the value
1047# specified in .gitmodules.
1048#
1049cmd_sync()
1050{
1051 while test $# -ne 0
1052 do
1053 case "$1" in
1054 -q|--quiet)
1055 GIT_QUIET=1
1056 shift
1057 ;;
1058 --recursive)
1059 recursive=1
1060 shift
1061 ;;
1062 --)
1063 shift
1064 break
1065 ;;
1066 -*)
1067 usage
1068 ;;
1069 *)
1070 break
1071 ;;
1072 esac
1073 done
1074 cd_to_toplevel
1075 {
1076 git submodule--helper list --prefix "$wt_prefix" "$@" ||
1077 echo "#unmatched" $?
1078 } |
1079 while read mode sha1 stage sm_path
1080 do
1081 die_if_unmatched "$mode" "$sha1"
1082 name=$(git submodule--helper name "$sm_path")
1083 url=$(git config -f .gitmodules --get submodule."$name".url)
1084 # Possibly a url relative to parent
1086 case "$url" in
1087 ./*|../*)
1088 # rewrite foo/bar as ../.. to find path from
1089 # submodule work tree to superproject work tree
1090 up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1091 # guarantee a trailing /
1092 up_path=${up_path%/}/ &&
1093 # path from submodule work tree to submodule origin repo
1094 sub_origin_url=$(git submodule--helper resolve-relative-url "$url" "$up_path") &&
1095 # path from superproject work tree to submodule origin repo
1096 super_config_url=$(git submodule--helper resolve-relative-url "$url") || exit
1097 ;;
1098 *)
1099 sub_origin_url="$url"
1100 super_config_url="$url"
1101 ;;
1102 esac
1103 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1105 then
1106 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
1107 say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1108 git config submodule."$name".url "$super_config_url"
1109 if test -e "$sm_path"/.git
1111 then
1112 (
1113 sanitize_submodule_env
1114 cd "$sm_path"
1115 remote=$(get_default_remote)
1116 git config remote."$remote".url "$sub_origin_url"
1117 if test -n "$recursive"
1119 then
1120 prefix="$prefix$sm_path/"
1121 eval cmd_sync
1122 fi
1123 )
1124 fi
1125 fi
1126 done
1127}
1128# This loop parses the command line arguments to find the
1130# subcommand name to dispatch. Parsing of the subcommand specific
1131# options are primarily done by the subcommand implementations.
1132# Subcommand specific options such as --branch and --cached are
1133# parsed here as well, for backward compatibility.
1134while test $# != 0 && test -z "$command"
1136do
1137 case "$1" in
1138 add | foreach | init | deinit | update | status | summary | sync)
1139 command=$1
1140 ;;
1141 -q|--quiet)
1142 GIT_QUIET=1
1143 ;;
1144 -b|--branch)
1145 case "$2" in
1146 '')
1147 usage
1148 ;;
1149 esac
1150 branch="$2"; shift
1151 ;;
1152 --cached)
1153 cached="$1"
1154 ;;
1155 --)
1156 break
1157 ;;
1158 -*)
1159 usage
1160 ;;
1161 *)
1162 break
1163 ;;
1164 esac
1165 shift
1166done
1167# No command word defaults to "status"
1169if test -z "$command"
1170then
1171 if test $# = 0
1172 then
1173 command=status
1174 else
1175 usage
1176 fi
1177fi
1178# "-b branch" is accepted only by "add"
1180if test -n "$branch" && test "$command" != add
1181then
1182 usage
1183fi
1184# "--cached" is accepted only by "status" and "summary"
1186if test -n "$cached" && test "$command" != status && test "$command" != summary
1187then
1188 usage
1189fi
1190"cmd_$command" "$@"