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 "$reference"
128 git-clone "$reference" -n "$url" "$path"
130 git-clone -n "$url" "$path"
132 die "$(eval_gettext "Clone of '\$url' into submodule path '\$path' failed")"
136 # Add a new submodule to the working tree, .gitmodules and the index
140 # optional branch is stored in global branch variable
144 # parse $args after "submodule ... add".
149 case "$2" in '') usage ;; esac
160 case "$2" in '') usage ;; esac
161 reference="--reference=$2"
185 if test -z "$path"; then
186 path=$(echo "$repo" |
187 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
190 if test -z "$repo" -o -z "$path"; then
194 # assure repo is absolute or relative to parent
197 # dereference source url relative to parent's url
198 realrepo=$(resolve_relative_url "$repo") || exit
205 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
210 # multiple //; leading ./; /./; /../; trailing /
211 path=$(printf '%s/\n' "$path" |
221 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
222 die "$(eval_gettext "'\$path' already exists in the index")"
224 if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
227 eval_gettext "The following path is ignored by one of your .gitignore files:
229 Use -f if you really want to add it." &&
235 # perhaps the path exists and is already a git repo, else clone it
238 if test -d "$path"/.git -o -f "$path"/.git
240 eval_gettext "Adding existing repo at '\$path' to the index"; echo
242 die "$(eval_gettext "'\$path' already exists and is not a valid git repo")"
247 module_clone "$path" "$realrepo" "$reference" || exit
251 # ash fails to wordsplit ${branch:+-b "$branch"...}
253 '') git checkout -f -q ;;
254 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
256 ) || die "$(eval_gettext "Unable to checkout submodule '\$path'")"
258 git config submodule."$path".url "$realrepo"
260 git add $force "$path" ||
261 die "$(eval_gettext "Failed to add submodule '\$path'")"
263 git config -f .gitmodules submodule."$path".path "$path" &&
264 git config -f .gitmodules submodule."$path".url "$repo" &&
265 git add --force .gitmodules ||
266 die "$(eval_gettext "Failed to register submodule '\$path'")"
270 # Execute an arbitrary command sequence in each checked out
273 # $@ = command to execute
277 # parse $args after "submodule ... foreach".
299 # dup stdin so that it can be restored when running the external
300 # command in the subshell (and a recursive call to this function)
304 while read mode sha1 stage path
306 if test -e "$path"/.git
308 say "$(eval_gettext "Entering '\$prefix\$path'")"
309 name=$(module_name "$path")
311 prefix="$prefix$path/"
315 if test -n "$recursive"
317 cmd_foreach "--recursive" "$@"
320 die "$(eval_gettext "Stopping at '\$path'; script returned non-zero status.")"
326 # Register submodules in .git/config
328 # $@ = requested paths (default to all)
332 # parse $args after "submodule ... init".
354 while read mode sha1 stage path
356 # Skip already registered paths
357 name=$(module_name "$path") || exit
358 if test -z "$(git config "submodule.$name.url")"
360 url=$(git config -f .gitmodules submodule."$name".url)
362 die "$(eval_gettext "No url found for submodule path '\$path' in .gitmodules")"
364 # Possibly a url relative to parent
367 url=$(resolve_relative_url "$url") || exit
370 git config submodule."$name".url "$url" ||
371 die "$(eval_gettext "Failed to register url for submodule path '\$path'")"
374 # Copy "update" setting when it is not set yet
375 upd="$(git config -f .gitmodules submodule."$name".update)"
377 test -n "$(git config submodule."$name".update)" ||
378 git config submodule."$name".update "$upd" ||
379 die "$(eval_gettext "Failed to register update mode for submodule path '\$path'")"
381 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$path'")"
386 # Update each submodule path to correct revision, using clone and checkout as needed
388 # $@ = requested paths (default to all)
392 # parse $args after "submodule ... update".
413 case "$2" in '') usage ;; esac
414 reference="--reference=$2"
415 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
438 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
444 cmd_init "--" "$@" || return
450 while read mode sha1 stage path
454 echo >&2 "Skipping unmerged submodule $path"
457 name=$(module_name "$path") || exit
458 url=$(git config submodule."$name".url)
459 update_module=$(git config submodule."$name".update)
462 # Only mention uninitialized submodules when its
463 # path have been specified
465 say "$(eval_gettext "Submodule path '\$path' not initialized
466 Maybe you want to use 'update --init'?")"
470 if ! test -d "$path"/.git -o -f "$path"/.git
472 module_clone "$path" "$url" "$reference"|| exit
473 cloned_modules="$cloned_modules;$name"
476 subsha1=$(clear_local_git_env; cd "$path" &&
477 git rev-parse --verify HEAD) ||
478 die "$(eval_gettext "Unable to find current revision in submodule path '\$path'")"
481 if ! test -z "$update"
483 update_module=$update
486 if test "$subsha1" != "$sha1"
489 # If we don't already have a -f flag and the submodule has never been checked out
490 if test -z "$subsha1" -a -z "$force"
495 if test -z "$nofetch"
497 # Run fetch only if $sha1 isn't present or it
498 # is not reachable from a ref.
499 (clear_local_git_env; cd "$path" &&
500 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
501 test -z "$rev") || git-fetch)) ||
502 die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
505 # Is this something we just cloned?
506 case ";$cloned_modules;" in
508 # then there is no local change to integrate
513 case "$update_module" in
516 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$path'")"
517 say_msg="$(eval_gettext "Submodule path '\$path': rebased into '\$sha1'")"
518 must_die_on_failure=yes
522 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$path'")"
523 say_msg="$(eval_gettext "Submodule path '\$path': merged in '\$sha1'")"
524 must_die_on_failure=yes
527 command="git checkout $subforce -q"
528 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$path'")"
529 say_msg="$(eval_gettext "Submodule path '\$path': checked out '\$sha1'")"
533 if (clear_local_git_env; cd "$path" && $command "$sha1")
536 elif test -n "$must_die_on_failure"
538 die_with_status 2 "$die_msg"
540 err="${err};$die_msg"
545 if test -n "$recursive"
547 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags")
551 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$path'")"
554 err="${err};$die_msg"
557 die_with_status $res "$die_msg"
584 git describe "$2" 2>/dev/null ||
585 git describe --tags "$2" 2>/dev/null ||
586 git describe --contains "$2" 2>/dev/null ||
587 git describe --all --always "$2"
590 test -z "$revname" || revname=" ($revname)"
593 # Show commit summary for submodules in index or working tree
595 # If '--cached' is given, show summary between index and given commit,
596 # or between working tree and given commit
598 # $@ = [commit (default 'HEAD'),] requested paths (default all)
605 # parse $args after "submodule ... summary".
619 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
641 test $summary_limit = 0 && return
643 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
647 elif test -z "$1" -o "$1" = "HEAD"
649 # before the first commit: compare with an empty tree
650 head=$(git hash-object -w -t tree --stdin </dev/null)
651 test -z "$1" || shift
659 die "$(gettext -- "--cached cannot be used with --files")"
665 # Get modified modules cared by user
666 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
667 sane_egrep '^:([0-7]* )?160000' |
668 while read mod_src mod_dst sha1_src sha1_dst status name
670 # Always show modules deleted or type-changed (blob<->module)
671 test $status = D -o $status = T && echo "$name" && continue
672 # Also show added or modified modules which are checked out
673 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
678 test -z "$modules" && return
680 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
681 sane_egrep '^:([0-7]* )?160000' |
683 while read mod_src mod_dst sha1_src sha1_dst status name
685 if test -z "$cached" &&
686 test $sha1_dst = 0000000000000000000000000000000000000000
690 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
692 100644 | 100755 | 120000)
693 sha1_dst=$(git hash-object $name)
700 eval_gettext "unexpected mode \$mod_dst" &&
709 test $mod_src = 160000 &&
710 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
713 test $mod_dst = 160000 &&
714 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
718 case "$missing_src,$missing_dst" in
720 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_src")"
723 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_dst")"
726 errmsg="$(eval_gettext " Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
731 if test $mod_src = 160000 -a $mod_dst = 160000
733 range="$sha1_src...$sha1_dst"
734 elif test $mod_src = 160000
740 GIT_DIR="$name/.git" \
741 git rev-list --first-parent $range -- | wc -l
743 total_commits=" ($(($total_commits + 0)))"
747 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
748 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
751 blob="$(gettext "blob")"
752 submodule="$(gettext "submodule")"
753 if test $mod_dst = 160000
755 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
757 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
760 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
764 # Don't give error msg for modification whose dst is not submodule
765 # i.e. deleted or changed to blob
766 test $mod_dst = 160000 && echo "$errmsg"
768 if test $mod_src = 160000 -a $mod_dst = 160000
771 test $summary_limit -gt 0 && limit="-$summary_limit"
772 GIT_DIR="$name/.git" \
773 git log $limit --pretty='format: %m %s' \
774 --first-parent $sha1_src...$sha1_dst
775 elif test $mod_dst = 160000
777 GIT_DIR="$name/.git" \
778 git log --pretty='format: > %s' -1 $sha1_dst
780 GIT_DIR="$name/.git" \
781 git log --pretty='format: < %s' -1 $sha1_src
787 if test -n "$for_status"; then
788 if [ -n "$files" ]; then
789 gettext "# Submodules changed but not updated:"; echo
791 gettext "# Submodule changes to be committed:"; echo
794 sed -e 's|^|# |' -e 's|^# $|#|'
800 # List all submodules, prefixed with:
801 # - submodule not initialized
802 # + different revision checked out
804 # If --cached was specified the revision in the index will be printed
805 # instead of the currently checked out revision.
807 # $@ = requested paths (default to all)
811 # parse $args after "submodule ... status".
836 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
841 while read mode sha1 stage path
843 name=$(module_name "$path") || exit
844 url=$(git config submodule."$name".url)
845 displaypath="$prefix$path"
848 say "U$sha1 $displaypath"
851 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
853 say "-$sha1 $displaypath"
856 set_name_rev "$path" "$sha1"
857 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
859 say " $sha1 $displaypath$revname"
863 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
864 set_name_rev "$path" "$sha1"
866 say "+$sha1 $displaypath$revname"
869 if test -n "$recursive"
872 prefix="$displaypath/"
875 eval cmd_status "$orig_args"
877 die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
882 # Sync remote urls for submodules
883 # This makes the value for remote.$remote.url match the value
884 # specified in .gitmodules.
909 while read mode sha1 stage path
911 name=$(module_name "$path")
912 url=$(git config -f .gitmodules --get submodule."$name".url)
914 # Possibly a url relative to parent
917 url=$(resolve_relative_url "$url") || exit
921 if git config "submodule.$name.url" >/dev/null 2>/dev/null
923 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
924 git config submodule."$name".url "$url"
926 if test -e "$path"/.git
931 remote=$(get_default_remote)
932 git config remote."$remote".url "$url"
939 # This loop parses the command line arguments to find the
940 # subcommand name to dispatch. Parsing of the subcommand specific
941 # options are primarily done by the subcommand implementations.
942 # Subcommand specific options such as --branch and --cached are
943 # parsed here as well, for backward compatibility.
945 while test $# != 0 && test -z "$command"
948 add | foreach | init | update | status | summary | sync)
978 # No command word defaults to "status"
979 test -n "$command" || command=status
981 # "-b branch" is accepted only by "add"
982 if test -n "$branch" && test "$command" != add
987 # "--cached" is accepted only by "status" and "summary"
988 if test -n "$cached" && test "$command" != status -a "$command" != summary