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] update [--init] [-N|--no-fetch] [-f|--force] [--rebase] [--reference <repository>] [--merge] [--recursive] [--] [<path>...]
12 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
13 or: $dashless [--quiet] foreach [--recursive] <command>
14 or: $dashless [--quiet] sync [--] [<path>...]"
34 # The function takes at most 2 arguments. The first argument is the
35 # URL that navigates to the submodule origin repo. When relative, this URL
36 # is relative to the superproject origin URL repo. The second up_path
37 # argument, if specified, is the relative path that navigates
38 # from the submodule working tree to the superproject working tree.
40 # The output of the function is the origin URL of the submodule.
42 # The output will either be an absolute URL or filesystem path (if the
43 # superproject origin URL is an absolute URL or filesystem path,
44 # respectively) or a relative file system path (if the superproject
45 # origin URL is a relative file system path).
47 # When the output is a relative file system path, the path is either
48 # relative to the submodule working tree, if up_path is specified, or to
49 # the superproject working tree otherwise.
50 resolve_relative_url ()
52 remote=$(get_default_remote)
53 remoteurl=$(git config "remote.$remote.url") ||
54 remoteurl=$(pwd) # the repository is its own authoritative upstream
56 remoteurl=${remoteurl%/}
69 remoteurl="./$remoteurl"
80 remoteurl="${remoteurl%/*}"
83 remoteurl="${remoteurl%:*}"
87 if test -z "$is_relative" || test "." = "$remoteurl"
89 die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
103 remoteurl="$remoteurl$sep${url%/}"
104 echo "${is_relative:+${up_path}}${remoteurl#./}"
108 # Get submodule info for registered submodules
109 # $@ = path to limit submodule list
114 git ls-files --error-unmatch --stage -- "$@" ||
115 echo "unmatched pathspec exists"
119 my ($null_sha1) = ("0" x 40);
123 if (/^unmatched pathspec/) {
128 my ($mode, $sha1, $stage, $path) =
129 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
130 next unless $mode eq "160000";
132 if (!$unmerged{$path}++) {
133 push @out, "$mode $null_sha1 U\t$path\n";
140 print "#unmatched\n";
149 if test "$1" = "#unmatched"
156 # Map submodule path to submodule name
162 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
164 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
165 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
166 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
168 die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$sm_path'")"
175 # Prior to calling, cmd_update checks that a possibly existing
176 # path is not a git repository.
177 # Likewise, cmd_add checks that path does not exist at all,
178 # since it is the location of a new submodule.
187 if test -n "$GIT_QUIET"
194 base_name=$(dirname "$name")
196 gitdir=$(git rev-parse --git-dir)
197 gitdir_base="$gitdir/modules/$base_name"
198 gitdir="$gitdir/modules/$name"
203 rm -f "$gitdir/index"
205 mkdir -p "$gitdir_base"
208 git clone $quiet -n ${reference:+"$reference"} \
209 --separate-git-dir "$gitdir" "$url" "$sm_path"
211 die "$(eval_gettext "Clone of '\$url' into submodule path '\$sm_path' failed")"
214 # We already are at the root of the work tree but cd_to_toplevel will
215 # resolve any symlinks that might be present in $PWD
216 a=$(cd_to_toplevel && cd "$gitdir" && pwd)/
217 b=$(cd_to_toplevel && cd "$sm_path" && pwd)/
218 # normalize Windows-style absolute paths to POSIX-style absolute paths
219 case $a in [a-zA-Z]:/*) a=/${a%%:*}${a#*:} ;; esac
220 case $b in [a-zA-Z]:/*) b=/${b%%:*}${b#*:} ;; esac
221 # Remove all common leading directories after a sanity check
222 if test "${a#$b}" != "$a" || test "${b#$a}" != "$b"; then
223 die "$(eval_gettext "Gitdir '\$a' is part of the submodule path '\$b' or vice versa")"
225 while test "${a%%/*}" = "${b%%/*}"
230 # Now chop off the trailing '/'s that were added in the beginning
234 # Turn each leading "*/" component into "../"
235 rel=$(echo $b | sed -e 's|[^/][^/]*|..|g')
236 echo "gitdir: $rel/$a" >"$sm_path/.git"
238 rel=$(echo $a | sed -e 's|[^/][^/]*|..|g')
239 (clear_local_git_env; cd "$sm_path" && GIT_WORK_TREE=. git config core.worktree "$rel/$b")
243 # Add a new submodule to the working tree, .gitmodules and the index
247 # optional branch is stored in global branch variable
251 # parse $args after "submodule ... add".
256 case "$2" in '') usage ;; esac
267 case "$2" in '') usage ;; esac
268 reference="--reference=$2"
276 case "$2" in '') usage ;; esac
297 if test -z "$sm_path"; then
298 sm_path=$(echo "$repo" |
299 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
302 if test -z "$repo" -o -z "$sm_path"; then
306 # assure repo is absolute or relative to parent
309 # dereference source url relative to parent's url
310 realrepo=$(resolve_relative_url "$repo") || exit
317 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
322 # multiple //; leading ./; /./; /../; trailing /
323 sm_path=$(printf '%s/\n' "$sm_path" |
333 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
334 die "$(eval_gettext "'\$sm_path' already exists in the index")"
336 if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
338 eval_gettextln "The following path is ignored by one of your .gitignore files:
340 Use -f if you really want to add it." >&2
344 if test -n "$custom_name"
346 sm_name="$custom_name"
351 # perhaps the path exists and is already a git repo, else clone it
352 if test -e "$sm_path"
354 if test -d "$sm_path"/.git -o -f "$sm_path"/.git
356 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
358 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
362 if test -d ".git/modules/$sm_name"
366 echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
367 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
368 echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
369 echo >&2 " $realrepo"
370 echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
371 die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
373 echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
376 module_clone "$sm_path" "$sm_name" "$realrepo" "$reference" || exit
380 # ash fails to wordsplit ${branch:+-b "$branch"...}
382 '') git checkout -f -q ;;
383 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
385 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
387 git config submodule."$sm_name".url "$realrepo"
389 git add $force "$sm_path" ||
390 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
392 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
393 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
394 git add --force .gitmodules ||
395 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
399 # Execute an arbitrary command sequence in each checked out
402 # $@ = command to execute
406 # parse $args after "submodule ... foreach".
428 # dup stdin so that it can be restored when running the external
429 # command in the subshell (and a recursive call to this function)
433 while read mode sha1 stage sm_path
435 die_if_unmatched "$mode"
436 if test -e "$sm_path"/.git
438 say "$(eval_gettext "Entering '\$prefix\$sm_path'")"
439 name=$(module_name "$sm_path")
441 prefix="$prefix$sm_path/"
443 # we make $path available to scripts ...
447 if test -n "$recursive"
449 cmd_foreach "--recursive" "$@"
452 die "$(eval_gettext "Stopping at '\$sm_path'; script returned non-zero status.")"
458 # Register submodules in .git/config
460 # $@ = requested paths (default to all)
464 # parse $args after "submodule ... init".
486 while read mode sha1 stage sm_path
488 die_if_unmatched "$mode"
489 name=$(module_name "$sm_path") || exit
491 # Copy url setting when it is not set yet
492 if test -z "$(git config "submodule.$name.url")"
494 url=$(git config -f .gitmodules submodule."$name".url)
496 die "$(eval_gettext "No url found for submodule path '\$sm_path' in .gitmodules")"
498 # Possibly a url relative to parent
501 url=$(resolve_relative_url "$url") || exit
504 git config submodule."$name".url "$url" ||
505 die "$(eval_gettext "Failed to register url for submodule path '\$sm_path'")"
507 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$sm_path'")"
510 # Copy "update" setting when it is not set yet
511 upd="$(git config -f .gitmodules submodule."$name".update)"
513 test -n "$(git config submodule."$name".update)" ||
514 git config submodule."$name".update "$upd" ||
515 die "$(eval_gettext "Failed to register update mode for submodule path '\$sm_path'")"
520 # Update each submodule path to correct revision, using clone and checkout as needed
522 # $@ = requested paths (default to all)
526 # parse $args after "submodule ... update".
547 case "$2" in '') usage ;; esac
548 reference="--reference=$2"
549 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
575 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
581 cmd_init "--" "$@" || return
587 while read mode sha1 stage sm_path
589 die_if_unmatched "$mode"
592 echo >&2 "Skipping unmerged submodule $sm_path"
595 name=$(module_name "$sm_path") || exit
596 url=$(git config submodule."$name".url)
597 if ! test -z "$update"
599 update_module=$update
601 update_module=$(git config submodule."$name".update)
604 if test "$update_module" = "none"
606 echo "Skipping submodule '$sm_path'"
612 # Only mention uninitialized submodules when its
613 # path have been specified
615 say "$(eval_gettext "Submodule path '\$sm_path' not initialized
616 Maybe you want to use 'update --init'?")"
620 if ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
622 module_clone "$sm_path" "$name" "$url" "$reference" || exit
623 cloned_modules="$cloned_modules;$name"
626 subsha1=$(clear_local_git_env; cd "$sm_path" &&
627 git rev-parse --verify HEAD) ||
628 die "$(eval_gettext "Unable to find current revision in submodule path '\$sm_path'")"
631 if test "$subsha1" != "$sha1" -o -n "$force"
634 # If we don't already have a -f flag and the submodule has never been checked out
635 if test -z "$subsha1" -a -z "$force"
640 if test -z "$nofetch"
642 # Run fetch only if $sha1 isn't present or it
643 # is not reachable from a ref.
644 (clear_local_git_env; cd "$sm_path" &&
645 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
646 test -z "$rev") || git-fetch)) ||
647 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
650 # Is this something we just cloned?
651 case ";$cloned_modules;" in
653 # then there is no local change to integrate
658 case "$update_module" in
661 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$sm_path'")"
662 say_msg="$(eval_gettext "Submodule path '\$sm_path': rebased into '\$sha1'")"
663 must_die_on_failure=yes
667 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$sm_path'")"
668 say_msg="$(eval_gettext "Submodule path '\$sm_path': merged in '\$sha1'")"
669 must_die_on_failure=yes
672 command="git checkout $subforce -q"
673 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$sm_path'")"
674 say_msg="$(eval_gettext "Submodule path '\$sm_path': checked out '\$sha1'")"
678 if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
681 elif test -n "$must_die_on_failure"
683 die_with_status 2 "$die_msg"
685 err="${err};$die_msg"
690 if test -n "$recursive"
692 (clear_local_git_env; cd "$sm_path" && eval cmd_update "$orig_flags")
696 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
699 err="${err};$die_msg"
702 die_with_status $res "$die_msg"
729 git describe "$2" 2>/dev/null ||
730 git describe --tags "$2" 2>/dev/null ||
731 git describe --contains "$2" 2>/dev/null ||
732 git describe --all --always "$2"
735 test -z "$revname" || revname=" ($revname)"
738 # Show commit summary for submodules in index or working tree
740 # If '--cached' is given, show summary between index and given commit,
741 # or between working tree and given commit
743 # $@ = [commit (default 'HEAD'),] requested paths (default all)
750 # parse $args after "submodule ... summary".
764 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
786 test $summary_limit = 0 && return
788 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
792 elif test -z "$1" -o "$1" = "HEAD"
794 # before the first commit: compare with an empty tree
795 head=$(git hash-object -w -t tree --stdin </dev/null)
796 test -z "$1" || shift
804 die "$(gettext "The --cached option cannot be used with the --files option")"
810 # Get modified modules cared by user
811 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
812 sane_egrep '^:([0-7]* )?160000' |
813 while read mod_src mod_dst sha1_src sha1_dst status name
815 # Always show modules deleted or type-changed (blob<->module)
816 test $status = D -o $status = T && echo "$name" && continue
817 # Also show added or modified modules which are checked out
818 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
823 test -z "$modules" && return
825 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
826 sane_egrep '^:([0-7]* )?160000' |
828 while read mod_src mod_dst sha1_src sha1_dst status name
830 if test -z "$cached" &&
831 test $sha1_dst = 0000000000000000000000000000000000000000
835 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
837 100644 | 100755 | 120000)
838 sha1_dst=$(git hash-object $name)
844 eval_gettextln "unexpected mode \$mod_dst" >&2
851 test $mod_src = 160000 &&
852 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
855 test $mod_dst = 160000 &&
856 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
860 case "$missing_src,$missing_dst" in
862 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_src")"
865 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_dst")"
868 errmsg="$(eval_gettext " Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
873 if test $mod_src = 160000 -a $mod_dst = 160000
875 range="$sha1_src...$sha1_dst"
876 elif test $mod_src = 160000
882 GIT_DIR="$name/.git" \
883 git rev-list --first-parent $range -- | wc -l
885 total_commits=" ($(($total_commits + 0)))"
889 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
890 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
893 blob="$(gettext "blob")"
894 submodule="$(gettext "submodule")"
895 if test $mod_dst = 160000
897 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
899 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
902 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
906 # Don't give error msg for modification whose dst is not submodule
907 # i.e. deleted or changed to blob
908 test $mod_dst = 160000 && echo "$errmsg"
910 if test $mod_src = 160000 -a $mod_dst = 160000
913 test $summary_limit -gt 0 && limit="-$summary_limit"
914 GIT_DIR="$name/.git" \
915 git log $limit --pretty='format: %m %s' \
916 --first-parent $sha1_src...$sha1_dst
917 elif test $mod_dst = 160000
919 GIT_DIR="$name/.git" \
920 git log --pretty='format: > %s' -1 $sha1_dst
922 GIT_DIR="$name/.git" \
923 git log --pretty='format: < %s' -1 $sha1_src
929 if test -n "$for_status"; then
930 if [ -n "$files" ]; then
931 gettextln "# Submodules changed but not updated:"
933 gettextln "# Submodule changes to be committed:"
936 sed -e 's|^|# |' -e 's|^# $|#|'
942 # List all submodules, prefixed with:
943 # - submodule not initialized
944 # + different revision checked out
946 # If --cached was specified the revision in the index will be printed
947 # instead of the currently checked out revision.
949 # $@ = requested paths (default to all)
953 # parse $args after "submodule ... status".
978 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
983 while read mode sha1 stage sm_path
985 die_if_unmatched "$mode"
986 name=$(module_name "$sm_path") || exit
987 url=$(git config submodule."$name".url)
988 displaypath="$prefix$sm_path"
991 say "U$sha1 $displaypath"
994 if test -z "$url" || ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
996 say "-$sha1 $displaypath"
999 set_name_rev "$sm_path" "$sha1"
1000 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1002 say " $sha1 $displaypath$revname"
1004 if test -z "$cached"
1006 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1007 set_name_rev "$sm_path" "$sha1"
1009 say "+$sha1 $displaypath$revname"
1012 if test -n "$recursive"
1015 prefix="$displaypath/"
1018 eval cmd_status "$orig_args"
1020 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1025 # Sync remote urls for submodules
1026 # This makes the value for remote.$remote.url match the value
1027 # specified in .gitmodules.
1052 while read mode sha1 stage sm_path
1054 die_if_unmatched "$mode"
1055 name=$(module_name "$sm_path")
1056 url=$(git config -f .gitmodules --get submodule."$name".url)
1058 # Possibly a url relative to parent
1061 # rewrite foo/bar as ../.. to find path from
1062 # submodule work tree to superproject work tree
1063 up_path="$(echo "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1064 # guarantee a trailing /
1065 up_path=${up_path%/}/ &&
1066 # path from submodule work tree to submodule origin repo
1067 sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1068 # path from superproject work tree to submodule origin repo
1069 super_config_url=$(resolve_relative_url "$url") || exit
1072 sub_origin_url="$url"
1073 super_config_url="$url"
1077 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1079 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
1080 git config submodule."$name".url "$super_config_url"
1082 if test -e "$sm_path"/.git
1087 remote=$(get_default_remote)
1088 git config remote."$remote".url "$sub_origin_url"
1095 # This loop parses the command line arguments to find the
1096 # subcommand name to dispatch. Parsing of the subcommand specific
1097 # options are primarily done by the subcommand implementations.
1098 # Subcommand specific options such as --branch and --cached are
1099 # parsed here as well, for backward compatibility.
1101 while test $# != 0 && test -z "$command"
1104 add | foreach | init | update | status | summary | sync)
1134 # No command word defaults to "status"
1135 if test -z "$command"
1145 # "-b branch" is accepted only by "add"
1146 if test -n "$branch" && test "$command" != add
1151 # "--cached" is accepted only by "status" and "summary"
1152 if test -n "$cached" && test "$command" != status -a "$command" != summary