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>...]"
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 -- "$@" |
78 my ($null_sha1) = ("0" x 40);
81 my ($mode, $sha1, $stage, $path) =
82 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
83 next unless $mode eq "160000";
85 if (!$unmerged{$path}++) {
86 print "$mode $null_sha1 U\t$path\n";
96 # Map submodule path to submodule name
102 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
103 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
104 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
105 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
107 die "No submodule mapping found in .gitmodules for path '$path'"
114 # Prior to calling, cmd_update checks that a possibly existing
115 # path is not a git repository.
116 # Likewise, cmd_add checks that path does not exist at all,
117 # since it is the location of a new submodule.
125 if test -n "$reference"
127 git-clone "$reference" -n "$url" "$path"
129 git-clone -n "$url" "$path"
131 die "Clone of '$url' into submodule path '$path' failed"
135 # Add a new submodule to the working tree, .gitmodules and the index
139 # optional branch is stored in global branch variable
143 # parse $args after "submodule ... add".
148 case "$2" in '') usage ;; esac
159 case "$2" in '') usage ;; esac
160 reference="--reference=$2"
184 if test -z "$path"; then
185 path=$(echo "$repo" |
186 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
189 if test -z "$repo" -o -z "$path"; then
193 # assure repo is absolute or relative to parent
196 # dereference source url relative to parent's url
197 realrepo=$(resolve_relative_url "$repo") || exit
204 die "repo URL: '$repo' must be absolute or begin with ./|../"
209 # multiple //; leading ./; /./; /../; trailing /
210 path=$(printf '%s/\n' "$path" |
220 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
221 die "'$path' already exists in the index"
223 if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
225 echo >&2 "The following path is ignored by one of your .gitignore files:" &&
227 echo >&2 "Use -f if you really want to add it."
231 # perhaps the path exists and is already a git repo, else clone it
234 if test -d "$path"/.git -o -f "$path"/.git
236 echo "Adding existing repo at '$path' to the index"
238 die "'$path' already exists and is not a valid git repo"
243 url=$(resolve_relative_url "$repo") || exit
249 git config submodule."$path".url "$url"
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 "Unable to checkout submodule '$path'"
264 git add $force "$path" ||
265 die "Failed to add submodule '$path'"
267 git config -f .gitmodules submodule."$path".path "$path" &&
268 git config -f .gitmodules submodule."$path".url "$repo" &&
269 git add --force .gitmodules ||
270 die "Failed to register submodule '$path'"
274 # Execute an arbitrary command sequence in each checked out
277 # $@ = command to execute
281 # parse $args after "submodule ... foreach".
303 # dup stdin so that it can be restored when running the external
304 # command in the subshell (and a recursive call to this function)
308 while read mode sha1 stage path
310 if test -e "$path"/.git
312 say "Entering '$prefix$path'"
313 name=$(module_name "$path")
315 prefix="$prefix$path/"
319 if test -n "$recursive"
321 cmd_foreach "--recursive" "$@"
324 die "Stopping at '$path'; script returned non-zero status."
330 # Register submodules in .git/config
332 # $@ = requested paths (default to all)
336 # parse $args after "submodule ... init".
358 while read mode sha1 stage path
360 # Skip already registered paths
361 name=$(module_name "$path") || exit
362 url=$(git config submodule."$name".url)
363 test -z "$url" || continue
365 url=$(git config -f .gitmodules submodule."$name".url)
367 die "No url found for submodule path '$path' in .gitmodules"
369 # Possibly a url relative to parent
372 url=$(resolve_relative_url "$url") || exit
376 git config submodule."$name".url "$url" ||
377 die "Failed to register url for submodule path '$path'"
379 upd="$(git config -f .gitmodules submodule."$name".update)"
381 git config submodule."$name".update "$upd" ||
382 die "Failed to register update mode for submodule path '$path'"
384 say "Submodule '$name' ($url) registered for path '$path'"
389 # Update each submodule path to correct revision, using clone and checkout as needed
391 # $@ = requested paths (default to all)
395 # parse $args after "submodule ... update".
416 case "$2" in '') usage ;; esac
417 reference="--reference=$2"
418 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
441 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
447 cmd_init "--" "$@" || return
452 while read mode sha1 stage path
456 echo >&2 "Skipping unmerged submodule $path"
459 name=$(module_name "$path") || exit
460 url=$(git config submodule."$name".url)
461 update_module=$(git config submodule."$name".update)
464 # Only mention uninitialized submodules when its
465 # path have been specified
467 say "Submodule path '$path' not initialized" &&
468 say "Maybe you want to use 'update --init'?"
472 if ! test -d "$path"/.git -o -f "$path"/.git
474 module_clone "$path" "$url" "$reference"|| exit
475 cloned_modules="$cloned_modules;$name"
478 subsha1=$(clear_local_git_env; cd "$path" &&
479 git rev-parse --verify HEAD) ||
480 die "Unable to find current revision in submodule path '$path'"
483 if ! test -z "$update"
485 update_module=$update
488 if test "$subsha1" != "$sha1"
491 # If we don't already have a -f flag and the submodule has never been checked out
492 if test -z "$subsha1" -a -z "$force"
497 if test -z "$nofetch"
499 # Run fetch only if $sha1 isn't present or it
500 # is not reachable from a ref.
501 (clear_local_git_env; cd "$path" &&
502 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
503 test -z "$rev") || git-fetch)) ||
504 die "Unable to fetch in submodule path '$path'"
507 # Is this something we just cloned?
508 case ";$cloned_modules;" in
510 # then there is no local change to integrate
514 case "$update_module" in
526 command="git checkout $subforce -q"
532 (clear_local_git_env; cd "$path" && $command "$sha1") ||
533 die "Unable to $action '$sha1' in submodule path '$path'"
534 say "Submodule path '$path': $msg '$sha1'"
537 if test -n "$recursive"
539 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") ||
540 die "Failed to recurse into submodule path '$path'"
549 git describe "$2" 2>/dev/null ||
550 git describe --tags "$2" 2>/dev/null ||
551 git describe --contains "$2" 2>/dev/null ||
552 git describe --all --always "$2"
555 test -z "$revname" || revname=" ($revname)"
558 # Show commit summary for submodules in index or working tree
560 # If '--cached' is given, show summary between index and given commit,
561 # or between working tree and given commit
563 # $@ = [commit (default 'HEAD'),] requested paths (default all)
570 # parse $args after "submodule ... summary".
584 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
606 test $summary_limit = 0 && return
608 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
612 elif test -z "$1" -o "$1" = "HEAD"
614 # before the first commit: compare with an empty tree
615 head=$(git hash-object -w -t tree --stdin </dev/null)
616 test -z "$1" || shift
624 die "--cached cannot be used with --files"
630 # Get modified modules cared by user
631 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
632 sane_egrep '^:([0-7]* )?160000' |
633 while read mod_src mod_dst sha1_src sha1_dst status name
635 # Always show modules deleted or type-changed (blob<->module)
636 test $status = D -o $status = T && echo "$name" && continue
637 # Also show added or modified modules which are checked out
638 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
643 test -z "$modules" && return
645 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
646 sane_egrep '^:([0-7]* )?160000' |
648 while read mod_src mod_dst sha1_src sha1_dst status name
650 if test -z "$cached" &&
651 test $sha1_dst = 0000000000000000000000000000000000000000
655 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
657 100644 | 100755 | 120000)
658 sha1_dst=$(git hash-object $name)
664 echo >&2 "unexpected mode $mod_dst"
671 test $mod_src = 160000 &&
672 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
675 test $mod_dst = 160000 &&
676 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
680 case "$missing_src,$missing_dst" in
682 errmsg=" Warn: $name doesn't contain commit $sha1_src"
685 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
688 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
693 if test $mod_src = 160000 -a $mod_dst = 160000
695 range="$sha1_src...$sha1_dst"
696 elif test $mod_src = 160000
702 GIT_DIR="$name/.git" \
703 git rev-list --first-parent $range -- | wc -l
705 total_commits=" ($(($total_commits + 0)))"
709 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
710 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
713 if test $mod_dst = 160000
715 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
717 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
720 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
724 # Don't give error msg for modification whose dst is not submodule
725 # i.e. deleted or changed to blob
726 test $mod_dst = 160000 && echo "$errmsg"
728 if test $mod_src = 160000 -a $mod_dst = 160000
731 test $summary_limit -gt 0 && limit="-$summary_limit"
732 GIT_DIR="$name/.git" \
733 git log $limit --pretty='format: %m %s' \
734 --first-parent $sha1_src...$sha1_dst
735 elif test $mod_dst = 160000
737 GIT_DIR="$name/.git" \
738 git log --pretty='format: > %s' -1 $sha1_dst
740 GIT_DIR="$name/.git" \
741 git log --pretty='format: < %s' -1 $sha1_src
747 if test -n "$for_status"; then
748 if [ -n "$files" ]; then
749 echo "# Submodules changed but not updated:"
751 echo "# Submodule changes to be committed:"
754 sed -e 's|^|# |' -e 's|^# $|#|'
760 # List all submodules, prefixed with:
761 # - submodule not initialized
762 # + different revision checked out
764 # If --cached was specified the revision in the index will be printed
765 # instead of the currently checked out revision.
767 # $@ = requested paths (default to all)
771 # parse $args after "submodule ... status".
796 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
801 while read mode sha1 stage path
803 name=$(module_name "$path") || exit
804 url=$(git config submodule."$name".url)
805 displaypath="$prefix$path"
808 say "U$sha1 $displaypath"
811 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
813 say "-$sha1 $displaypath"
816 set_name_rev "$path" "$sha1"
817 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
819 say " $sha1 $displaypath$revname"
823 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
824 set_name_rev "$path" "$sha1"
826 say "+$sha1 $displaypath$revname"
829 if test -n "$recursive"
832 prefix="$displaypath/"
835 eval cmd_status "$orig_args"
837 die "Failed to recurse into submodule path '$path'"
842 # Sync remote urls for submodules
843 # This makes the value for remote.$remote.url match the value
844 # specified in .gitmodules.
869 while read mode sha1 stage path
871 name=$(module_name "$path")
872 url=$(git config -f .gitmodules --get submodule."$name".url)
874 # Possibly a url relative to parent
877 url=$(resolve_relative_url "$url") || exit
881 say "Synchronizing submodule url for '$name'"
882 git config submodule."$name".url "$url"
884 if test -e "$path"/.git
889 remote=$(get_default_remote)
890 git config remote."$remote".url "$url"
896 # This loop parses the command line arguments to find the
897 # subcommand name to dispatch. Parsing of the subcommand specific
898 # options are primarily done by the subcommand implementations.
899 # Subcommand specific options such as --branch and --cached are
900 # parsed here as well, for backward compatibility.
902 while test $# != 0 && test -z "$command"
905 add | foreach | init | update | status | summary | sync)
935 # No command word defaults to "status"
936 test -n "$command" || command=status
938 # "-b branch" is accepted only by "add"
939 if test -n "$branch" && test "$command" != add
944 # "--cached" is accepted only by "status" and "summary"
945 if test -n "$cached" && test "$command" != status -a "$command" != summary