3 # git-submodules.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 # Resolve relative url by appending to parent's url
34 resolve_relative_url ()
36 remote=$(get_default_remote)
37 remoteurl=$(git config "remote.$remote.url") ||
38 remoteurl=$(pwd) # the repository is its own authoritative upstream
40 remoteurl=${remoteurl%/}
49 remoteurl="${remoteurl%/*}"
52 remoteurl="${remoteurl%:*}"
56 die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
67 echo "$remoteurl$sep${url%/}"
71 # Get submodule info for registered submodules
72 # $@ = path to limit submodule list
76 git ls-files --error-unmatch --stage -- "$@" |
79 my ($null_sha1) = ("0" x 40);
82 my ($mode, $sha1, $stage, $path) =
83 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
84 next unless $mode eq "160000";
86 if (!$unmerged{$path}++) {
87 print "$mode $null_sha1 U\t$path\n";
97 # Map submodule path to submodule name
103 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
104 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
105 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
106 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
108 die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$path'")"
115 # Prior to calling, cmd_update checks that a possibly existing
116 # path is not a git repository.
117 # Likewise, cmd_add checks that path does not exist at all,
118 # since it is the location of a new submodule.
126 if test -n "$GIT_QUIET"
133 name=$(module_name "$path" 2>/dev/null)
134 test -n "$name" || name="$path"
135 base_name=$(dirname "$name")
137 gitdir=$(git rev-parse --git-dir)
138 gitdir_base="$gitdir/modules/$base_name"
139 gitdir="$gitdir/modules/$name"
144 rm -f "$gitdir/index"
146 mkdir -p "$gitdir_base"
147 git clone $quiet -n ${reference:+"$reference"} \
148 --separate-git-dir "$gitdir" "$url" "$path" ||
149 die "$(eval_gettext "Clone of '\$url' into submodule path '\$path' failed")"
152 # We already are at the root of the work tree but cd_to_toplevel will
153 # resolve any symlinks that might be present in $PWD
154 a=$(cd_to_toplevel && cd "$gitdir" && pwd)/
155 b=$(cd_to_toplevel && cd "$path" && pwd)/
156 # normalize Windows-style absolute paths to POSIX-style absolute paths
157 case $a in [a-zA-Z]:/*) a=/${a%%:*}${a#*:} ;; esac
158 case $b in [a-zA-Z]:/*) b=/${b%%:*}${b#*:} ;; esac
159 # Remove all common leading directories after a sanity check
160 if test "${a#$b}" != "$a" || test "${b#$a}" != "$b"; then
161 die "$(eval_gettext "Gitdir '\$a' is part of the submodule path '\$b' or vice versa")"
163 while test "${a%%/*}" = "${b%%/*}"
168 # Now chop off the trailing '/'s that were added in the beginning
172 # Turn each leading "*/" component into "../"
173 rel=$(echo $b | sed -e 's|[^/][^/]*|..|g')
174 echo "gitdir: $rel/$a" >"$path/.git"
176 rel=$(echo $a | sed -e 's|[^/][^/]*|..|g')
177 (clear_local_git_env; cd "$path" && GIT_WORK_TREE=. git config core.worktree "$rel/$b")
181 # Add a new submodule to the working tree, .gitmodules and the index
185 # optional branch is stored in global branch variable
189 # parse $args after "submodule ... add".
194 case "$2" in '') usage ;; esac
205 case "$2" in '') usage ;; esac
206 reference="--reference=$2"
230 if test -z "$path"; then
231 path=$(echo "$repo" |
232 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
235 if test -z "$repo" -o -z "$path"; then
239 # assure repo is absolute or relative to parent
242 # dereference source url relative to parent's url
243 realrepo=$(resolve_relative_url "$repo") || exit
250 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
255 # multiple //; leading ./; /./; /../; trailing /
256 path=$(printf '%s/\n' "$path" |
266 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
267 die "$(eval_gettext "'\$path' already exists in the index")"
269 if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
271 eval_gettextln "The following path is ignored by one of your .gitignore files:
273 Use -f if you really want to add it." >&2
277 # perhaps the path exists and is already a git repo, else clone it
280 if test -d "$path"/.git -o -f "$path"/.git
282 eval_gettextln "Adding existing repo at '\$path' to the index"
284 die "$(eval_gettext "'\$path' already exists and is not a valid git repo")"
289 module_clone "$path" "$realrepo" "$reference" || exit
293 # ash fails to wordsplit ${branch:+-b "$branch"...}
295 '') git checkout -f -q ;;
296 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
298 ) || die "$(eval_gettext "Unable to checkout submodule '\$path'")"
300 git config submodule."$path".url "$realrepo"
302 git add $force "$path" ||
303 die "$(eval_gettext "Failed to add submodule '\$path'")"
305 git config -f .gitmodules submodule."$path".path "$path" &&
306 git config -f .gitmodules submodule."$path".url "$repo" &&
307 git add --force .gitmodules ||
308 die "$(eval_gettext "Failed to register submodule '\$path'")"
312 # Execute an arbitrary command sequence in each checked out
315 # $@ = command to execute
319 # parse $args after "submodule ... foreach".
341 # dup stdin so that it can be restored when running the external
342 # command in the subshell (and a recursive call to this function)
346 while read mode sha1 stage path
348 if test -e "$path"/.git
350 say "$(eval_gettext "Entering '\$prefix\$path'")"
351 name=$(module_name "$path")
353 prefix="$prefix$path/"
357 if test -n "$recursive"
359 cmd_foreach "--recursive" "$@"
362 die "$(eval_gettext "Stopping at '\$path'; script returned non-zero status.")"
368 # Register submodules in .git/config
370 # $@ = requested paths (default to all)
374 # parse $args after "submodule ... init".
396 while read mode sha1 stage path
398 # Skip already registered paths
399 name=$(module_name "$path") || exit
400 if test -z "$(git config "submodule.$name.url")"
402 url=$(git config -f .gitmodules submodule."$name".url)
404 die "$(eval_gettext "No url found for submodule path '\$path' in .gitmodules")"
406 # Possibly a url relative to parent
409 url=$(resolve_relative_url "$url") || exit
412 git config submodule."$name".url "$url" ||
413 die "$(eval_gettext "Failed to register url for submodule path '\$path'")"
416 # Copy "update" setting when it is not set yet
417 upd="$(git config -f .gitmodules submodule."$name".update)"
419 test -n "$(git config submodule."$name".update)" ||
420 git config submodule."$name".update "$upd" ||
421 die "$(eval_gettext "Failed to register update mode for submodule path '\$path'")"
423 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$path'")"
428 # Update each submodule path to correct revision, using clone and checkout as needed
430 # $@ = requested paths (default to all)
434 # parse $args after "submodule ... update".
455 case "$2" in '') usage ;; esac
456 reference="--reference=$2"
457 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
483 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
489 cmd_init "--" "$@" || return
495 while read mode sha1 stage path
499 echo >&2 "Skipping unmerged submodule $path"
502 name=$(module_name "$path") || exit
503 url=$(git config submodule."$name".url)
504 if ! test -z "$update"
506 update_module=$update
508 update_module=$(git config submodule."$name".update)
511 if test "$update_module" = "none"
513 echo "Skipping submodule '$path'"
519 # Only mention uninitialized submodules when its
520 # path have been specified
522 say "$(eval_gettext "Submodule path '\$path' not initialized
523 Maybe you want to use 'update --init'?")"
527 if ! test -d "$path"/.git -o -f "$path"/.git
529 module_clone "$path" "$url" "$reference"|| exit
530 cloned_modules="$cloned_modules;$name"
533 subsha1=$(clear_local_git_env; cd "$path" &&
534 git rev-parse --verify HEAD) ||
535 die "$(eval_gettext "Unable to find current revision in submodule path '\$path'")"
538 if test "$subsha1" != "$sha1"
541 # If we don't already have a -f flag and the submodule has never been checked out
542 if test -z "$subsha1" -a -z "$force"
547 if test -z "$nofetch"
549 # Run fetch only if $sha1 isn't present or it
550 # is not reachable from a ref.
551 (clear_local_git_env; cd "$path" &&
552 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
553 test -z "$rev") || git-fetch)) ||
554 die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
557 # Is this something we just cloned?
558 case ";$cloned_modules;" in
560 # then there is no local change to integrate
565 case "$update_module" in
568 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$path'")"
569 say_msg="$(eval_gettext "Submodule path '\$path': rebased into '\$sha1'")"
570 must_die_on_failure=yes
574 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$path'")"
575 say_msg="$(eval_gettext "Submodule path '\$path': merged in '\$sha1'")"
576 must_die_on_failure=yes
579 command="git checkout $subforce -q"
580 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$path'")"
581 say_msg="$(eval_gettext "Submodule path '\$path': checked out '\$sha1'")"
585 if (clear_local_git_env; cd "$path" && $command "$sha1")
588 elif test -n "$must_die_on_failure"
590 die_with_status 2 "$die_msg"
592 err="${err};$die_msg"
597 if test -n "$recursive"
599 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags")
603 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$path'")"
606 err="${err};$die_msg"
609 die_with_status $res "$die_msg"
636 git describe "$2" 2>/dev/null ||
637 git describe --tags "$2" 2>/dev/null ||
638 git describe --contains "$2" 2>/dev/null ||
639 git describe --all --always "$2"
642 test -z "$revname" || revname=" ($revname)"
645 # Show commit summary for submodules in index or working tree
647 # If '--cached' is given, show summary between index and given commit,
648 # or between working tree and given commit
650 # $@ = [commit (default 'HEAD'),] requested paths (default all)
657 # parse $args after "submodule ... summary".
671 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
693 test $summary_limit = 0 && return
695 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
699 elif test -z "$1" -o "$1" = "HEAD"
701 # before the first commit: compare with an empty tree
702 head=$(git hash-object -w -t tree --stdin </dev/null)
703 test -z "$1" || shift
711 die "$(gettext -- "--cached cannot be used with --files")"
717 # Get modified modules cared by user
718 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
719 sane_egrep '^:([0-7]* )?160000' |
720 while read mod_src mod_dst sha1_src sha1_dst status name
722 # Always show modules deleted or type-changed (blob<->module)
723 test $status = D -o $status = T && echo "$name" && continue
724 # Also show added or modified modules which are checked out
725 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
730 test -z "$modules" && return
732 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
733 sane_egrep '^:([0-7]* )?160000' |
735 while read mod_src mod_dst sha1_src sha1_dst status name
737 if test -z "$cached" &&
738 test $sha1_dst = 0000000000000000000000000000000000000000
742 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
744 100644 | 100755 | 120000)
745 sha1_dst=$(git hash-object $name)
751 eval_gettextln "unexpected mode \$mod_dst" >&2
758 test $mod_src = 160000 &&
759 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
762 test $mod_dst = 160000 &&
763 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
767 case "$missing_src,$missing_dst" in
769 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_src")"
772 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_dst")"
775 errmsg="$(eval_gettext " Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
780 if test $mod_src = 160000 -a $mod_dst = 160000
782 range="$sha1_src...$sha1_dst"
783 elif test $mod_src = 160000
789 GIT_DIR="$name/.git" \
790 git rev-list --first-parent $range -- | wc -l
792 total_commits=" ($(($total_commits + 0)))"
796 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
797 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
800 blob="$(gettext "blob")"
801 submodule="$(gettext "submodule")"
802 if test $mod_dst = 160000
804 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
806 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
809 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
813 # Don't give error msg for modification whose dst is not submodule
814 # i.e. deleted or changed to blob
815 test $mod_dst = 160000 && echo "$errmsg"
817 if test $mod_src = 160000 -a $mod_dst = 160000
820 test $summary_limit -gt 0 && limit="-$summary_limit"
821 GIT_DIR="$name/.git" \
822 git log $limit --pretty='format: %m %s' \
823 --first-parent $sha1_src...$sha1_dst
824 elif test $mod_dst = 160000
826 GIT_DIR="$name/.git" \
827 git log --pretty='format: > %s' -1 $sha1_dst
829 GIT_DIR="$name/.git" \
830 git log --pretty='format: < %s' -1 $sha1_src
836 if test -n "$for_status"; then
837 if [ -n "$files" ]; then
838 gettextln "# Submodules changed but not updated:"
840 gettextln "# Submodule changes to be committed:"
843 sed -e 's|^|# |' -e 's|^# $|#|'
849 # List all submodules, prefixed with:
850 # - submodule not initialized
851 # + different revision checked out
853 # If --cached was specified the revision in the index will be printed
854 # instead of the currently checked out revision.
856 # $@ = requested paths (default to all)
860 # parse $args after "submodule ... status".
885 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
890 while read mode sha1 stage path
892 name=$(module_name "$path") || exit
893 url=$(git config submodule."$name".url)
894 displaypath="$prefix$path"
897 say "U$sha1 $displaypath"
900 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
902 say "-$sha1 $displaypath"
905 set_name_rev "$path" "$sha1"
906 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
908 say " $sha1 $displaypath$revname"
912 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
913 set_name_rev "$path" "$sha1"
915 say "+$sha1 $displaypath$revname"
918 if test -n "$recursive"
921 prefix="$displaypath/"
924 eval cmd_status "$orig_args"
926 die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
931 # Sync remote urls for submodules
932 # This makes the value for remote.$remote.url match the value
933 # specified in .gitmodules.
958 while read mode sha1 stage path
960 name=$(module_name "$path")
961 url=$(git config -f .gitmodules --get submodule."$name".url)
963 # Possibly a url relative to parent
966 url=$(resolve_relative_url "$url") || exit
970 if git config "submodule.$name.url" >/dev/null 2>/dev/null
972 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
973 git config submodule."$name".url "$url"
975 if test -e "$path"/.git
980 remote=$(get_default_remote)
981 git config remote."$remote".url "$url"
988 # This loop parses the command line arguments to find the
989 # subcommand name to dispatch. Parsing of the subcommand specific
990 # options are primarily done by the subcommand implementations.
991 # Subcommand specific options such as --branch and --cached are
992 # parsed here as well, for backward compatibility.
994 while test $# != 0 && test -z "$command"
997 add | foreach | init | update | status | summary | sync)
1027 # No command word defaults to "status"
1028 test -n "$command" || command=status
1030 # "-b branch" is accepted only by "add"
1031 if test -n "$branch" && test "$command" != add
1036 # "--cached" is accepted only by "status" and "summary"
1037 if test -n "$cached" && test "$command" != status -a "$command" != summary