3 # git-submodules.sh: add, init, update or list git submodules
5 # Copyright (c) 2007 Lars Hjemli
7 USAGE="[--quiet] [--cached] \
8 [add [-b branch] <repo> <path>]|[status|init|update [-i|--init] [-N|--no-fetch]|summary [-n|--summary-limit <n>] [<commit>]] \
9 [--] [<path>...]|[foreach <command>]|[sync [--] [<path>...]]"
22 # Resolve relative url by appending to parent's url
23 resolve_relative_url ()
25 remote=$(get_default_remote)
26 remoteurl=$(git config "remote.$remote.url") ||
27 die "remote ($remote) does not have a url defined in .git/config"
29 remoteurl=${remoteurl%/}
35 remoteurl="${remoteurl%/*}"
44 echo "$remoteurl/${url%/}"
48 # Get submodule info for registered submodules
49 # $@ = path to limit submodule list
53 git ls-files --error-unmatch --stage -- "$@" | grep '^160000 '
57 # Map submodule path to submodule name
63 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
64 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
65 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
66 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
68 die "No submodule mapping found in .gitmodules for path '$path'"
75 # Prior to calling, cmd_update checks that a possibly existing
76 # path is not a git repository.
77 # Likewise, cmd_add checks that path does not exist at all,
78 # since it is the location of a new submodule.
86 # If there already is a directory at the submodule path,
87 # expect it to be empty (since that is the default checkout
88 # action) and try to remove it.
89 # Note: if $path is a symlink to a directory the test will
90 # succeed but the rmdir will fail. We might want to fix this.
93 rmdir "$path" 2>/dev/null ||
94 die "Directory '$path' exist, but is neither empty nor a git repository"
98 die "A file already exist at path '$path'"
100 if test -n "$reference"
102 git-clone "$reference" -n "$url" "$path"
104 git-clone -n "$url" "$path"
106 die "Clone of '$url' into submodule path '$path' failed"
110 # Add a new submodule to the working tree, .gitmodules and the index
114 # optional branch is stored in global branch variable
118 # parse $args after "submodule ... add".
123 case "$2" in '') usage ;; esac
131 case "$2" in '') usage ;; esac
132 reference="--reference=$2"
156 if test -z "$repo" -o -z "$path"; then
160 # assure repo is absolute or relative to parent
163 # dereference source url relative to parent's url
164 realrepo=$(resolve_relative_url "$repo") || exit
171 die "repo URL: '$repo' must be absolute or begin with ./|../"
176 # multiple //; leading ./; /./; /../; trailing /
177 path=$(printf '%s/\n' "$path" |
187 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
188 die "'$path' already exists in the index"
190 # perhaps the path exists and is already a git repo, else clone it
193 if test -d "$path"/.git -o -f "$path"/.git
195 echo "Adding existing repo at '$path' to the index"
197 die "'$path' already exists and is not a valid git repo"
202 url=$(resolve_relative_url "$repo") || exit
208 git config submodule."$path".url "$url"
211 module_clone "$path" "$realrepo" "$reference" || exit
215 # ash fails to wordsplit ${branch:+-b "$branch"...}
217 '') git checkout -f -q ;;
218 ?*) git checkout -f -q -b "$branch" "origin/$branch" ;;
220 ) || die "Unable to checkout submodule '$path'"
224 die "Failed to add submodule '$path'"
226 git config -f .gitmodules submodule."$path".path "$path" &&
227 git config -f .gitmodules submodule."$path".url "$repo" &&
228 git add .gitmodules ||
229 die "Failed to register submodule '$path'"
233 # Execute an arbitrary command sequence in each checked out
236 # $@ = command to execute
241 while read mode sha1 stage path
243 if test -e "$path"/.git
245 say "Entering '$path'"
246 (cd "$path" && eval "$@") ||
247 die "Stopping at '$path'; script returned non-zero status."
253 # Register submodules in .git/config
255 # $@ = requested paths (default to all)
259 # parse $args after "submodule ... init".
281 while read mode sha1 stage path
283 # Skip already registered paths
284 name=$(module_name "$path") || exit
285 url=$(git config submodule."$name".url)
286 test -z "$url" || continue
288 url=$(git config -f .gitmodules submodule."$name".url)
290 die "No url found for submodule path '$path' in .gitmodules"
292 # Possibly a url relative to parent
295 url=$(resolve_relative_url "$url") || exit
299 git config submodule."$name".url "$url" ||
300 die "Failed to register url for submodule path '$path'"
302 upd="$(git config -f .gitmodules submodule."$name".update)"
304 git config submodule."$name".update "$upd" ||
305 die "Failed to register update mode for submodule path '$path'"
307 say "Submodule '$name' ($url) registered for path '$path'"
312 # Update each submodule path to correct revision, using clone and checkout as needed
314 # $@ = requested paths (default to all)
318 # parse $args after "submodule ... update".
339 case "$2" in '') usage ;; esac
340 reference="--reference=$2"
362 cmd_init "--" "$@" || return
366 while read mode sha1 stage path
368 name=$(module_name "$path") || exit
369 url=$(git config submodule."$name".url)
370 update_module=$(git config submodule."$name".update)
373 # Only mention uninitialized submodules when its
374 # path have been specified
376 say "Submodule path '$path' not initialized" &&
377 say "Maybe you want to use 'update --init'?"
381 if ! test -d "$path"/.git -o -f "$path"/.git
383 module_clone "$path" "$url" "$reference"|| exit
386 subsha1=$(unset GIT_DIR; cd "$path" &&
387 git rev-parse --verify HEAD) ||
388 die "Unable to find current revision in submodule path '$path'"
391 if ! test -z "$update"
393 update_module=$update
396 if test "$subsha1" != "$sha1"
399 if test -z "$subsha1"
404 if test -z "$nofetch"
406 (unset GIT_DIR; cd "$path" &&
408 die "Unable to fetch in submodule path '$path'"
411 case "$update_module" in
418 command="git checkout $force -q"
424 (unset GIT_DIR; cd "$path" && $command "$sha1") ||
425 die "Unable to $action '$sha1' in submodule path '$path'"
426 say "Submodule path '$path': $msg '$sha1'"
435 git describe "$2" 2>/dev/null ||
436 git describe --tags "$2" 2>/dev/null ||
437 git describe --contains "$2" 2>/dev/null ||
438 git describe --all --always "$2"
441 test -z "$revname" || revname=" ($revname)"
444 # Show commit summary for submodules in index or working tree
446 # If '--cached' is given, show summary between index and given commit,
447 # or between working tree and given commit
449 # $@ = [commit (default 'HEAD'),] requested paths (default all)
455 # parse $args after "submodule ... summary".
466 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
488 test $summary_limit = 0 && return
490 if rev=$(git rev-parse -q --verify "$1^0")
499 # Get modified modules cared by user
500 modules=$(git diff-index $cached --raw $head -- "$@" |
501 egrep '^:([0-7]* )?160000' |
502 while read mod_src mod_dst sha1_src sha1_dst status name
504 # Always show modules deleted or type-changed (blob<->module)
505 test $status = D -o $status = T && echo "$name" && continue
506 # Also show added or modified modules which are checked out
507 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
512 test -z "$modules" && return
514 git diff-index $cached --raw $head -- $modules |
515 egrep '^:([0-7]* )?160000' |
517 while read mod_src mod_dst sha1_src sha1_dst status name
519 if test -z "$cached" &&
520 test $sha1_dst = 0000000000000000000000000000000000000000
524 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
526 100644 | 100755 | 120000)
527 sha1_dst=$(git hash-object $name)
533 echo >&2 "unexpected mode $mod_dst"
540 test $mod_src = 160000 &&
541 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
544 test $mod_dst = 160000 &&
545 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
549 case "$missing_src,$missing_dst" in
551 errmsg=" Warn: $name doesn't contain commit $sha1_src"
554 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
557 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
562 if test $mod_src = 160000 -a $mod_dst = 160000
564 range="$sha1_src...$sha1_dst"
565 elif test $mod_src = 160000
571 GIT_DIR="$name/.git" \
572 git log --pretty=oneline --first-parent $range | wc -l
574 total_commits=" ($(($total_commits + 0)))"
578 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
579 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
582 if test $mod_dst = 160000
584 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
586 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
589 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
593 # Don't give error msg for modification whose dst is not submodule
594 # i.e. deleted or changed to blob
595 test $mod_dst = 160000 && echo "$errmsg"
597 if test $mod_src = 160000 -a $mod_dst = 160000
600 test $summary_limit -gt 0 && limit="-$summary_limit"
601 GIT_DIR="$name/.git" \
602 git log $limit --pretty='format: %m %s' \
603 --first-parent $sha1_src...$sha1_dst
604 elif test $mod_dst = 160000
606 GIT_DIR="$name/.git" \
607 git log --pretty='format: > %s' -1 $sha1_dst
609 GIT_DIR="$name/.git" \
610 git log --pretty='format: < %s' -1 $sha1_src
616 if test -n "$for_status"; then
617 echo "# Modified submodules:"
619 sed -e 's|^|# |' -e 's|^# $|#|'
625 # List all submodules, prefixed with:
626 # - submodule not initialized
627 # + different revision checked out
629 # If --cached was specified the revision in the index will be printed
630 # instead of the currently checked out revision.
632 # $@ = requested paths (default to all)
636 # parse $args after "submodule ... status".
661 while read mode sha1 stage path
663 name=$(module_name "$path") || exit
664 url=$(git config submodule."$name".url)
665 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
670 set_name_rev "$path" "$sha1"
671 if git diff-files --quiet -- "$path"
673 say " $sha1 $path$revname"
677 sha1=$(unset GIT_DIR; cd "$path" && git rev-parse --verify HEAD)
678 set_name_rev "$path" "$sha1"
680 say "+$sha1 $path$revname"
685 # Sync remote urls for submodules
686 # This makes the value for remote.$remote.url match the value
687 # specified in .gitmodules.
712 while read mode sha1 stage path
714 name=$(module_name "$path")
715 url=$(git config -f .gitmodules --get submodule."$name".url)
717 # Possibly a url relative to parent
720 url=$(resolve_relative_url "$url") || exit
724 if test -e "$path"/.git
729 remote=$(get_default_remote)
730 say "Synchronizing submodule url for '$name'"
731 git config remote."$remote".url "$url"
737 # This loop parses the command line arguments to find the
738 # subcommand name to dispatch. Parsing of the subcommand specific
739 # options are primarily done by the subcommand implementations.
740 # Subcommand specific options such as --branch and --cached are
741 # parsed here as well, for backward compatibility.
743 while test $# != 0 && test -z "$command"
746 add | foreach | init | update | status | summary | sync)
776 # No command word defaults to "status"
777 test -n "$command" || command=status
779 # "-b branch" is accepted only by "add"
780 if test -n "$branch" && test "$command" != add
785 # "--cached" is accepted only by "status" and "summary"
786 if test -n "$cached" && test "$command" != status -a "$command" != summary