.gitignore: "git-verify-commit" is a generated file
[git.git] / git-submodule.sh
blob9245abfd4263881bdd6d0f21f648b46201b52a2d
1 #!/bin/sh
3 # git-submodule.sh: add, init, update or list git submodules
5 # Copyright (c) 2007 Lars Hjemli
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] [--checkout|--merge|--rebase] [--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-sh-i18n
20 . git-parse-remote
21 require_work_tree
22 wt_prefix=$(git rev-parse --show-prefix)
23 cd_to_toplevel
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=
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.
46 # The output of the function is the origin URL of the submodule.
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).
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 ()
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"
66 case "$remoteurl" in
67 *:*|/*)
68 is_relative=
70 ./*|../*)
71 is_relative=t
74 is_relative=t
75 remoteurl="./$remoteurl"
77 esac
79 while test -n "$url"
81 case "$url" in
82 ../*)
83 url="${url#../}"
84 case "$remoteurl" in
85 */*)
86 remoteurl="${remoteurl%/*}"
88 *:*)
89 remoteurl="${remoteurl%:*}"
90 sep=:
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=.
100 esac
102 ./*)
103 url="${url#./}"
106 break;;
107 esac
108 done
109 remoteurl="$remoteurl$sep${url%/}"
110 echo "${is_relative:+${up_path}}${remoteurl#./}"
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 '/'.
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 ()
121 local target curdir result
122 target=$1
123 curdir=${2-$wt_prefix}
124 curdir=${curdir%/}
125 result=
127 while test -n "$curdir"
129 case "$target" in
130 "$curdir/"*)
131 target=${target#"$curdir"/}
132 break
134 esac
136 result="${result}../"
137 if test "$curdir" = "${curdir%/*}"
138 then
139 curdir=
140 else
141 curdir="${curdir%/*}"
143 done
145 echo "$result$target"
149 # Get submodule info for registered submodules
150 # $@ = path to limit submodule list
152 module_list()
154 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
156 git ls-files -z --error-unmatch --stage -- "$@" ||
157 echo "unmatched pathspec exists"
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;
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";
178 next;
180 push @out, "$_\n";
182 if ($unmatched) {
183 print "#unmatched\n";
184 } else {
185 print for (@out);
190 die_if_unmatched ()
192 if test "$1" = "#unmatched"
193 then
194 exit 1
199 # Print a submodule configuration setting
201 # $1 = submodule name
202 # $2 = option name
203 # $3 = default value
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.
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")
220 printf '%s' "${value:-$default}"
225 # Map submodule path to submodule name
227 # $1 = path
229 module_name()
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 printf '%s\n' "$name"
242 # Clone a submodule
244 # $1 = submodule path
245 # $2 = submodule name
246 # $3 = URL to clone
247 # $4 = reference repository to reuse (empty for independent)
248 # $5 = depth argument for shallow clones (empty for deep)
250 # Prior to calling, cmd_update checks that a possibly existing
251 # path is not a git repository.
252 # Likewise, cmd_add checks that path does not exist at all,
253 # since it is the location of a new submodule.
255 module_clone()
257 sm_path=$1
258 name=$2
259 url=$3
260 reference="$4"
261 depth="$5"
262 quiet=
263 if test -n "$GIT_QUIET"
264 then
265 quiet=-q
268 gitdir=
269 gitdir_base=
270 base_name=$(dirname "$name")
272 gitdir=$(git rev-parse --git-dir)
273 gitdir_base="$gitdir/modules/$base_name"
274 gitdir="$gitdir/modules/$name"
276 if test -d "$gitdir"
277 then
278 mkdir -p "$sm_path"
279 rm -f "$gitdir/index"
280 else
281 mkdir -p "$gitdir_base"
283 clear_local_git_env
284 git clone $quiet ${depth:+"$depth"} -n ${reference:+"$reference"} \
285 --separate-git-dir "$gitdir" "$url" "$sm_path"
286 ) ||
287 die "$(eval_gettext "Clone of '\$url' into submodule path '\$sm_path' failed")"
290 # We already are at the root of the work tree but cd_to_toplevel will
291 # resolve any symlinks that might be present in $PWD
292 a=$(cd_to_toplevel && cd "$gitdir" && pwd)/
293 b=$(cd_to_toplevel && cd "$sm_path" && pwd)/
294 # Remove all common leading directories after a sanity check
295 if test "${a#$b}" != "$a" || test "${b#$a}" != "$b"; then
296 die "$(eval_gettext "Gitdir '\$a' is part of the submodule path '\$b' or vice versa")"
298 while test "${a%%/*}" = "${b%%/*}"
300 a=${a#*/}
301 b=${b#*/}
302 done
303 # Now chop off the trailing '/'s that were added in the beginning
304 a=${a%/}
305 b=${b%/}
307 # Turn each leading "*/" component into "../"
308 rel=$(printf '%s\n' "$b" | sed -e 's|[^/][^/]*|..|g')
309 printf '%s\n' "gitdir: $rel/$a" >"$sm_path/.git"
311 rel=$(printf '%s\n' "$a" | sed -e 's|[^/][^/]*|..|g')
312 (clear_local_git_env; cd "$sm_path" && GIT_WORK_TREE=. git config core.worktree "$rel/$b")
315 isnumber()
317 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
321 # Add a new submodule to the working tree, .gitmodules and the index
323 # $@ = repo path
325 # optional branch is stored in global branch variable
327 cmd_add()
329 # parse $args after "submodule ... add".
330 reference_path=
331 while test $# -ne 0
333 case "$1" in
334 -b | --branch)
335 case "$2" in '') usage ;; esac
336 branch=$2
337 shift
339 -f | --force)
340 force=$1
342 -q|--quiet)
343 GIT_QUIET=1
345 --reference)
346 case "$2" in '') usage ;; esac
347 reference_path=$2
348 shift
350 --reference=*)
351 reference_path="${1#--reference=}"
353 --name)
354 case "$2" in '') usage ;; esac
355 custom_name=$2
356 shift
358 --depth)
359 case "$2" in '') usage ;; esac
360 depth="--depth=$2"
361 shift
363 --depth=*)
364 depth=$1
367 shift
368 break
371 usage
374 break
376 esac
377 shift
378 done
380 if test -n "$reference_path"
381 then
382 is_absolute_path "$reference_path" ||
383 reference_path="$wt_prefix$reference_path"
385 reference="--reference=$reference_path"
388 repo=$1
389 sm_path=$2
391 if test -z "$sm_path"; then
392 sm_path=$(printf '%s\n' "$repo" |
393 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
396 if test -z "$repo" || test -z "$sm_path"; then
397 usage
400 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
402 # assure repo is absolute or relative to parent
403 case "$repo" in
404 ./*|../*)
405 test -z "$wt_prefix" ||
406 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
408 # dereference source url relative to parent's url
409 realrepo=$(resolve_relative_url "$repo") || exit
411 *:*|/*)
412 # absolute url
413 realrepo=$repo
416 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
418 esac
420 # normalize path:
421 # multiple //; leading ./; /./; /../; trailing /
422 sm_path=$(printf '%s/\n' "$sm_path" |
423 sed -e '
424 s|//*|/|g
425 s|^\(\./\)*||
426 s|/\./|/|g
427 :start
428 s|\([^/]*\)/\.\./||
429 tstart
430 s|/*$||
432 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
433 die "$(eval_gettext "'\$sm_path' already exists in the index")"
435 if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
436 then
437 eval_gettextln "The following path is ignored by one of your .gitignore files:
438 \$sm_path
439 Use -f if you really want to add it." >&2
440 exit 1
443 if test -n "$custom_name"
444 then
445 sm_name="$custom_name"
446 else
447 sm_name="$sm_path"
450 # perhaps the path exists and is already a git repo, else clone it
451 if test -e "$sm_path"
452 then
453 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
454 then
455 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
456 else
457 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
460 else
461 if test -d ".git/modules/$sm_name"
462 then
463 if test -z "$force"
464 then
465 echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
466 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
467 echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
468 echo >&2 " $realrepo"
469 echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
470 die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
471 else
472 echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
475 module_clone "$sm_path" "$sm_name" "$realrepo" "$reference" "$depth" || exit
477 clear_local_git_env
478 cd "$sm_path" &&
479 # ash fails to wordsplit ${branch:+-b "$branch"...}
480 case "$branch" in
481 '') git checkout -f -q ;;
482 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
483 esac
484 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
486 git config submodule."$sm_name".url "$realrepo"
488 git add $force "$sm_path" ||
489 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
491 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
492 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
493 if test -n "$branch"
494 then
495 git config -f .gitmodules submodule."$sm_name".branch "$branch"
496 fi &&
497 git add --force .gitmodules ||
498 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
502 # Execute an arbitrary command sequence in each checked out
503 # submodule
505 # $@ = command to execute
507 cmd_foreach()
509 # parse $args after "submodule ... foreach".
510 while test $# -ne 0
512 case "$1" in
513 -q|--quiet)
514 GIT_QUIET=1
516 --recursive)
517 recursive=1
520 usage
523 break
525 esac
526 shift
527 done
529 toplevel=$(pwd)
531 # dup stdin so that it can be restored when running the external
532 # command in the subshell (and a recursive call to this function)
533 exec 3<&0
535 module_list |
536 while read mode sha1 stage sm_path
538 die_if_unmatched "$mode"
539 if test -e "$sm_path"/.git
540 then
541 displaypath=$(relative_path "$sm_path")
542 say "$(eval_gettext "Entering '\$prefix\$displaypath'")"
543 name=$(module_name "$sm_path")
545 prefix="$prefix$sm_path/"
546 clear_local_git_env
547 cd "$sm_path" &&
548 sm_path=$(relative_path "$sm_path") &&
549 # we make $path available to scripts ...
550 path=$sm_path &&
551 if test $# -eq 1
552 then
553 eval "$1"
554 else
555 "$@"
556 fi &&
557 if test -n "$recursive"
558 then
559 cmd_foreach "--recursive" "$@"
561 ) <&3 3<&- ||
562 die "$(eval_gettext "Stopping at '\$prefix\$displaypath'; script returned non-zero status.")"
564 done
568 # Register submodules in .git/config
570 # $@ = requested paths (default to all)
572 cmd_init()
574 # parse $args after "submodule ... init".
575 while test $# -ne 0
577 case "$1" in
578 -q|--quiet)
579 GIT_QUIET=1
582 shift
583 break
586 usage
589 break
591 esac
592 shift
593 done
595 module_list "$@" |
596 while read mode sha1 stage sm_path
598 die_if_unmatched "$mode"
599 name=$(module_name "$sm_path") || exit
601 displaypath=$(relative_path "$sm_path")
603 # Copy url setting when it is not set yet
604 if test -z "$(git config "submodule.$name.url")"
605 then
606 url=$(git config -f .gitmodules submodule."$name".url)
607 test -z "$url" &&
608 die "$(eval_gettext "No url found for submodule path '\$displaypath' in .gitmodules")"
610 # Possibly a url relative to parent
611 case "$url" in
612 ./*|../*)
613 url=$(resolve_relative_url "$url") || exit
615 esac
616 git config submodule."$name".url "$url" ||
617 die "$(eval_gettext "Failed to register url for submodule path '\$displaypath'")"
619 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$displaypath'")"
622 # Copy "update" setting when it is not set yet
623 if upd="$(git config -f .gitmodules submodule."$name".update)" &&
624 test -n "$upd" &&
625 test -z "$(git config submodule."$name".update)"
626 then
627 case "$upd" in
628 checkout | rebase | merge | none)
629 ;; # known modes of updating
631 echo >&2 "warning: unknown update mode '$upd' suggested for submodule '$name'"
632 upd=none
634 esac
635 git config submodule."$name".update "$upd" ||
636 die "$(eval_gettext "Failed to register update mode for submodule path '\$displaypath'")"
638 done
642 # Unregister submodules from .git/config and remove their work tree
644 # $@ = requested paths (use '.' to deinit all submodules)
646 cmd_deinit()
648 # parse $args after "submodule ... deinit".
649 while test $# -ne 0
651 case "$1" in
652 -f|--force)
653 force=$1
655 -q|--quiet)
656 GIT_QUIET=1
659 shift
660 break
663 usage
666 break
668 esac
669 shift
670 done
672 if test $# = 0
673 then
674 die "$(eval_gettext "Use '.' if you really want to deinitialize all submodules")"
677 module_list "$@" |
678 while read mode sha1 stage sm_path
680 die_if_unmatched "$mode"
681 name=$(module_name "$sm_path") || exit
683 displaypath=$(relative_path "$sm_path")
685 # Remove the submodule work tree (unless the user already did it)
686 if test -d "$sm_path"
687 then
688 # Protect submodules containing a .git directory
689 if test -d "$sm_path/.git"
690 then
691 echo >&2 "$(eval_gettext "Submodule work tree '\$displaypath' contains a .git directory")"
692 die "$(eval_gettext "(use 'rm -rf' if you really want to remove it including all of its history)")"
695 if test -z "$force"
696 then
697 git rm -qn "$sm_path" ||
698 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
700 rm -rf "$sm_path" &&
701 say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
702 say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
705 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
707 # Remove the .git/config entries (unless the user already did it)
708 if test -n "$(git config --get-regexp submodule."$name\.")"
709 then
710 # Remove the whole section so we have a clean state when
711 # the user later decides to init this submodule again
712 url=$(git config submodule."$name".url)
713 git config --remove-section submodule."$name" 2>/dev/null &&
714 say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
716 done
720 # Update each submodule path to correct revision, using clone and checkout as needed
722 # $@ = requested paths (default to all)
724 cmd_update()
726 # parse $args after "submodule ... update".
727 while test $# -ne 0
729 case "$1" in
730 -q|--quiet)
731 GIT_QUIET=1
733 -i|--init)
734 init=1
736 --remote)
737 remote=1
739 -N|--no-fetch)
740 nofetch=1
742 -f|--force)
743 force=$1
745 -r|--rebase)
746 update="rebase"
748 --reference)
749 case "$2" in '') usage ;; esac
750 reference="--reference=$2"
751 shift
753 --reference=*)
754 reference="$1"
756 -m|--merge)
757 update="merge"
759 --recursive)
760 recursive=1
762 --checkout)
763 update="checkout"
765 --depth)
766 case "$2" in '') usage ;; esac
767 depth="--depth=$2"
768 shift
770 --depth=*)
771 depth=$1
774 shift
775 break
778 usage
781 break
783 esac
784 shift
785 done
787 if test -n "$init"
788 then
789 cmd_init "--" "$@" || return
792 cloned_modules=
793 module_list "$@" | {
794 err=
795 while read mode sha1 stage sm_path
797 die_if_unmatched "$mode"
798 if test "$stage" = U
799 then
800 echo >&2 "Skipping unmerged submodule $prefix$sm_path"
801 continue
803 name=$(module_name "$sm_path") || exit
804 url=$(git config submodule."$name".url)
805 branch=$(get_submodule_config "$name" branch master)
806 if ! test -z "$update"
807 then
808 update_module=$update
809 else
810 update_module=$(git config submodule."$name".update)
811 if test -z "$update_module"
812 then
813 update_module="checkout"
817 displaypath=$(relative_path "$prefix$sm_path")
819 if test "$update_module" = "none"
820 then
821 echo "Skipping submodule '$displaypath'"
822 continue
825 if test -z "$url"
826 then
827 # Only mention uninitialized submodules when its
828 # path have been specified
829 test "$#" != "0" &&
830 say "$(eval_gettext "Submodule path '\$displaypath' not initialized
831 Maybe you want to use 'update --init'?")"
832 continue
835 if ! test -d "$sm_path"/.git && ! test -f "$sm_path"/.git
836 then
837 module_clone "$sm_path" "$name" "$url" "$reference" "$depth" || exit
838 cloned_modules="$cloned_modules;$name"
839 subsha1=
840 else
841 subsha1=$(clear_local_git_env; cd "$sm_path" &&
842 git rev-parse --verify HEAD) ||
843 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
846 if test -n "$remote"
847 then
848 if test -z "$nofetch"
849 then
850 # Fetch remote before determining tracking $sha1
851 (clear_local_git_env; cd "$sm_path" && git-fetch) ||
852 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
854 remote_name=$(clear_local_git_env; cd "$sm_path" && get_default_remote)
855 sha1=$(clear_local_git_env; cd "$sm_path" &&
856 git rev-parse --verify "${remote_name}/${branch}") ||
857 die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
860 if test "$subsha1" != "$sha1" || test -n "$force"
861 then
862 subforce=$force
863 # If we don't already have a -f flag and the submodule has never been checked out
864 if test -z "$subsha1" && test -z "$force"
865 then
866 subforce="-f"
869 if test -z "$nofetch"
870 then
871 # Run fetch only if $sha1 isn't present or it
872 # is not reachable from a ref.
873 (clear_local_git_env; cd "$sm_path" &&
874 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
875 test -z "$rev") || git-fetch)) ||
876 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
879 # Is this something we just cloned?
880 case ";$cloned_modules;" in
881 *";$name;"*)
882 # then there is no local change to integrate
883 update_module=checkout ;;
884 esac
886 must_die_on_failure=
887 case "$update_module" in
888 checkout)
889 command="git checkout $subforce -q"
890 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
891 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
893 rebase)
894 command="git rebase"
895 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
896 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
897 must_die_on_failure=yes
899 merge)
900 command="git merge"
901 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
902 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
903 must_die_on_failure=yes
906 command="${update_module#!}"
907 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$prefix\$sm_path'")"
908 say_msg="$(eval_gettext "Submodule path '\$prefix\$sm_path': '\$command \$sha1'")"
909 must_die_on_failure=yes
912 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
913 esac
915 if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
916 then
917 say "$say_msg"
918 elif test -n "$must_die_on_failure"
919 then
920 die_with_status 2 "$die_msg"
921 else
922 err="${err};$die_msg"
923 continue
927 if test -n "$recursive"
928 then
930 prefix="$prefix$sm_path/"
931 clear_local_git_env
932 cd "$sm_path" &&
933 eval cmd_update
935 res=$?
936 if test $res -gt 0
937 then
938 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
939 if test $res -eq 1
940 then
941 err="${err};$die_msg"
942 continue
943 else
944 die_with_status $res "$die_msg"
948 done
950 if test -n "$err"
951 then
952 OIFS=$IFS
953 IFS=';'
954 for e in $err
956 if test -n "$e"
957 then
958 echo >&2 "$e"
960 done
961 IFS=$OIFS
962 exit 1
967 set_name_rev () {
968 revname=$( (
969 clear_local_git_env
970 cd "$1" && {
971 git describe "$2" 2>/dev/null ||
972 git describe --tags "$2" 2>/dev/null ||
973 git describe --contains "$2" 2>/dev/null ||
974 git describe --all --always "$2"
977 test -z "$revname" || revname=" ($revname)"
980 # Show commit summary for submodules in index or working tree
982 # If '--cached' is given, show summary between index and given commit,
983 # or between working tree and given commit
985 # $@ = [commit (default 'HEAD'),] requested paths (default all)
987 cmd_summary() {
988 summary_limit=-1
989 for_status=
990 diff_cmd=diff-index
992 # parse $args after "submodule ... summary".
993 while test $# -ne 0
995 case "$1" in
996 --cached)
997 cached="$1"
999 --files)
1000 files="$1"
1002 --for-status)
1003 for_status="$1"
1005 -n|--summary-limit)
1006 summary_limit="$2"
1007 isnumber "$summary_limit" || usage
1008 shift
1010 --summary-limit=*)
1011 summary_limit="${1#--summary-limit=}"
1012 isnumber "$summary_limit" || usage
1015 shift
1016 break
1019 usage
1022 break
1024 esac
1025 shift
1026 done
1028 test $summary_limit = 0 && return
1030 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
1031 then
1032 head=$rev
1033 test $# = 0 || shift
1034 elif test -z "$1" || test "$1" = "HEAD"
1035 then
1036 # before the first commit: compare with an empty tree
1037 head=$(git hash-object -w -t tree --stdin </dev/null)
1038 test -z "$1" || shift
1039 else
1040 head="HEAD"
1043 if [ -n "$files" ]
1044 then
1045 test -n "$cached" &&
1046 die "$(gettext "The --cached option cannot be used with the --files option")"
1047 diff_cmd=diff-files
1048 head=
1051 cd_to_toplevel
1052 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
1053 # Get modified modules cared by user
1054 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
1055 sane_egrep '^:([0-7]* )?160000' |
1056 while read mod_src mod_dst sha1_src sha1_dst status sm_path
1058 # Always show modules deleted or type-changed (blob<->module)
1059 if test "$status" = D || test "$status" = T
1060 then
1061 printf '%s\n' "$sm_path"
1062 continue
1064 # Respect the ignore setting for --for-status.
1065 if test -n "$for_status"
1066 then
1067 name=$(module_name "$sm_path")
1068 ignore_config=$(get_submodule_config "$name" ignore none)
1069 test $status != A && test $ignore_config = all && continue
1071 # Also show added or modified modules which are checked out
1072 GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
1073 printf '%s\n' "$sm_path"
1074 done
1077 test -z "$modules" && return
1079 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
1080 sane_egrep '^:([0-7]* )?160000' |
1081 cut -c2- |
1082 while read mod_src mod_dst sha1_src sha1_dst status name
1084 if test -z "$cached" &&
1085 test $sha1_dst = 0000000000000000000000000000000000000000
1086 then
1087 case "$mod_dst" in
1088 160000)
1089 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
1091 100644 | 100755 | 120000)
1092 sha1_dst=$(git hash-object $name)
1094 000000)
1095 ;; # removed
1097 # unexpected type
1098 eval_gettextln "unexpected mode \$mod_dst" >&2
1099 continue ;;
1100 esac
1102 missing_src=
1103 missing_dst=
1105 test $mod_src = 160000 &&
1106 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
1107 missing_src=t
1109 test $mod_dst = 160000 &&
1110 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
1111 missing_dst=t
1113 display_name=$(relative_path "$name")
1115 total_commits=
1116 case "$missing_src,$missing_dst" in
1118 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
1121 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
1123 t,t)
1124 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
1127 errmsg=
1128 total_commits=$(
1129 if test $mod_src = 160000 && test $mod_dst = 160000
1130 then
1131 range="$sha1_src...$sha1_dst"
1132 elif test $mod_src = 160000
1133 then
1134 range=$sha1_src
1135 else
1136 range=$sha1_dst
1138 GIT_DIR="$name/.git" \
1139 git rev-list --first-parent $range -- | wc -l
1141 total_commits=" ($(($total_commits + 0)))"
1143 esac
1145 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
1146 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
1147 if test $status = T
1148 then
1149 blob="$(gettext "blob")"
1150 submodule="$(gettext "submodule")"
1151 if test $mod_dst = 160000
1152 then
1153 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1154 else
1155 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1157 else
1158 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1160 if test -n "$errmsg"
1161 then
1162 # Don't give error msg for modification whose dst is not submodule
1163 # i.e. deleted or changed to blob
1164 test $mod_dst = 160000 && echo "$errmsg"
1165 else
1166 if test $mod_src = 160000 && test $mod_dst = 160000
1167 then
1168 limit=
1169 test $summary_limit -gt 0 && limit="-$summary_limit"
1170 GIT_DIR="$name/.git" \
1171 git log $limit --pretty='format: %m %s' \
1172 --first-parent $sha1_src...$sha1_dst
1173 elif test $mod_dst = 160000
1174 then
1175 GIT_DIR="$name/.git" \
1176 git log --pretty='format: > %s' -1 $sha1_dst
1177 else
1178 GIT_DIR="$name/.git" \
1179 git log --pretty='format: < %s' -1 $sha1_src
1181 echo
1183 echo
1184 done
1187 # List all submodules, prefixed with:
1188 # - submodule not initialized
1189 # + different revision checked out
1191 # If --cached was specified the revision in the index will be printed
1192 # instead of the currently checked out revision.
1194 # $@ = requested paths (default to all)
1196 cmd_status()
1198 # parse $args after "submodule ... status".
1199 while test $# -ne 0
1201 case "$1" in
1202 -q|--quiet)
1203 GIT_QUIET=1
1205 --cached)
1206 cached=1
1208 --recursive)
1209 recursive=1
1212 shift
1213 break
1216 usage
1219 break
1221 esac
1222 shift
1223 done
1225 module_list "$@" |
1226 while read mode sha1 stage sm_path
1228 die_if_unmatched "$mode"
1229 name=$(module_name "$sm_path") || exit
1230 url=$(git config submodule."$name".url)
1231 displaypath=$(relative_path "$prefix$sm_path")
1232 if test "$stage" = U
1233 then
1234 say "U$sha1 $displaypath"
1235 continue
1237 if test -z "$url" ||
1239 ! test -d "$sm_path"/.git &&
1240 ! test -f "$sm_path"/.git
1242 then
1243 say "-$sha1 $displaypath"
1244 continue;
1246 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1247 then
1248 set_name_rev "$sm_path" "$sha1"
1249 say " $sha1 $displaypath$revname"
1250 else
1251 if test -z "$cached"
1252 then
1253 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1255 set_name_rev "$sm_path" "$sha1"
1256 say "+$sha1 $displaypath$revname"
1259 if test -n "$recursive"
1260 then
1262 prefix="$displaypath/"
1263 clear_local_git_env
1264 cd "$sm_path" &&
1265 eval cmd_status
1266 ) ||
1267 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1269 done
1272 # Sync remote urls for submodules
1273 # This makes the value for remote.$remote.url match the value
1274 # specified in .gitmodules.
1276 cmd_sync()
1278 while test $# -ne 0
1280 case "$1" in
1281 -q|--quiet)
1282 GIT_QUIET=1
1283 shift
1285 --recursive)
1286 recursive=1
1287 shift
1290 shift
1291 break
1294 usage
1297 break
1299 esac
1300 done
1301 cd_to_toplevel
1302 module_list "$@" |
1303 while read mode sha1 stage sm_path
1305 die_if_unmatched "$mode"
1306 name=$(module_name "$sm_path")
1307 url=$(git config -f .gitmodules --get submodule."$name".url)
1309 # Possibly a url relative to parent
1310 case "$url" in
1311 ./*|../*)
1312 # rewrite foo/bar as ../.. to find path from
1313 # submodule work tree to superproject work tree
1314 up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1315 # guarantee a trailing /
1316 up_path=${up_path%/}/ &&
1317 # path from submodule work tree to submodule origin repo
1318 sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1319 # path from superproject work tree to submodule origin repo
1320 super_config_url=$(resolve_relative_url "$url") || exit
1323 sub_origin_url="$url"
1324 super_config_url="$url"
1326 esac
1328 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1329 then
1330 displaypath=$(relative_path "$prefix$sm_path")
1331 say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1332 git config submodule."$name".url "$super_config_url"
1334 if test -e "$sm_path"/.git
1335 then
1337 clear_local_git_env
1338 cd "$sm_path"
1339 remote=$(get_default_remote)
1340 git config remote."$remote".url "$sub_origin_url"
1342 if test -n "$recursive"
1343 then
1344 prefix="$prefix$sm_path/"
1345 eval cmd_sync
1350 done
1353 # This loop parses the command line arguments to find the
1354 # subcommand name to dispatch. Parsing of the subcommand specific
1355 # options are primarily done by the subcommand implementations.
1356 # Subcommand specific options such as --branch and --cached are
1357 # parsed here as well, for backward compatibility.
1359 while test $# != 0 && test -z "$command"
1361 case "$1" in
1362 add | foreach | init | deinit | update | status | summary | sync)
1363 command=$1
1365 -q|--quiet)
1366 GIT_QUIET=1
1368 -b|--branch)
1369 case "$2" in
1371 usage
1373 esac
1374 branch="$2"; shift
1376 --cached)
1377 cached="$1"
1380 break
1383 usage
1386 break
1388 esac
1389 shift
1390 done
1392 # No command word defaults to "status"
1393 if test -z "$command"
1394 then
1395 if test $# = 0
1396 then
1397 command=status
1398 else
1399 usage
1403 # "-b branch" is accepted only by "add"
1404 if test -n "$branch" && test "$command" != add
1405 then
1406 usage
1409 # "--cached" is accepted only by "status" and "summary"
1410 if test -n "$cached" && test "$command" != status && test "$command" != summary
1411 then
1412 usage
1415 "cmd_$command" "$@"