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] [--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>...]"
32 # Resolve relative url by appending to parent's url
33 resolve_relative_url ()
35 remote=$(get_default_remote)
36 remoteurl=$(git config "remote.$remote.url") ||
37 die "remote ($remote) does not have a url defined in .git/config"
39 remoteurl=${remoteurl%/}
48 remoteurl="${remoteurl%/*}"
51 remoteurl="${remoteurl%:*}"
55 die "cannot strip one component off url '$remoteurl'"
66 echo "$remoteurl$sep${url%/}"
70 # Get submodule info for registered submodules
71 # $@ = path to limit submodule list
75 git ls-files --error-unmatch --stage -- "$@" | sane_grep '^160000 '
79 # Map submodule path to submodule name
85 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
86 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
87 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
88 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
90 die "No submodule mapping found in .gitmodules for path '$path'"
97 # Prior to calling, cmd_update checks that a possibly existing
98 # path is not a git repository.
99 # Likewise, cmd_add checks that path does not exist at all,
100 # since it is the location of a new submodule.
108 if test -n "$reference"
110 git-clone "$reference" -n "$url" "$path"
112 git-clone -n "$url" "$path"
114 die "Clone of '$url' into submodule path '$path' failed"
118 # Add a new submodule to the working tree, .gitmodules and the index
122 # optional branch is stored in global branch variable
126 # parse $args after "submodule ... add".
131 case "$2" in '') usage ;; esac
142 case "$2" in '') usage ;; esac
143 reference="--reference=$2"
167 if test -z "$path"; then
168 path=$(echo "$repo" |
169 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
172 if test -z "$repo" -o -z "$path"; then
176 # assure repo is absolute or relative to parent
179 # dereference source url relative to parent's url
180 realrepo=$(resolve_relative_url "$repo") || exit
187 die "repo URL: '$repo' must be absolute or begin with ./|../"
192 # multiple //; leading ./; /./; /../; trailing /
193 path=$(printf '%s/\n' "$path" |
203 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
204 die "'$path' already exists in the index"
206 if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
208 echo >&2 "The following path is ignored by one of your .gitignore files:" &&
210 echo >&2 "Use -f if you really want to add it."
214 # perhaps the path exists and is already a git repo, else clone it
217 if test -d "$path"/.git -o -f "$path"/.git
219 echo "Adding existing repo at '$path' to the index"
221 die "'$path' already exists and is not a valid git repo"
226 url=$(resolve_relative_url "$repo") || exit
232 git config submodule."$path".url "$url"
235 module_clone "$path" "$realrepo" "$reference" || exit
239 # ash fails to wordsplit ${branch:+-b "$branch"...}
241 '') git checkout -f -q ;;
242 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
244 ) || die "Unable to checkout submodule '$path'"
247 git add $force "$path" ||
248 die "Failed to add submodule '$path'"
250 git config -f .gitmodules submodule."$path".path "$path" &&
251 git config -f .gitmodules submodule."$path".url "$repo" &&
252 git add --force .gitmodules ||
253 die "Failed to register submodule '$path'"
257 # Execute an arbitrary command sequence in each checked out
260 # $@ = command to execute
264 # 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".
392 case "$2" in '') usage ;; esac
393 reference="--reference=$2"
394 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
417 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
423 cmd_init "--" "$@" || return
427 while read mode sha1 stage path
429 name=$(module_name "$path") || exit
430 url=$(git config submodule."$name".url)
431 update_module=$(git config submodule."$name".update)
434 # Only mention uninitialized submodules when its
435 # path have been specified
437 say "Submodule path '$path' not initialized" &&
438 say "Maybe you want to use 'update --init'?"
442 if ! test -d "$path"/.git -o -f "$path"/.git
444 module_clone "$path" "$url" "$reference"|| exit
447 subsha1=$(clear_local_git_env; cd "$path" &&
448 git rev-parse --verify HEAD) ||
449 die "Unable to find current revision in submodule path '$path'"
452 if ! test -z "$update"
454 update_module=$update
457 if test "$subsha1" != "$sha1"
460 if test -z "$subsha1"
465 if test -z "$nofetch"
467 (clear_local_git_env; cd "$path" &&
469 die "Unable to fetch in submodule path '$path'"
472 case "$update_module" in
484 command="git checkout $force -q"
490 (clear_local_git_env; cd "$path" && $command "$sha1") ||
491 die "Unable to $action '$sha1' in submodule path '$path'"
492 say "Submodule path '$path': $msg '$sha1'"
495 if test -n "$recursive"
497 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") ||
498 die "Failed to recurse into submodule path '$path'"
507 git describe "$2" 2>/dev/null ||
508 git describe --tags "$2" 2>/dev/null ||
509 git describe --contains "$2" 2>/dev/null ||
510 git describe --all --always "$2"
513 test -z "$revname" || revname=" ($revname)"
516 # Show commit summary for submodules in index or working tree
518 # If '--cached' is given, show summary between index and given commit,
519 # or between working tree and given commit
521 # $@ = [commit (default 'HEAD'),] requested paths (default all)
528 # parse $args after "submodule ... summary".
542 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
564 test $summary_limit = 0 && return
566 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
570 elif test -z "$1" -o "$1" = "HEAD"
572 # before the first commit: compare with an empty tree
573 head=$(git hash-object -w -t tree --stdin </dev/null)
574 test -z "$1" || shift
582 die "--cached cannot be used with --files"
588 # Get modified modules cared by user
589 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
590 sane_egrep '^:([0-7]* )?160000' |
591 while read mod_src mod_dst sha1_src sha1_dst status name
593 # Always show modules deleted or type-changed (blob<->module)
594 test $status = D -o $status = T && echo "$name" && continue
595 # Also show added or modified modules which are checked out
596 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
601 test -z "$modules" && return
603 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
604 sane_egrep '^:([0-7]* )?160000' |
606 while read mod_src mod_dst sha1_src sha1_dst status name
608 if test -z "$cached" &&
609 test $sha1_dst = 0000000000000000000000000000000000000000
613 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
615 100644 | 100755 | 120000)
616 sha1_dst=$(git hash-object $name)
622 echo >&2 "unexpected mode $mod_dst"
629 test $mod_src = 160000 &&
630 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
633 test $mod_dst = 160000 &&
634 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
638 case "$missing_src,$missing_dst" in
640 errmsg=" Warn: $name doesn't contain commit $sha1_src"
643 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
646 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
651 if test $mod_src = 160000 -a $mod_dst = 160000
653 range="$sha1_src...$sha1_dst"
654 elif test $mod_src = 160000
660 GIT_DIR="$name/.git" \
661 git rev-list --first-parent $range -- | wc -l
663 total_commits=" ($(($total_commits + 0)))"
667 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
668 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
671 if test $mod_dst = 160000
673 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
675 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
678 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
682 # Don't give error msg for modification whose dst is not submodule
683 # i.e. deleted or changed to blob
684 test $mod_dst = 160000 && echo "$errmsg"
686 if test $mod_src = 160000 -a $mod_dst = 160000
689 test $summary_limit -gt 0 && limit="-$summary_limit"
690 GIT_DIR="$name/.git" \
691 git log $limit --pretty='format: %m %s' \
692 --first-parent $sha1_src...$sha1_dst
693 elif test $mod_dst = 160000
695 GIT_DIR="$name/.git" \
696 git log --pretty='format: > %s' -1 $sha1_dst
698 GIT_DIR="$name/.git" \
699 git log --pretty='format: < %s' -1 $sha1_src
705 if test -n "$for_status"; then
706 if [ -n "$files" ]; then
707 echo "# Submodules changed but not updated:"
709 echo "# Submodule changes to be committed:"
712 sed -e 's|^|# |' -e 's|^# $|#|'
718 # List all submodules, prefixed with:
719 # - submodule not initialized
720 # + different revision checked out
722 # If --cached was specified the revision in the index will be printed
723 # instead of the currently checked out revision.
725 # $@ = requested paths (default to all)
729 # parse $args after "submodule ... status".
754 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
759 while read mode sha1 stage path
761 name=$(module_name "$path") || exit
762 url=$(git config submodule."$name".url)
763 displaypath="$prefix$path"
764 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
766 say "-$sha1 $displaypath"
769 set_name_rev "$path" "$sha1"
770 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
772 say " $sha1 $displaypath$revname"
776 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
777 set_name_rev "$path" "$sha1"
779 say "+$sha1 $displaypath$revname"
782 if test -n "$recursive"
785 prefix="$displaypath/"
788 eval cmd_status "$orig_args"
790 die "Failed to recurse into submodule path '$path'"
795 # Sync remote urls for submodules
796 # This makes the value for remote.$remote.url match the value
797 # specified in .gitmodules.
822 while read mode sha1 stage path
824 name=$(module_name "$path")
825 url=$(git config -f .gitmodules --get submodule."$name".url)
827 # Possibly a url relative to parent
830 url=$(resolve_relative_url "$url") || exit
834 say "Synchronizing submodule url for '$name'"
835 git config submodule."$name".url "$url"
837 if test -e "$path"/.git
842 remote=$(get_default_remote)
843 git config remote."$remote".url "$url"
849 # This loop parses the command line arguments to find the
850 # subcommand name to dispatch. Parsing of the subcommand specific
851 # options are primarily done by the subcommand implementations.
852 # Subcommand specific options such as --branch and --cached are
853 # parsed here as well, for backward compatibility.
855 while test $# != 0 && test -z "$command"
858 add | foreach | init | update | status | summary | sync)
888 # No command word defaults to "status"
889 test -n "$command" || command=status
891 # "-b branch" is accepted only by "add"
892 if test -n "$branch" && test "$command" != add
897 # "--cached" is accepted only by "status" and "summary"
898 if test -n "$cached" && test "$command" != status -a "$command" != summary