Merge pull request #285 from dscho/readme
[git/mingw/4msysgit.git] / git-submodule.sh
bloba0d8705304e7496ca5c57a5e4271b313e508ed91
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 cat >&2 <<EOF
438 The following path is ignored by one of your .gitignore files:
439 $(eval_gettextln $sm_path)
440 Use -f if you really want to add it.
442 exit 1
445 if test -n "$custom_name"
446 then
447 sm_name="$custom_name"
448 else
449 sm_name="$sm_path"
452 # perhaps the path exists and is already a git repo, else clone it
453 if test -e "$sm_path"
454 then
455 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
456 then
457 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
458 else
459 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
462 else
463 if test -d ".git/modules/$sm_name"
464 then
465 if test -z "$force"
466 then
467 echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
468 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
469 echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
470 echo >&2 " $realrepo"
471 echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
472 die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
473 else
474 echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
477 module_clone "$sm_path" "$sm_name" "$realrepo" "$reference" "$depth" || exit
479 clear_local_git_env
480 cd "$sm_path" &&
481 # ash fails to wordsplit ${branch:+-b "$branch"...}
482 case "$branch" in
483 '') git checkout -f -q ;;
484 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
485 esac
486 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
488 git config submodule."$sm_name".url "$realrepo"
490 git add $force "$sm_path" ||
491 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
493 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
494 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
495 if test -n "$branch"
496 then
497 git config -f .gitmodules submodule."$sm_name".branch "$branch"
498 fi &&
499 git add --force .gitmodules ||
500 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
504 # Execute an arbitrary command sequence in each checked out
505 # submodule
507 # $@ = command to execute
509 cmd_foreach()
511 # parse $args after "submodule ... foreach".
512 while test $# -ne 0
514 case "$1" in
515 -q|--quiet)
516 GIT_QUIET=1
518 --recursive)
519 recursive=1
522 usage
525 break
527 esac
528 shift
529 done
531 toplevel=$(pwd)
533 # dup stdin so that it can be restored when running the external
534 # command in the subshell (and a recursive call to this function)
535 exec 3<&0
537 module_list |
538 while read mode sha1 stage sm_path
540 die_if_unmatched "$mode"
541 if test -e "$sm_path"/.git
542 then
543 displaypath=$(relative_path "$sm_path")
544 say "$(eval_gettext "Entering '\$prefix\$displaypath'")"
545 name=$(module_name "$sm_path")
547 prefix="$prefix$sm_path/"
548 clear_local_git_env
549 cd "$sm_path" &&
550 sm_path=$(relative_path "$sm_path") &&
551 # we make $path available to scripts ...
552 path=$sm_path &&
553 if test $# -eq 1
554 then
555 eval "$1"
556 else
557 "$@"
558 fi &&
559 if test -n "$recursive"
560 then
561 cmd_foreach "--recursive" "$@"
563 ) <&3 3<&- ||
564 die "$(eval_gettext "Stopping at '\$prefix\$displaypath'; script returned non-zero status.")"
566 done
570 # Register submodules in .git/config
572 # $@ = requested paths (default to all)
574 cmd_init()
576 # parse $args after "submodule ... init".
577 while test $# -ne 0
579 case "$1" in
580 -q|--quiet)
581 GIT_QUIET=1
584 shift
585 break
588 usage
591 break
593 esac
594 shift
595 done
597 module_list "$@" |
598 while read mode sha1 stage sm_path
600 die_if_unmatched "$mode"
601 name=$(module_name "$sm_path") || exit
603 displaypath=$(relative_path "$sm_path")
605 # Copy url setting when it is not set yet
606 if test -z "$(git config "submodule.$name.url")"
607 then
608 url=$(git config -f .gitmodules submodule."$name".url)
609 test -z "$url" &&
610 die "$(eval_gettext "No url found for submodule path '\$displaypath' in .gitmodules")"
612 # Possibly a url relative to parent
613 case "$url" in
614 ./*|../*)
615 url=$(resolve_relative_url "$url") || exit
617 esac
618 git config submodule."$name".url "$url" ||
619 die "$(eval_gettext "Failed to register url for submodule path '\$displaypath'")"
621 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$displaypath'")"
624 # Copy "update" setting when it is not set yet
625 if upd="$(git config -f .gitmodules submodule."$name".update)" &&
626 test -n "$upd" &&
627 test -z "$(git config submodule."$name".update)"
628 then
629 case "$upd" in
630 checkout | rebase | merge | none)
631 ;; # known modes of updating
633 echo >&2 "warning: unknown update mode '$upd' suggested for submodule '$name'"
634 upd=none
636 esac
637 git config submodule."$name".update "$upd" ||
638 die "$(eval_gettext "Failed to register update mode for submodule path '\$displaypath'")"
640 done
644 # Unregister submodules from .git/config and remove their work tree
646 # $@ = requested paths (use '.' to deinit all submodules)
648 cmd_deinit()
650 # parse $args after "submodule ... deinit".
651 while test $# -ne 0
653 case "$1" in
654 -f|--force)
655 force=$1
657 -q|--quiet)
658 GIT_QUIET=1
661 shift
662 break
665 usage
668 break
670 esac
671 shift
672 done
674 if test $# = 0
675 then
676 die "$(eval_gettext "Use '.' if you really want to deinitialize all submodules")"
679 module_list "$@" |
680 while read mode sha1 stage sm_path
682 die_if_unmatched "$mode"
683 name=$(module_name "$sm_path") || exit
685 displaypath=$(relative_path "$sm_path")
687 # Remove the submodule work tree (unless the user already did it)
688 if test -d "$sm_path"
689 then
690 # Protect submodules containing a .git directory
691 if test -d "$sm_path/.git"
692 then
693 echo >&2 "$(eval_gettext "Submodule work tree '\$displaypath' contains a .git directory")"
694 die "$(eval_gettext "(use 'rm -rf' if you really want to remove it including all of its history)")"
697 if test -z "$force"
698 then
699 git rm -qn "$sm_path" ||
700 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
702 rm -rf "$sm_path" &&
703 say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
704 say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
707 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
709 # Remove the .git/config entries (unless the user already did it)
710 if test -n "$(git config --get-regexp submodule."$name\.")"
711 then
712 # Remove the whole section so we have a clean state when
713 # the user later decides to init this submodule again
714 url=$(git config submodule."$name".url)
715 git config --remove-section submodule."$name" 2>/dev/null &&
716 say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
718 done
722 # Update each submodule path to correct revision, using clone and checkout as needed
724 # $@ = requested paths (default to all)
726 cmd_update()
728 # parse $args after "submodule ... update".
729 while test $# -ne 0
731 case "$1" in
732 -q|--quiet)
733 GIT_QUIET=1
735 -i|--init)
736 init=1
738 --remote)
739 remote=1
741 -N|--no-fetch)
742 nofetch=1
744 -f|--force)
745 force=$1
747 -r|--rebase)
748 update="rebase"
750 --reference)
751 case "$2" in '') usage ;; esac
752 reference="--reference=$2"
753 shift
755 --reference=*)
756 reference="$1"
758 -m|--merge)
759 update="merge"
761 --recursive)
762 recursive=1
764 --checkout)
765 update="checkout"
767 --depth)
768 case "$2" in '') usage ;; esac
769 depth="--depth=$2"
770 shift
772 --depth=*)
773 depth=$1
776 shift
777 break
780 usage
783 break
785 esac
786 shift
787 done
789 if test -n "$init"
790 then
791 cmd_init "--" "$@" || return
794 cloned_modules=
795 module_list "$@" | {
796 err=
797 while read mode sha1 stage sm_path
799 die_if_unmatched "$mode"
800 if test "$stage" = U
801 then
802 echo >&2 "Skipping unmerged submodule $prefix$sm_path"
803 continue
805 name=$(module_name "$sm_path") || exit
806 url=$(git config submodule."$name".url)
807 branch=$(get_submodule_config "$name" branch master)
808 if ! test -z "$update"
809 then
810 update_module=$update
811 else
812 update_module=$(git config submodule."$name".update)
813 if test -z "$update_module"
814 then
815 update_module="checkout"
819 displaypath=$(relative_path "$prefix$sm_path")
821 if test "$update_module" = "none"
822 then
823 echo "Skipping submodule '$displaypath'"
824 continue
827 if test -z "$url"
828 then
829 # Only mention uninitialized submodules when its
830 # path have been specified
831 test "$#" != "0" &&
832 say "$(eval_gettext "Submodule path '\$displaypath' not initialized
833 Maybe you want to use 'update --init'?")"
834 continue
837 if ! test -d "$sm_path"/.git && ! test -f "$sm_path"/.git
838 then
839 module_clone "$sm_path" "$name" "$url" "$reference" "$depth" || exit
840 cloned_modules="$cloned_modules;$name"
841 subsha1=
842 else
843 subsha1=$(clear_local_git_env; cd "$sm_path" &&
844 git rev-parse --verify HEAD) ||
845 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
848 if test -n "$remote"
849 then
850 if test -z "$nofetch"
851 then
852 # Fetch remote before determining tracking $sha1
853 (clear_local_git_env; cd "$sm_path" && git-fetch) ||
854 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
856 remote_name=$(clear_local_git_env; cd "$sm_path" && get_default_remote)
857 sha1=$(clear_local_git_env; cd "$sm_path" &&
858 git rev-parse --verify "${remote_name}/${branch}") ||
859 die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
862 if test "$subsha1" != "$sha1" || test -n "$force"
863 then
864 subforce=$force
865 # If we don't already have a -f flag and the submodule has never been checked out
866 if test -z "$subsha1" && test -z "$force"
867 then
868 subforce="-f"
871 if test -z "$nofetch"
872 then
873 # Run fetch only if $sha1 isn't present or it
874 # is not reachable from a ref.
875 (clear_local_git_env; cd "$sm_path" &&
876 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
877 test -z "$rev") || git-fetch)) ||
878 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
881 # Is this something we just cloned?
882 case ";$cloned_modules;" in
883 *";$name;"*)
884 # then there is no local change to integrate
885 update_module=checkout ;;
886 esac
888 must_die_on_failure=
889 case "$update_module" in
890 checkout)
891 command="git checkout $subforce -q"
892 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
893 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
895 rebase)
896 command="git rebase"
897 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
898 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
899 must_die_on_failure=yes
901 merge)
902 command="git merge"
903 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
904 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
905 must_die_on_failure=yes
908 command="${update_module#!}"
909 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$prefix\$sm_path'")"
910 say_msg="$(eval_gettext "Submodule path '\$prefix\$sm_path': '\$command \$sha1'")"
911 must_die_on_failure=yes
914 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
915 esac
917 if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
918 then
919 say "$say_msg"
920 elif test -n "$must_die_on_failure"
921 then
922 die_with_status 2 "$die_msg"
923 else
924 err="${err};$die_msg"
925 continue
929 if test -n "$recursive"
930 then
932 prefix="$prefix$sm_path/"
933 clear_local_git_env
934 cd "$sm_path" &&
935 eval cmd_update
937 res=$?
938 if test $res -gt 0
939 then
940 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
941 if test $res -eq 1
942 then
943 err="${err};$die_msg"
944 continue
945 else
946 die_with_status $res "$die_msg"
950 done
952 if test -n "$err"
953 then
954 OIFS=$IFS
955 IFS=';'
956 for e in $err
958 if test -n "$e"
959 then
960 echo >&2 "$e"
962 done
963 IFS=$OIFS
964 exit 1
969 set_name_rev () {
970 revname=$( (
971 clear_local_git_env
972 cd "$1" && {
973 git describe "$2" 2>/dev/null ||
974 git describe --tags "$2" 2>/dev/null ||
975 git describe --contains "$2" 2>/dev/null ||
976 git describe --all --always "$2"
979 test -z "$revname" || revname=" ($revname)"
982 # Show commit summary for submodules in index or working tree
984 # If '--cached' is given, show summary between index and given commit,
985 # or between working tree and given commit
987 # $@ = [commit (default 'HEAD'),] requested paths (default all)
989 cmd_summary() {
990 summary_limit=-1
991 for_status=
992 diff_cmd=diff-index
994 # parse $args after "submodule ... summary".
995 while test $# -ne 0
997 case "$1" in
998 --cached)
999 cached="$1"
1001 --files)
1002 files="$1"
1004 --for-status)
1005 for_status="$1"
1007 -n|--summary-limit)
1008 summary_limit="$2"
1009 isnumber "$summary_limit" || usage
1010 shift
1012 --summary-limit=*)
1013 summary_limit="${1#--summary-limit=}"
1014 isnumber "$summary_limit" || usage
1017 shift
1018 break
1021 usage
1024 break
1026 esac
1027 shift
1028 done
1030 test $summary_limit = 0 && return
1032 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
1033 then
1034 head=$rev
1035 test $# = 0 || shift
1036 elif test -z "$1" || test "$1" = "HEAD"
1037 then
1038 # before the first commit: compare with an empty tree
1039 head=$(git hash-object -w -t tree --stdin </dev/null)
1040 test -z "$1" || shift
1041 else
1042 head="HEAD"
1045 if [ -n "$files" ]
1046 then
1047 test -n "$cached" &&
1048 die "$(gettext "The --cached option cannot be used with the --files option")"
1049 diff_cmd=diff-files
1050 head=
1053 cd_to_toplevel
1054 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
1055 # Get modified modules cared by user
1056 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
1057 sane_egrep '^:([0-7]* )?160000' |
1058 while read mod_src mod_dst sha1_src sha1_dst status sm_path
1060 # Always show modules deleted or type-changed (blob<->module)
1061 if test "$status" = D || test "$status" = T
1062 then
1063 printf '%s\n' "$sm_path"
1064 continue
1066 # Respect the ignore setting for --for-status.
1067 if test -n "$for_status"
1068 then
1069 name=$(module_name "$sm_path")
1070 ignore_config=$(get_submodule_config "$name" ignore none)
1071 test $status != A && test $ignore_config = all && continue
1073 # Also show added or modified modules which are checked out
1074 GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
1075 printf '%s\n' "$sm_path"
1076 done
1079 test -z "$modules" && return
1081 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
1082 sane_egrep '^:([0-7]* )?160000' |
1083 cut -c2- |
1084 while read mod_src mod_dst sha1_src sha1_dst status name
1086 if test -z "$cached" &&
1087 test $sha1_dst = 0000000000000000000000000000000000000000
1088 then
1089 case "$mod_dst" in
1090 160000)
1091 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
1093 100644 | 100755 | 120000)
1094 sha1_dst=$(git hash-object $name)
1096 000000)
1097 ;; # removed
1099 # unexpected type
1100 eval_gettextln "unexpected mode \$mod_dst" >&2
1101 continue ;;
1102 esac
1104 missing_src=
1105 missing_dst=
1107 test $mod_src = 160000 &&
1108 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
1109 missing_src=t
1111 test $mod_dst = 160000 &&
1112 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
1113 missing_dst=t
1115 display_name=$(relative_path "$name")
1117 total_commits=
1118 case "$missing_src,$missing_dst" in
1120 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
1123 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
1125 t,t)
1126 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
1129 errmsg=
1130 total_commits=$(
1131 if test $mod_src = 160000 && test $mod_dst = 160000
1132 then
1133 range="$sha1_src...$sha1_dst"
1134 elif test $mod_src = 160000
1135 then
1136 range=$sha1_src
1137 else
1138 range=$sha1_dst
1140 GIT_DIR="$name/.git" \
1141 git rev-list --first-parent $range -- | wc -l
1143 total_commits=" ($(($total_commits + 0)))"
1145 esac
1147 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
1148 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
1149 if test $status = T
1150 then
1151 blob="$(gettext "blob")"
1152 submodule="$(gettext "submodule")"
1153 if test $mod_dst = 160000
1154 then
1155 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1156 else
1157 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1159 else
1160 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1162 if test -n "$errmsg"
1163 then
1164 # Don't give error msg for modification whose dst is not submodule
1165 # i.e. deleted or changed to blob
1166 test $mod_dst = 160000 && echo "$errmsg"
1167 else
1168 if test $mod_src = 160000 && test $mod_dst = 160000
1169 then
1170 limit=
1171 test $summary_limit -gt 0 && limit="-$summary_limit"
1172 GIT_DIR="$name/.git" \
1173 git log $limit --pretty='format: %m %s' \
1174 --first-parent $sha1_src...$sha1_dst
1175 elif test $mod_dst = 160000
1176 then
1177 GIT_DIR="$name/.git" \
1178 git log --pretty='format: > %s' -1 $sha1_dst
1179 else
1180 GIT_DIR="$name/.git" \
1181 git log --pretty='format: < %s' -1 $sha1_src
1183 echo
1185 echo
1186 done
1189 # List all submodules, prefixed with:
1190 # - submodule not initialized
1191 # + different revision checked out
1193 # If --cached was specified the revision in the index will be printed
1194 # instead of the currently checked out revision.
1196 # $@ = requested paths (default to all)
1198 cmd_status()
1200 # parse $args after "submodule ... status".
1201 while test $# -ne 0
1203 case "$1" in
1204 -q|--quiet)
1205 GIT_QUIET=1
1207 --cached)
1208 cached=1
1210 --recursive)
1211 recursive=1
1214 shift
1215 break
1218 usage
1221 break
1223 esac
1224 shift
1225 done
1227 module_list "$@" |
1228 while read mode sha1 stage sm_path
1230 die_if_unmatched "$mode"
1231 name=$(module_name "$sm_path") || exit
1232 url=$(git config submodule."$name".url)
1233 displaypath=$(relative_path "$prefix$sm_path")
1234 if test "$stage" = U
1235 then
1236 say "U$sha1 $displaypath"
1237 continue
1239 if test -z "$url" ||
1241 ! test -d "$sm_path"/.git &&
1242 ! test -f "$sm_path"/.git
1244 then
1245 say "-$sha1 $displaypath"
1246 continue;
1248 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1249 then
1250 set_name_rev "$sm_path" "$sha1"
1251 say " $sha1 $displaypath$revname"
1252 else
1253 if test -z "$cached"
1254 then
1255 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1257 set_name_rev "$sm_path" "$sha1"
1258 say "+$sha1 $displaypath$revname"
1261 if test -n "$recursive"
1262 then
1264 prefix="$displaypath/"
1265 clear_local_git_env
1266 cd "$sm_path" &&
1267 eval cmd_status
1268 ) ||
1269 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1271 done
1274 # Sync remote urls for submodules
1275 # This makes the value for remote.$remote.url match the value
1276 # specified in .gitmodules.
1278 cmd_sync()
1280 while test $# -ne 0
1282 case "$1" in
1283 -q|--quiet)
1284 GIT_QUIET=1
1285 shift
1287 --recursive)
1288 recursive=1
1289 shift
1292 shift
1293 break
1296 usage
1299 break
1301 esac
1302 done
1303 cd_to_toplevel
1304 module_list "$@" |
1305 while read mode sha1 stage sm_path
1307 die_if_unmatched "$mode"
1308 name=$(module_name "$sm_path")
1309 url=$(git config -f .gitmodules --get submodule."$name".url)
1311 # Possibly a url relative to parent
1312 case "$url" in
1313 ./*|../*)
1314 # rewrite foo/bar as ../.. to find path from
1315 # submodule work tree to superproject work tree
1316 up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1317 # guarantee a trailing /
1318 up_path=${up_path%/}/ &&
1319 # path from submodule work tree to submodule origin repo
1320 sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1321 # path from superproject work tree to submodule origin repo
1322 super_config_url=$(resolve_relative_url "$url") || exit
1325 sub_origin_url="$url"
1326 super_config_url="$url"
1328 esac
1330 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1331 then
1332 displaypath=$(relative_path "$prefix$sm_path")
1333 say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1334 git config submodule."$name".url "$super_config_url"
1336 if test -e "$sm_path"/.git
1337 then
1339 clear_local_git_env
1340 cd "$sm_path"
1341 remote=$(get_default_remote)
1342 git config remote."$remote".url "$sub_origin_url"
1344 if test -n "$recursive"
1345 then
1346 prefix="$prefix$sm_path/"
1347 eval cmd_sync
1352 done
1355 # This loop parses the command line arguments to find the
1356 # subcommand name to dispatch. Parsing of the subcommand specific
1357 # options are primarily done by the subcommand implementations.
1358 # Subcommand specific options such as --branch and --cached are
1359 # parsed here as well, for backward compatibility.
1361 while test $# != 0 && test -z "$command"
1363 case "$1" in
1364 add | foreach | init | deinit | update | status | summary | sync)
1365 command=$1
1367 -q|--quiet)
1368 GIT_QUIET=1
1370 -b|--branch)
1371 case "$2" in
1373 usage
1375 esac
1376 branch="$2"; shift
1378 --cached)
1379 cached="$1"
1382 break
1385 usage
1388 break
1390 esac
1391 shift
1392 done
1394 # No command word defaults to "status"
1395 if test -z "$command"
1396 then
1397 if test $# = 0
1398 then
1399 command=status
1400 else
1401 usage
1405 # "-b branch" is accepted only by "add"
1406 if test -n "$branch" && test "$command" != add
1407 then
1408 usage
1411 # "--cached" is accepted only by "status" and "summary"
1412 if test -n "$cached" && test "$command" != status && test "$command" != summary
1413 then
1414 usage
1417 "cmd_$command" "$@"