3 # git-submodules.sh: add, init, update or list git submodules
5 # Copyright (c) 2007 Lars Hjemli
7 USAGE="[--quiet] [--cached] \
8 [add <repo> [-b branch]|status|init|update|summary [-n|--summary-limit <n>] [<commit>]] \
20 # print stuff on stdout unless -q was specified
30 # NEEDSWORK: identical function exists in get_repo_base in clone.sh
34 cd "$1" || cd "$1.git" &&
42 # Resolve relative url by appending to parent's url
43 resolve_relative_url ()
45 branch="$(git symbolic-ref HEAD 2>/dev/null)"
46 remote="$(git config branch.${branch#refs/heads/}.remote)"
47 remote="${remote:-origin}"
48 remoteurl="$(git config remote.$remote.url)" ||
49 die "remote ($remote) does not have a url in .git/config"
56 remoteurl="${remoteurl%/*}"
65 echo "$remoteurl/$url"
69 # Map submodule path to submodule name
75 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
76 re=$(printf '%s' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
77 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
78 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
80 die "No submodule mapping found in .gitmodules for path '$path'"
87 # Prior to calling, cmd_update checks that a possibly existing
88 # path is not a git repository.
89 # Likewise, cmd_add checks that path does not exist at all,
90 # since it is the location of a new submodule.
97 # If there already is a directory at the submodule path,
98 # expect it to be empty (since that is the default checkout
99 # action) and try to remove it.
100 # Note: if $path is a symlink to a directory the test will
101 # succeed but the rmdir will fail. We might want to fix this.
104 rmdir "$path" 2>/dev/null ||
105 die "Directory '$path' exist, but is neither empty nor a git repository"
109 die "A file already exist at path '$path'"
111 git-clone -n "$url" "$path" ||
112 die "Clone of '$url' into submodule path '$path' failed"
116 # Add a new submodule to the working tree, .gitmodules and the index
120 # optional branch is stored in global branch variable
124 # parse $args after "submodule ... add".
129 case "$2" in '') usage ;; esac
153 if test -z "$repo"; then
157 # Guess path from repo if not specified or strip trailing slashes
158 if test -z "$path"; then
159 path=$(echo "$repo" | sed -e 's|/*$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
161 path=$(echo "$path" | sed -e 's|/*$||')
164 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
165 die "'$path' already exists in the index"
167 # perhaps the path exists and is already a git repo, else clone it
170 if test -d "$path/.git" &&
171 test "$(unset GIT_DIR; cd $path; git rev-parse --git-dir)" = ".git"
173 echo "Adding existing repo at '$path' to the index"
175 die "'$path' already exists and is not a valid git repo"
180 # dereference source url relative to parent's url
181 realrepo="$(resolve_relative_url $repo)" ;;
183 # Turn the source into an absolute path if
185 if base=$(get_repo_base "$repo"); then
192 module_clone "$path" "$realrepo" || exit
193 (unset GIT_DIR; cd "$path" && git checkout -q ${branch:+-b "$branch" "origin/$branch"}) ||
194 die "Unable to checkout submodule '$path'"
198 die "Failed to add submodule '$path'"
200 git config -f .gitmodules submodule."$path".path "$path" &&
201 git config -f .gitmodules submodule."$path".url "$repo" &&
202 git add .gitmodules ||
203 die "Failed to register submodule '$path'"
207 # Register submodules in .git/config
209 # $@ = requested paths (default to all)
213 # parse $args after "submodule ... init".
234 git ls-files --stage -- "$@" | grep '^160000 ' |
235 while read mode sha1 stage path
237 # Skip already registered paths
238 name=$(module_name "$path") || exit
239 url=$(git config submodule."$name".url)
240 test -z "$url" || continue
242 url=$(git config -f .gitmodules submodule."$name".url)
244 die "No url found for submodule path '$path' in .gitmodules"
246 # Possibly a url relative to parent
249 url="$(resolve_relative_url "$url")"
253 git config submodule."$name".url "$url" ||
254 die "Failed to register url for submodule path '$path'"
256 say "Submodule '$name' ($url) registered for path '$path'"
261 # Update each submodule path to correct revision, using clone and checkout as needed
263 # $@ = requested paths (default to all)
267 # parse $args after "submodule ... update".
288 git ls-files --stage -- "$@" | grep '^160000 ' |
289 while read mode sha1 stage path
291 name=$(module_name "$path") || exit
292 url=$(git config submodule."$name".url)
295 # Only mention uninitialized submodules when its
296 # path have been specified
298 say "Submodule path '$path' not initialized"
302 if ! test -d "$path"/.git -o -f "$path"/.git
304 module_clone "$path" "$url" || exit
307 subsha1=$(unset GIT_DIR; cd "$path" &&
308 git rev-parse --verify HEAD) ||
309 die "Unable to find current revision in submodule path '$path'"
312 if test "$subsha1" != "$sha1"
314 (unset GIT_DIR; cd "$path" && git-fetch &&
315 git-checkout -q "$sha1") ||
316 die "Unable to checkout '$sha1' in submodule path '$path'"
318 say "Submodule path '$path': checked out '$sha1'"
327 git describe "$2" 2>/dev/null ||
328 git describe --tags "$2" 2>/dev/null ||
329 git describe --contains "$2" 2>/dev/null ||
330 git describe --all --always "$2"
333 test -z "$revname" || revname=" ($revname)"
336 # Show commit summary for submodules in index or working tree
338 # If '--cached' is given, show summary between index and given commit,
339 # or between working tree and given commit
341 # $@ = [commit (default 'HEAD'),] requested paths (default all)
347 # parse $args after "submodule ... summary".
358 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
380 test $summary_limit = 0 && return
382 if rev=$(git rev-parse --verify "$1^0" 2>/dev/null)
391 # Get modified modules cared by user
392 modules=$(git diff-index $cached --raw $head -- "$@" |
393 grep -e '^:160000' -e '^:[0-7]* 160000' |
394 while read mod_src mod_dst sha1_src sha1_dst status name
396 # Always show modules deleted or type-changed (blob<->module)
397 test $status = D -o $status = T && echo "$name" && continue
398 # Also show added or modified modules which are checked out
399 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
404 test -z "$modules" && return
406 git diff-index $cached --raw $head -- $modules |
407 grep -e '^:160000' -e '^:[0-7]* 160000' |
409 while read mod_src mod_dst sha1_src sha1_dst status name
411 if test -z "$cached" &&
412 test $sha1_dst = 0000000000000000000000000000000000000000
416 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
418 100644 | 100755 | 120000)
419 sha1_dst=$(git hash-object $name)
425 echo >&2 "unexpected mode $mod_dst"
432 test $mod_src = 160000 &&
433 ! GIT_DIR="$name/.git" git-rev-parse --verify $sha1_src^0 >/dev/null 2>&1 &&
436 test $mod_dst = 160000 &&
437 ! GIT_DIR="$name/.git" git-rev-parse --verify $sha1_dst^0 >/dev/null 2>&1 &&
441 case "$missing_src,$missing_dst" in
443 errmsg=" Warn: $name doesn't contain commit $sha1_src"
446 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
449 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
454 if test $mod_src = 160000 -a $mod_dst = 160000
456 range="$sha1_src...$sha1_dst"
457 elif test $mod_src = 160000
463 GIT_DIR="$name/.git" \
464 git log --pretty=oneline --first-parent $range | wc -l
466 total_commits=" ($(($total_commits + 0)))"
470 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
471 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
474 if test $mod_dst = 160000
476 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
478 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
481 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
485 # Don't give error msg for modification whose dst is not submodule
486 # i.e. deleted or changed to blob
487 test $mod_dst = 160000 && echo "$errmsg"
489 if test $mod_src = 160000 -a $mod_dst = 160000
492 test $summary_limit -gt 0 && limit="-$summary_limit"
493 GIT_DIR="$name/.git" \
494 git log $limit --pretty='format: %m %s' \
495 --first-parent $sha1_src...$sha1_dst
496 elif test $mod_dst = 160000
498 GIT_DIR="$name/.git" \
499 git log --pretty='format: > %s' -1 $sha1_dst
501 GIT_DIR="$name/.git" \
502 git log --pretty='format: < %s' -1 $sha1_src
508 if test -n "$for_status"; then
509 echo "# Modified submodules:"
511 sed -e 's|^|# |' -e 's|^# $|#|'
517 # List all submodules, prefixed with:
518 # - submodule not initialized
519 # + different revision checked out
521 # If --cached was specified the revision in the index will be printed
522 # instead of the currently checked out revision.
524 # $@ = requested paths (default to all)
528 # parse $args after "submodule ... status".
552 git ls-files --stage -- "$@" | grep '^160000 ' |
553 while read mode sha1 stage path
555 name=$(module_name "$path") || exit
556 url=$(git config submodule."$name".url)
557 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
562 set_name_rev "$path" "$sha1"
563 if git diff-files --quiet -- "$path"
565 say " $sha1 $path$revname"
569 sha1=$(unset GIT_DIR; cd "$path" && git rev-parse --verify HEAD)
570 set_name_rev "$path" "$sha1"
572 say "+$sha1 $path$revname"
577 # This loop parses the command line arguments to find the
578 # subcommand name to dispatch. Parsing of the subcommand specific
579 # options are primarily done by the subcommand implementations.
580 # Subcommand specific options such as --branch and --cached are
581 # parsed here as well, for backward compatibility.
583 while test $# != 0 && test -z "$command"
586 add | init | update | status | summary)
616 # No command word defaults to "status"
617 test -n "$command" || command=status
619 # "-b branch" is accepted only by "add"
620 if test -n "$branch" && test "$command" != add
625 # "--cached" is accepted only by "status" and "summary"
626 if test -n "$cached" && test "$command" != status -a "$command" != summary