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] [--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] [--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>...]"
31 # Resolve relative url by appending to parent's url
32 resolve_relative_url ()
34 remote=$(get_default_remote)
35 remoteurl=$(git config "remote.$remote.url") ||
36 die "remote ($remote) does not have a url defined in .git/config"
38 remoteurl=${remoteurl%/}
47 remoteurl="${remoteurl%/*}"
50 remoteurl="${remoteurl%:*}"
54 die "cannot strip one component off url '$remoteurl'"
65 echo "$remoteurl$sep${url%/}"
69 # Get submodule info for registered submodules
70 # $@ = path to limit submodule list
74 git ls-files --error-unmatch --stage -- "$@" | sane_grep '^160000 '
78 # Map submodule path to submodule name
84 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
85 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
86 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
87 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
89 die "No submodule mapping found in .gitmodules for path '$path'"
96 # Prior to calling, cmd_update checks that a possibly existing
97 # path is not a git repository.
98 # Likewise, cmd_add checks that path does not exist at all,
99 # since it is the location of a new submodule.
107 # If there already is a directory at the submodule path,
108 # expect it to be empty (since that is the default checkout
109 # action) and try to remove it.
110 # Note: if $path is a symlink to a directory the test will
111 # succeed but the rmdir will fail. We might want to fix this.
114 rmdir "$path" 2>/dev/null ||
115 die "Directory '$path' exists, but is neither empty nor a git repository"
119 die "A file already exist at path '$path'"
121 if test -n "$reference"
123 git-clone "$reference" -n "$url" "$path"
125 git-clone -n "$url" "$path"
127 die "Clone of '$url' into submodule path '$path' failed"
131 # Add a new submodule to the working tree, .gitmodules and the index
135 # optional branch is stored in global branch variable
139 # parse $args after "submodule ... add".
144 case "$2" in '') usage ;; esac
152 case "$2" in '') usage ;; esac
153 reference="--reference=$2"
177 if test -z "$path"; then
178 path=$(echo "$repo" |
179 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
182 if test -z "$repo" -o -z "$path"; then
186 # assure repo is absolute or relative to parent
189 # dereference source url relative to parent's url
190 realrepo=$(resolve_relative_url "$repo") || exit
197 die "repo URL: '$repo' must be absolute or begin with ./|../"
202 # multiple //; leading ./; /./; /../; trailing /
203 path=$(printf '%s/\n' "$path" |
213 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
214 die "'$path' already exists in the index"
216 # perhaps the path exists and is already a git repo, else clone it
219 if test -d "$path"/.git -o -f "$path"/.git
221 echo "Adding existing repo at '$path' to the index"
223 die "'$path' already exists and is not a valid git repo"
228 url=$(resolve_relative_url "$repo") || exit
234 git config submodule."$path".url "$url"
237 module_clone "$path" "$realrepo" "$reference" || exit
241 # ash fails to wordsplit ${branch:+-b "$branch"...}
243 '') git checkout -f -q ;;
244 ?*) git checkout -f -q -b "$branch" "origin/$branch" ;;
246 ) || die "Unable to checkout submodule '$path'"
250 die "Failed to add submodule '$path'"
252 git config -f .gitmodules submodule."$path".path "$path" &&
253 git config -f .gitmodules submodule."$path".url "$repo" &&
254 git add .gitmodules ||
255 die "Failed to register submodule '$path'"
259 # Execute an arbitrary command sequence in each checked out
262 # $@ = command to execute
266 # parse $args after "submodule ... foreach".
287 while read mode sha1 stage path
289 if test -e "$path"/.git
291 say "Entering '$prefix$path'"
292 name=$(module_name "$path")
294 prefix="$prefix$path/"
298 if test -n "$recursive"
300 cmd_foreach "--recursive" "$@"
303 die "Stopping at '$path'; script returned non-zero status."
309 # Register submodules in .git/config
311 # $@ = requested paths (default to all)
315 # parse $args after "submodule ... init".
337 while read mode sha1 stage path
339 # Skip already registered paths
340 name=$(module_name "$path") || exit
341 url=$(git config submodule."$name".url)
342 test -z "$url" || continue
344 url=$(git config -f .gitmodules submodule."$name".url)
346 die "No url found for submodule path '$path' in .gitmodules"
348 # Possibly a url relative to parent
351 url=$(resolve_relative_url "$url") || exit
355 git config submodule."$name".url "$url" ||
356 die "Failed to register url for submodule path '$path'"
358 upd="$(git config -f .gitmodules submodule."$name".update)"
360 git config submodule."$name".update "$upd" ||
361 die "Failed to register update mode for submodule path '$path'"
363 say "Submodule '$name' ($url) registered for path '$path'"
368 # Update each submodule path to correct revision, using clone and checkout as needed
370 # $@ = requested paths (default to all)
374 # parse $args after "submodule ... update".
396 case "$2" in '') usage ;; esac
397 reference="--reference=$2"
427 cmd_init "--" "$@" || return
431 while read mode sha1 stage path
433 name=$(module_name "$path") || exit
434 url=$(git config submodule."$name".url)
435 update_module=$(git config submodule."$name".update)
438 # Only mention uninitialized submodules when its
439 # path have been specified
441 say "Submodule path '$path' not initialized" &&
442 say "Maybe you want to use 'update --init'?"
446 if ! test -d "$path"/.git -o -f "$path"/.git
448 module_clone "$path" "$url" "$reference"|| exit
451 subsha1=$(clear_local_git_env; cd "$path" &&
452 git rev-parse --verify HEAD) ||
453 die "Unable to find current revision in submodule path '$path'"
456 if ! test -z "$update"
458 update_module=$update
461 if test "$subsha1" != "$sha1"
464 if test -z "$subsha1"
469 if test -z "$nofetch"
471 (clear_local_git_env; cd "$path" &&
473 die "Unable to fetch in submodule path '$path'"
476 case "$update_module" in
488 command="git checkout $force -q"
494 (clear_local_git_env; cd "$path" && $command "$sha1") ||
495 die "Unable to $action '$sha1' in submodule path '$path'"
496 say "Submodule path '$path': $msg '$sha1'"
499 if test -n "$recursive"
501 (clear_local_git_env; cd "$path" && cmd_update $orig_args) ||
502 die "Failed to recurse into submodule path '$path'"
511 git describe "$2" 2>/dev/null ||
512 git describe --tags "$2" 2>/dev/null ||
513 git describe --contains "$2" 2>/dev/null ||
514 git describe --all --always "$2"
517 test -z "$revname" || revname=" ($revname)"
520 # Show commit summary for submodules in index or working tree
522 # If '--cached' is given, show summary between index and given commit,
523 # or between working tree and given commit
525 # $@ = [commit (default 'HEAD'),] requested paths (default all)
532 # parse $args after "submodule ... summary".
546 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
568 test $summary_limit = 0 && return
570 if rev=$(git rev-parse -q --verify "$1^0")
581 die "--cached cannot be used with --files"
587 # Get modified modules cared by user
588 modules=$(git $diff_cmd $cached --raw $head -- "$@" |
589 sane_egrep '^:([0-7]* )?160000' |
590 while read mod_src mod_dst sha1_src sha1_dst status name
592 # Always show modules deleted or type-changed (blob<->module)
593 test $status = D -o $status = T && echo "$name" && continue
594 # Also show added or modified modules which are checked out
595 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
600 test -z "$modules" && return
602 git $diff_cmd $cached --raw $head -- $modules |
603 sane_egrep '^:([0-7]* )?160000' |
605 while read mod_src mod_dst sha1_src sha1_dst status name
607 if test -z "$cached" &&
608 test $sha1_dst = 0000000000000000000000000000000000000000
612 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
614 100644 | 100755 | 120000)
615 sha1_dst=$(git hash-object $name)
621 echo >&2 "unexpected mode $mod_dst"
628 test $mod_src = 160000 &&
629 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
632 test $mod_dst = 160000 &&
633 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
637 case "$missing_src,$missing_dst" in
639 errmsg=" Warn: $name doesn't contain commit $sha1_src"
642 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
645 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
650 if test $mod_src = 160000 -a $mod_dst = 160000
652 range="$sha1_src...$sha1_dst"
653 elif test $mod_src = 160000
659 GIT_DIR="$name/.git" \
660 git log --pretty=oneline --first-parent $range | wc -l
662 total_commits=" ($(($total_commits + 0)))"
666 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
667 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
670 if test $mod_dst = 160000
672 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
674 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
677 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
681 # Don't give error msg for modification whose dst is not submodule
682 # i.e. deleted or changed to blob
683 test $mod_dst = 160000 && echo "$errmsg"
685 if test $mod_src = 160000 -a $mod_dst = 160000
688 test $summary_limit -gt 0 && limit="-$summary_limit"
689 GIT_DIR="$name/.git" \
690 git log $limit --pretty='format: %m %s' \
691 --first-parent $sha1_src...$sha1_dst
692 elif test $mod_dst = 160000
694 GIT_DIR="$name/.git" \
695 git log --pretty='format: > %s' -1 $sha1_dst
697 GIT_DIR="$name/.git" \
698 git log --pretty='format: < %s' -1 $sha1_src
704 if test -n "$for_status"; then
705 if [ -n "$files" ]; then
706 echo "# Submodules changed but not updated:"
708 echo "# Submodule changes to be committed:"
711 sed -e 's|^|# |' -e 's|^# $|#|'
717 # List all submodules, prefixed with:
718 # - submodule not initialized
719 # + different revision checked out
721 # If --cached was specified the revision in the index will be printed
722 # instead of the currently checked out revision.
724 # $@ = requested paths (default to all)
728 # parse $args after "submodule ... status".
757 while read mode sha1 stage path
759 name=$(module_name "$path") || exit
760 url=$(git config submodule."$name".url)
761 displaypath="$prefix$path"
762 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
764 say "-$sha1 $displaypath"
767 set_name_rev "$path" "$sha1"
768 if git diff-files --quiet -- "$path"
770 say " $sha1 $displaypath$revname"
774 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
775 set_name_rev "$path" "$sha1"
777 say "+$sha1 $displaypath$revname"
780 if test -n "$recursive"
783 prefix="$displaypath/"
786 cmd_status $orig_args
788 die "Failed to recurse into submodule path '$path'"
793 # Sync remote urls for submodules
794 # This makes the value for remote.$remote.url match the value
795 # specified in .gitmodules.
820 while read mode sha1 stage path
822 name=$(module_name "$path")
823 url=$(git config -f .gitmodules --get submodule."$name".url)
825 # Possibly a url relative to parent
828 url=$(resolve_relative_url "$url") || exit
832 if test -e "$path"/.git
837 remote=$(get_default_remote)
838 say "Synchronizing submodule url for '$name'"
839 git config remote."$remote".url "$url"
845 # This loop parses the command line arguments to find the
846 # subcommand name to dispatch. Parsing of the subcommand specific
847 # options are primarily done by the subcommand implementations.
848 # Subcommand specific options such as --branch and --cached are
849 # parsed here as well, for backward compatibility.
851 while test $# != 0 && test -z "$command"
854 add | foreach | init | update | status | summary | sync)
884 # No command word defaults to "status"
885 test -n "$command" || command=status
887 # "-b branch" is accepted only by "add"
888 if test -n "$branch" && test "$command" != add
893 # "--cached" is accepted only by "status" and "summary"
894 if test -n "$cached" && test "$command" != status -a "$command" != summary