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"
131 if test -n "$reference"
133 git-clone $quiet "$reference" -n "$url" "$path"
135 git-clone $quiet -n "$url" "$path"
137 die "$(eval_gettext "Clone of '\$url' into submodule path '\$path' failed")"
141 # Add a new submodule to the working tree, .gitmodules and the index
145 # optional branch is stored in global branch variable
149 # parse $args after "submodule ... add".
154 case "$2" in '') usage ;; esac
165 case "$2" in '') usage ;; esac
166 reference="--reference=$2"
190 if test -z "$path"; then
191 path=$(echo "$repo" |
192 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
195 if test -z "$repo" -o -z "$path"; then
199 # assure repo is absolute or relative to parent
202 # dereference source url relative to parent's url
203 realrepo=$(resolve_relative_url "$repo") || exit
210 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
215 # multiple //; leading ./; /./; /../; trailing /
216 path=$(printf '%s/\n' "$path" |
226 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
227 die "$(eval_gettext "'\$path' already exists in the index")"
229 if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
232 eval_gettext "The following path is ignored by one of your .gitignore files:
234 Use -f if you really want to add it." &&
240 # perhaps the path exists and is already a git repo, else clone it
243 if test -d "$path"/.git -o -f "$path"/.git
245 eval_gettext "Adding existing repo at '\$path' to the index"; echo
247 die "$(eval_gettext "'\$path' already exists and is not a valid git repo")"
252 module_clone "$path" "$realrepo" "$reference" || exit
256 # ash fails to wordsplit ${branch:+-b "$branch"...}
258 '') git checkout -f -q ;;
259 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
261 ) || die "$(eval_gettext "Unable to checkout submodule '\$path'")"
263 git config submodule."$path".url "$realrepo"
265 git add $force "$path" ||
266 die "$(eval_gettext "Failed to add submodule '\$path'")"
268 git config -f .gitmodules submodule."$path".path "$path" &&
269 git config -f .gitmodules submodule."$path".url "$repo" &&
270 git add --force .gitmodules ||
271 die "$(eval_gettext "Failed to register submodule '\$path'")"
275 # Execute an arbitrary command sequence in each checked out
278 # $@ = command to execute
282 # parse $args after "submodule ... foreach".
304 # dup stdin so that it can be restored when running the external
305 # command in the subshell (and a recursive call to this function)
309 while read mode sha1 stage path
311 if test -e "$path"/.git
313 say "$(eval_gettext "Entering '\$prefix\$path'")"
314 name=$(module_name "$path")
316 prefix="$prefix$path/"
320 if test -n "$recursive"
322 cmd_foreach "--recursive" "$@"
325 die "$(eval_gettext "Stopping at '\$path'; script returned non-zero status.")"
331 # Register submodules in .git/config
333 # $@ = requested paths (default to all)
337 # parse $args after "submodule ... init".
359 while read mode sha1 stage path
361 # Skip already registered paths
362 name=$(module_name "$path") || exit
363 if test -z "$(git config "submodule.$name.url")"
365 url=$(git config -f .gitmodules submodule."$name".url)
367 die "$(eval_gettext "No url found for submodule path '\$path' in .gitmodules")"
369 # Possibly a url relative to parent
372 url=$(resolve_relative_url "$url") || exit
375 git config submodule."$name".url "$url" ||
376 die "$(eval_gettext "Failed to register url for submodule path '\$path'")"
379 # Copy "update" setting when it is not set yet
380 upd="$(git config -f .gitmodules submodule."$name".update)"
382 test -n "$(git config submodule."$name".update)" ||
383 git config submodule."$name".update "$upd" ||
384 die "$(eval_gettext "Failed to register update mode for submodule path '\$path'")"
386 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$path'")"
391 # Update each submodule path to correct revision, using clone and checkout as needed
393 # $@ = requested paths (default to all)
397 # parse $args after "submodule ... update".
418 case "$2" in '') usage ;; esac
419 reference="--reference=$2"
420 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
443 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
449 cmd_init "--" "$@" || return
455 while read mode sha1 stage path
459 echo >&2 "Skipping unmerged submodule $path"
462 name=$(module_name "$path") || exit
463 url=$(git config submodule."$name".url)
464 update_module=$(git config submodule."$name".update)
467 # Only mention uninitialized submodules when its
468 # path have been specified
470 say "$(eval_gettext "Submodule path '\$path' not initialized
471 Maybe you want to use 'update --init'?")"
475 if ! test -d "$path"/.git -o -f "$path"/.git
477 module_clone "$path" "$url" "$reference"|| exit
478 cloned_modules="$cloned_modules;$name"
481 subsha1=$(clear_local_git_env; cd "$path" &&
482 git rev-parse --verify HEAD) ||
483 die "$(eval_gettext "Unable to find current revision in submodule path '\$path'")"
486 if ! test -z "$update"
488 update_module=$update
491 if test "$subsha1" != "$sha1"
494 # If we don't already have a -f flag and the submodule has never been checked out
495 if test -z "$subsha1" -a -z "$force"
500 if test -z "$nofetch"
502 # Run fetch only if $sha1 isn't present or it
503 # is not reachable from a ref.
504 (clear_local_git_env; cd "$path" &&
505 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
506 test -z "$rev") || git-fetch)) ||
507 die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
510 # Is this something we just cloned?
511 case ";$cloned_modules;" in
513 # then there is no local change to integrate
518 case "$update_module" in
521 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$path'")"
522 say_msg="$(eval_gettext "Submodule path '\$path': rebased into '\$sha1'")"
523 must_die_on_failure=yes
527 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$path'")"
528 say_msg="$(eval_gettext "Submodule path '\$path': merged in '\$sha1'")"
529 must_die_on_failure=yes
532 command="git checkout $subforce -q"
533 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$path'")"
534 say_msg="$(eval_gettext "Submodule path '\$path': checked out '\$sha1'")"
538 if (clear_local_git_env; cd "$path" && $command "$sha1")
541 elif test -n "$must_die_on_failure"
543 die_with_status 2 "$die_msg"
545 err="${err};$die_msg"
550 if test -n "$recursive"
552 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags")
556 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$path'")"
559 err="${err};$die_msg"
562 die_with_status $res "$die_msg"
589 git describe "$2" 2>/dev/null ||
590 git describe --tags "$2" 2>/dev/null ||
591 git describe --contains "$2" 2>/dev/null ||
592 git describe --all --always "$2"
595 test -z "$revname" || revname=" ($revname)"
598 # Show commit summary for submodules in index or working tree
600 # If '--cached' is given, show summary between index and given commit,
601 # or between working tree and given commit
603 # $@ = [commit (default 'HEAD'),] requested paths (default all)
610 # parse $args after "submodule ... summary".
624 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
646 test $summary_limit = 0 && return
648 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
652 elif test -z "$1" -o "$1" = "HEAD"
654 # before the first commit: compare with an empty tree
655 head=$(git hash-object -w -t tree --stdin </dev/null)
656 test -z "$1" || shift
664 die "$(gettext -- "--cached cannot be used with --files")"
670 # Get modified modules cared by user
671 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
672 sane_egrep '^:([0-7]* )?160000' |
673 while read mod_src mod_dst sha1_src sha1_dst status name
675 # Always show modules deleted or type-changed (blob<->module)
676 test $status = D -o $status = T && echo "$name" && continue
677 # Also show added or modified modules which are checked out
678 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
683 test -z "$modules" && return
685 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
686 sane_egrep '^:([0-7]* )?160000' |
688 while read mod_src mod_dst sha1_src sha1_dst status name
690 if test -z "$cached" &&
691 test $sha1_dst = 0000000000000000000000000000000000000000
695 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
697 100644 | 100755 | 120000)
698 sha1_dst=$(git hash-object $name)
705 eval_gettext "unexpected mode \$mod_dst" &&
714 test $mod_src = 160000 &&
715 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
718 test $mod_dst = 160000 &&
719 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
723 case "$missing_src,$missing_dst" in
725 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_src")"
728 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_dst")"
731 errmsg="$(eval_gettext " Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
736 if test $mod_src = 160000 -a $mod_dst = 160000
738 range="$sha1_src...$sha1_dst"
739 elif test $mod_src = 160000
745 GIT_DIR="$name/.git" \
746 git rev-list --first-parent $range -- | wc -l
748 total_commits=" ($(($total_commits + 0)))"
752 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
753 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
756 blob="$(gettext "blob")"
757 submodule="$(gettext "submodule")"
758 if test $mod_dst = 160000
760 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
762 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
765 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
769 # Don't give error msg for modification whose dst is not submodule
770 # i.e. deleted or changed to blob
771 test $mod_dst = 160000 && echo "$errmsg"
773 if test $mod_src = 160000 -a $mod_dst = 160000
776 test $summary_limit -gt 0 && limit="-$summary_limit"
777 GIT_DIR="$name/.git" \
778 git log $limit --pretty='format: %m %s' \
779 --first-parent $sha1_src...$sha1_dst
780 elif test $mod_dst = 160000
782 GIT_DIR="$name/.git" \
783 git log --pretty='format: > %s' -1 $sha1_dst
785 GIT_DIR="$name/.git" \
786 git log --pretty='format: < %s' -1 $sha1_src
792 if test -n "$for_status"; then
793 if [ -n "$files" ]; then
794 gettext "# Submodules changed but not updated:"; echo
796 gettext "# Submodule changes to be committed:"; echo
799 sed -e 's|^|# |' -e 's|^# $|#|'
805 # List all submodules, prefixed with:
806 # - submodule not initialized
807 # + different revision checked out
809 # If --cached was specified the revision in the index will be printed
810 # instead of the currently checked out revision.
812 # $@ = requested paths (default to all)
816 # parse $args after "submodule ... status".
841 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
846 while read mode sha1 stage path
848 name=$(module_name "$path") || exit
849 url=$(git config submodule."$name".url)
850 displaypath="$prefix$path"
853 say "U$sha1 $displaypath"
856 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
858 say "-$sha1 $displaypath"
861 set_name_rev "$path" "$sha1"
862 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
864 say " $sha1 $displaypath$revname"
868 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
869 set_name_rev "$path" "$sha1"
871 say "+$sha1 $displaypath$revname"
874 if test -n "$recursive"
877 prefix="$displaypath/"
880 eval cmd_status "$orig_args"
882 die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
887 # Sync remote urls for submodules
888 # This makes the value for remote.$remote.url match the value
889 # specified in .gitmodules.
914 while read mode sha1 stage path
916 name=$(module_name "$path")
917 url=$(git config -f .gitmodules --get submodule."$name".url)
919 # Possibly a url relative to parent
922 url=$(resolve_relative_url "$url") || exit
926 if git config "submodule.$name.url" >/dev/null 2>/dev/null
928 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
929 git config submodule."$name".url "$url"
931 if test -e "$path"/.git
936 remote=$(get_default_remote)
937 git config remote."$remote".url "$url"
944 # This loop parses the command line arguments to find the
945 # subcommand name to dispatch. Parsing of the subcommand specific
946 # options are primarily done by the subcommand implementations.
947 # Subcommand specific options such as --branch and --cached are
948 # parsed here as well, for backward compatibility.
950 while test $# != 0 && test -z "$command"
953 add | foreach | init | update | status | summary | sync)
983 # No command word defaults to "status"
984 test -n "$command" || command=status
986 # "-b branch" is accepted only by "add"
987 if test -n "$branch" && test "$command" != add
992 # "--cached" is accepted only by "status" and "summary"
993 if test -n "$cached" && test "$command" != status -a "$command" != summary