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] [--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>...]"
33 # The function takes at most 2 arguments. The first argument is the
34 # URL that navigates to the submodule origin repo. When relative, this URL
35 # is relative to the superproject origin URL repo. The second up_path
36 # argument, if specified, is the relative path that navigates
37 # from the submodule working tree to the superproject working tree.
39 # The output of the function is the origin URL of the submodule.
41 # The output will either be an absolute URL or filesystem path (if the
42 # superproject origin URL is an absolute URL or filesystem path,
43 # respectively) or a relative file system path (if the superproject
44 # origin URL is a relative file system path).
46 # When the output is a relative file system path, the path is either
47 # relative to the submodule working tree, if up_path is specified, or to
48 # the superproject working tree otherwise.
49 resolve_relative_url ()
51 remote=$(get_default_remote)
52 remoteurl=$(git config "remote.$remote.url") ||
53 remoteurl=$(pwd) # the repository is its own authoritative upstream
55 remoteurl=${remoteurl%/}
68 remoteurl="./$remoteurl"
79 remoteurl="${remoteurl%/*}"
82 remoteurl="${remoteurl%:*}"
86 if test -z "$is_relative" || test "." = "$remoteurl"
88 die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
102 remoteurl="$remoteurl$sep${url%/}"
103 echo "${is_relative:+${up_path}}${remoteurl#./}"
107 # Get submodule info for registered submodules
108 # $@ = path to limit submodule list
112 git ls-files --error-unmatch --stage -- "$@" |
115 my ($null_sha1) = ("0" x 40);
118 my ($mode, $sha1, $stage, $path) =
119 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
120 next unless $mode eq "160000";
122 if (!$unmerged{$path}++) {
123 print "$mode $null_sha1 U\t$path\n";
133 # Map submodule path to submodule name
139 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
141 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
142 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
143 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
145 die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$sm_path'")"
152 # Prior to calling, cmd_update checks that a possibly existing
153 # path is not a git repository.
154 # Likewise, cmd_add checks that path does not exist at all,
155 # since it is the location of a new submodule.
163 if test -n "$GIT_QUIET"
170 name=$(module_name "$sm_path" 2>/dev/null)
171 test -n "$name" || name="$sm_path"
172 base_name=$(dirname "$name")
174 gitdir=$(git rev-parse --git-dir)
175 gitdir_base="$gitdir/modules/$base_name"
176 gitdir="$gitdir/modules/$name"
181 rm -f "$gitdir/index"
183 mkdir -p "$gitdir_base"
184 git clone $quiet -n ${reference:+"$reference"} \
185 --separate-git-dir "$gitdir" "$url" "$sm_path" ||
186 die "$(eval_gettext "Clone of '\$url' into submodule path '\$sm_path' failed")"
189 # We already are at the root of the work tree but cd_to_toplevel will
190 # resolve any symlinks that might be present in $PWD
191 a=$(cd_to_toplevel && cd "$gitdir" && pwd)/
192 b=$(cd_to_toplevel && cd "$sm_path" && pwd)/
193 # normalize Windows-style absolute paths to POSIX-style absolute paths
194 case $a in [a-zA-Z]:/*) a=/${a%%:*}${a#*:} ;; esac
195 case $b in [a-zA-Z]:/*) b=/${b%%:*}${b#*:} ;; esac
196 # Remove all common leading directories after a sanity check
197 if test "${a#$b}" != "$a" || test "${b#$a}" != "$b"; then
198 die "$(eval_gettext "Gitdir '\$a' is part of the submodule path '\$b' or vice versa")"
200 while test "${a%%/*}" = "${b%%/*}"
205 # Now chop off the trailing '/'s that were added in the beginning
209 # Turn each leading "*/" component into "../"
210 rel=$(echo $b | sed -e 's|[^/][^/]*|..|g')
211 echo "gitdir: $rel/$a" >"$sm_path/.git"
213 rel=$(echo $a | sed -e 's|[^/][^/]*|..|g')
214 (clear_local_git_env; cd "$sm_path" && GIT_WORK_TREE=. git config core.worktree "$rel/$b")
218 # Add a new submodule to the working tree, .gitmodules and the index
222 # optional branch is stored in global branch variable
226 # parse $args after "submodule ... add".
231 case "$2" in '') usage ;; esac
242 case "$2" in '') usage ;; esac
243 reference="--reference=$2"
267 if test -z "$sm_path"; then
268 sm_path=$(echo "$repo" |
269 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
272 if test -z "$repo" -o -z "$sm_path"; then
276 # assure repo is absolute or relative to parent
279 # dereference source url relative to parent's url
280 realrepo=$(resolve_relative_url "$repo") || exit
287 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
292 # multiple //; leading ./; /./; /../; trailing /
293 sm_path=$(printf '%s/\n' "$sm_path" |
303 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
304 die "$(eval_gettext "'\$sm_path' already exists in the index")"
306 if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
308 eval_gettextln "The following path is ignored by one of your .gitignore files:
310 Use -f if you really want to add it." >&2
314 # perhaps the path exists and is already a git repo, else clone it
315 if test -e "$sm_path"
317 if test -d "$sm_path"/.git -o -f "$sm_path"/.git
319 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
321 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
326 module_clone "$sm_path" "$realrepo" "$reference" || exit
330 # ash fails to wordsplit ${branch:+-b "$branch"...}
332 '') git checkout -f -q ;;
333 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
335 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
337 git config submodule."$sm_path".url "$realrepo"
339 git add $force "$sm_path" ||
340 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
342 git config -f .gitmodules submodule."$sm_path".path "$sm_path" &&
343 git config -f .gitmodules submodule."$sm_path".url "$repo" &&
344 git add --force .gitmodules ||
345 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
349 # Execute an arbitrary command sequence in each checked out
352 # $@ = command to execute
356 # parse $args after "submodule ... foreach".
378 # dup stdin so that it can be restored when running the external
379 # command in the subshell (and a recursive call to this function)
383 while read mode sha1 stage sm_path
385 if test -e "$sm_path"/.git
387 say "$(eval_gettext "Entering '\$prefix\$sm_path'")"
388 name=$(module_name "$sm_path")
390 prefix="$prefix$sm_path/"
392 # we make $path available to scripts ...
396 if test -n "$recursive"
398 cmd_foreach "--recursive" "$@"
401 die "$(eval_gettext "Stopping at '\$sm_path'; script returned non-zero status.")"
407 # Register submodules in .git/config
409 # $@ = requested paths (default to all)
413 # parse $args after "submodule ... init".
435 while read mode sha1 stage sm_path
437 name=$(module_name "$sm_path") || exit
439 # Copy url setting when it is not set yet
440 if test -z "$(git config "submodule.$name.url")"
442 url=$(git config -f .gitmodules submodule."$name".url)
444 die "$(eval_gettext "No url found for submodule path '\$sm_path' in .gitmodules")"
446 # Possibly a url relative to parent
449 url=$(resolve_relative_url "$url") || exit
452 git config submodule."$name".url "$url" ||
453 die "$(eval_gettext "Failed to register url for submodule path '\$sm_path'")"
455 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$sm_path'")"
458 # Copy "update" setting when it is not set yet
459 upd="$(git config -f .gitmodules submodule."$name".update)"
461 test -n "$(git config submodule."$name".update)" ||
462 git config submodule."$name".update "$upd" ||
463 die "$(eval_gettext "Failed to register update mode for submodule path '\$sm_path'")"
468 # Update each submodule path to correct revision, using clone and checkout as needed
470 # $@ = requested paths (default to all)
474 # parse $args after "submodule ... update".
495 case "$2" in '') usage ;; esac
496 reference="--reference=$2"
497 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
523 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
529 cmd_init "--" "$@" || return
535 while read mode sha1 stage sm_path
539 echo >&2 "Skipping unmerged submodule $sm_path"
542 name=$(module_name "$sm_path") || exit
543 url=$(git config submodule."$name".url)
544 if ! test -z "$update"
546 update_module=$update
548 update_module=$(git config submodule."$name".update)
551 if test "$update_module" = "none"
553 echo "Skipping submodule '$sm_path'"
559 # Only mention uninitialized submodules when its
560 # path have been specified
562 say "$(eval_gettext "Submodule path '\$sm_path' not initialized
563 Maybe you want to use 'update --init'?")"
567 if ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
569 module_clone "$sm_path" "$url" "$reference"|| exit
570 cloned_modules="$cloned_modules;$name"
573 subsha1=$(clear_local_git_env; cd "$sm_path" &&
574 git rev-parse --verify HEAD) ||
575 die "$(eval_gettext "Unable to find current revision in submodule path '\$sm_path'")"
578 if test "$subsha1" != "$sha1"
581 # If we don't already have a -f flag and the submodule has never been checked out
582 if test -z "$subsha1" -a -z "$force"
587 if test -z "$nofetch"
589 # Run fetch only if $sha1 isn't present or it
590 # is not reachable from a ref.
591 (clear_local_git_env; cd "$sm_path" &&
592 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
593 test -z "$rev") || git-fetch)) ||
594 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
597 # Is this something we just cloned?
598 case ";$cloned_modules;" in
600 # then there is no local change to integrate
605 case "$update_module" in
608 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$sm_path'")"
609 say_msg="$(eval_gettext "Submodule path '\$sm_path': rebased into '\$sha1'")"
610 must_die_on_failure=yes
614 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$sm_path'")"
615 say_msg="$(eval_gettext "Submodule path '\$sm_path': merged in '\$sha1'")"
616 must_die_on_failure=yes
619 command="git checkout $subforce -q"
620 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$sm_path'")"
621 say_msg="$(eval_gettext "Submodule path '\$sm_path': checked out '\$sha1'")"
625 if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
628 elif test -n "$must_die_on_failure"
630 die_with_status 2 "$die_msg"
632 err="${err};$die_msg"
637 if test -n "$recursive"
639 (clear_local_git_env; cd "$sm_path" && eval cmd_update "$orig_flags")
643 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
646 err="${err};$die_msg"
649 die_with_status $res "$die_msg"
676 git describe "$2" 2>/dev/null ||
677 git describe --tags "$2" 2>/dev/null ||
678 git describe --contains "$2" 2>/dev/null ||
679 git describe --all --always "$2"
682 test -z "$revname" || revname=" ($revname)"
685 # Show commit summary for submodules in index or working tree
687 # If '--cached' is given, show summary between index and given commit,
688 # or between working tree and given commit
690 # $@ = [commit (default 'HEAD'),] requested paths (default all)
697 # parse $args after "submodule ... summary".
711 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
733 test $summary_limit = 0 && return
735 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
739 elif test -z "$1" -o "$1" = "HEAD"
741 # before the first commit: compare with an empty tree
742 head=$(git hash-object -w -t tree --stdin </dev/null)
743 test -z "$1" || shift
751 die "$(gettext -- "--cached cannot be used with --files")"
757 # Get modified modules cared by user
758 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
759 sane_egrep '^:([0-7]* )?160000' |
760 while read mod_src mod_dst sha1_src sha1_dst status name
762 # Always show modules deleted or type-changed (blob<->module)
763 test $status = D -o $status = T && echo "$name" && continue
764 # Also show added or modified modules which are checked out
765 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
770 test -z "$modules" && return
772 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
773 sane_egrep '^:([0-7]* )?160000' |
775 while read mod_src mod_dst sha1_src sha1_dst status name
777 if test -z "$cached" &&
778 test $sha1_dst = 0000000000000000000000000000000000000000
782 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
784 100644 | 100755 | 120000)
785 sha1_dst=$(git hash-object $name)
791 eval_gettextln "unexpected mode \$mod_dst" >&2
798 test $mod_src = 160000 &&
799 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
802 test $mod_dst = 160000 &&
803 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
807 case "$missing_src,$missing_dst" in
809 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_src")"
812 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_dst")"
815 errmsg="$(eval_gettext " Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
820 if test $mod_src = 160000 -a $mod_dst = 160000
822 range="$sha1_src...$sha1_dst"
823 elif test $mod_src = 160000
829 GIT_DIR="$name/.git" \
830 git rev-list --first-parent $range -- | wc -l
832 total_commits=" ($(($total_commits + 0)))"
836 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
837 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
840 blob="$(gettext "blob")"
841 submodule="$(gettext "submodule")"
842 if test $mod_dst = 160000
844 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
846 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
849 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
853 # Don't give error msg for modification whose dst is not submodule
854 # i.e. deleted or changed to blob
855 test $mod_dst = 160000 && echo "$errmsg"
857 if test $mod_src = 160000 -a $mod_dst = 160000
860 test $summary_limit -gt 0 && limit="-$summary_limit"
861 GIT_DIR="$name/.git" \
862 git log $limit --pretty='format: %m %s' \
863 --first-parent $sha1_src...$sha1_dst
864 elif test $mod_dst = 160000
866 GIT_DIR="$name/.git" \
867 git log --pretty='format: > %s' -1 $sha1_dst
869 GIT_DIR="$name/.git" \
870 git log --pretty='format: < %s' -1 $sha1_src
876 if test -n "$for_status"; then
877 if [ -n "$files" ]; then
878 gettextln "# Submodules changed but not updated:"
880 gettextln "# Submodule changes to be committed:"
883 sed -e 's|^|# |' -e 's|^# $|#|'
889 # List all submodules, prefixed with:
890 # - submodule not initialized
891 # + different revision checked out
893 # If --cached was specified the revision in the index will be printed
894 # instead of the currently checked out revision.
896 # $@ = requested paths (default to all)
900 # parse $args after "submodule ... status".
925 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
930 while read mode sha1 stage sm_path
932 name=$(module_name "$sm_path") || exit
933 url=$(git config submodule."$name".url)
934 displaypath="$prefix$sm_path"
937 say "U$sha1 $displaypath"
940 if test -z "$url" || ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
942 say "-$sha1 $displaypath"
945 set_name_rev "$sm_path" "$sha1"
946 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
948 say " $sha1 $displaypath$revname"
952 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
953 set_name_rev "$sm_path" "$sha1"
955 say "+$sha1 $displaypath$revname"
958 if test -n "$recursive"
961 prefix="$displaypath/"
964 eval cmd_status "$orig_args"
966 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
971 # Sync remote urls for submodules
972 # This makes the value for remote.$remote.url match the value
973 # specified in .gitmodules.
998 while read mode sha1 stage sm_path
1000 name=$(module_name "$sm_path")
1001 url=$(git config -f .gitmodules --get submodule."$name".url)
1003 # Possibly a url relative to parent
1006 # rewrite foo/bar as ../.. to find path from
1007 # submodule work tree to superproject work tree
1008 up_path="$(echo "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1009 # guarantee a trailing /
1010 up_path=${up_path%/}/ &&
1011 # path from submodule work tree to submodule origin repo
1012 sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1013 # path from superproject work tree to submodule origin repo
1014 super_config_url=$(resolve_relative_url "$url") || exit
1017 sub_origin_url="$url"
1018 super_config_url="$url"
1022 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1024 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
1025 git config submodule."$name".url "$super_config_url"
1027 if test -e "$sm_path"/.git
1032 remote=$(get_default_remote)
1033 git config remote."$remote".url "$sub_origin_url"
1040 # This loop parses the command line arguments to find the
1041 # subcommand name to dispatch. Parsing of the subcommand specific
1042 # options are primarily done by the subcommand implementations.
1043 # Subcommand specific options such as --branch and --cached are
1044 # parsed here as well, for backward compatibility.
1046 while test $# != 0 && test -z "$command"
1049 add | foreach | init | update | status | summary | sync)
1079 # No command word defaults to "status"
1080 test -n "$command" || command=status
1082 # "-b branch" is accepted only by "add"
1083 if test -n "$branch" && test "$command" != add
1088 # "--cached" is accepted only by "status" and "summary"
1089 if test -n "$cached" && test "$command" != status -a "$command" != summary