3 # git-submodule.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] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
9 or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
10 or: $dashless [--quiet] init [--] [<path>...]
11 or: $dashless [--quiet] deinit [-f|--force] (--all| [--] <path>...)
12 or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--reference <repository>] [--recursive] [--] [<path>...]
13 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
14 or: $dashless [--quiet] foreach [--recursive] <command>
15 or: $dashless [--quiet] sync [--recursive] [--] [<path>...]"
22 wt_prefix=$(git rev-parse --show-prefix)
25 # Restrict ourselves to a vanilla subset of protocols; the URLs
26 # we get are under control of a remote repository, and we do not
27 # want them kicking off arbitrary git-remote-* programs.
29 # If the user has already specified a set of allowed protocols,
30 # we assume they know what they're doing and use that instead.
31 : ${GIT_ALLOW_PROTOCOL=file:git:http:https:ssh}
32 export GIT_ALLOW_PROTOCOL
51 if test "$1" = "#unmatched"
58 # Print a submodule configuration setting
64 # Checks in the usual git-config places first (for overrides),
65 # otherwise it falls back on .gitmodules. This allows you to
66 # distribute project-wide defaults in .gitmodules, while still
67 # customizing individual repositories if necessary. If the option is
68 # not in .gitmodules either, print a default value.
70 get_submodule_config () {
74 value=$(git config submodule."$name"."$option")
77 value=$(git config -f .gitmodules submodule."$name"."$option")
79 printf '%s' "${value:-$default}"
84 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
87 # Sanitize the local git environment for use within a submodule. We
88 # can't simply use clear_local_git_env since we want to preserve some
89 # of the settings from GIT_CONFIG_PARAMETERS.
90 sanitize_submodule_env()
92 save_config=$GIT_CONFIG_PARAMETERS
94 GIT_CONFIG_PARAMETERS=$save_config
95 export GIT_CONFIG_PARAMETERS
99 # Add a new submodule to the working tree, .gitmodules and the index
103 # optional branch is stored in global branch variable
107 # parse $args after "submodule ... add".
113 case "$2" in '') usage ;; esac
124 case "$2" in '') usage ;; esac
129 reference_path="${1#--reference=}"
132 case "$2" in '') usage ;; esac
137 case "$2" in '') usage ;; esac
158 if test -n "$reference_path"
160 is_absolute_path "$reference_path" ||
161 reference_path="$wt_prefix$reference_path"
163 reference="--reference=$reference_path"
169 if test -z "$sm_path"; then
170 sm_path=$(printf '%s\n' "$repo" |
171 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
174 if test -z "$repo" || test -z "$sm_path"; then
178 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
180 # assure repo is absolute or relative to parent
183 test -z "$wt_prefix" ||
184 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
186 # dereference source url relative to parent's url
187 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
194 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
199 # multiple //; leading ./; /./; /../; trailing /
200 sm_path=$(printf '%s/\n' "$sm_path" |
210 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
211 die "$(eval_gettext "'\$sm_path' already exists in the index")"
213 if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
215 eval_gettextln "The following path is ignored by one of your .gitignore files:
217 Use -f if you really want to add it." >&2
221 if test -n "$custom_name"
223 sm_name="$custom_name"
228 # perhaps the path exists and is already a git repo, else clone it
229 if test -e "$sm_path"
231 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
233 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
235 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
239 if test -d ".git/modules/$sm_name"
243 echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
244 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
245 echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
246 echo >&2 " $realrepo"
247 echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
248 die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
250 echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
253 git submodule--helper clone ${GIT_QUIET:+--quiet} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${depth:+"$depth"} || exit
255 sanitize_submodule_env
257 # ash fails to wordsplit ${branch:+-b "$branch"...}
259 '') git checkout -f -q ;;
260 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
262 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
264 git config submodule."$sm_name".url "$realrepo"
266 git add $force "$sm_path" ||
267 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
269 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
270 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
273 git config -f .gitmodules submodule."$sm_name".branch "$branch"
275 git add --force .gitmodules ||
276 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
280 # Execute an arbitrary command sequence in each checked out
283 # $@ = command to execute
287 # parse $args after "submodule ... foreach".
309 # dup stdin so that it can be restored when running the external
310 # command in the subshell (and a recursive call to this function)
314 git submodule--helper list --prefix "$wt_prefix" ||
317 while read mode sha1 stage sm_path
319 die_if_unmatched "$mode"
320 if test -e "$sm_path"/.git
322 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
323 say "$(eval_gettext "Entering '\$displaypath'")"
324 name=$(git submodule--helper name "$sm_path")
326 prefix="$prefix$sm_path/"
327 sanitize_submodule_env
329 sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") &&
330 # we make $path available to scripts ...
338 if test -n "$recursive"
340 cmd_foreach "--recursive" "$@"
343 die "$(eval_gettext "Stopping at '\$displaypath'; script returned non-zero status.")"
349 # Register submodules in .git/config
351 # $@ = requested paths (default to all)
355 # parse $args after "submodule ... init".
376 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper init ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} "$@"
380 # Unregister submodules from .git/config and remove their work tree
384 # parse $args after "submodule ... deinit".
412 if test -n "$deinit_all" && test "$#" -ne 0
414 echo >&2 "$(eval_gettext "pathspec and --all are incompatible")"
417 if test $# = 0 && test -z "$deinit_all"
419 die "$(eval_gettext "Use '--all' if you really want to deinitialize all submodules")"
423 git submodule--helper list --prefix "$wt_prefix" "$@" ||
426 while read mode sha1 stage sm_path
428 die_if_unmatched "$mode"
429 name=$(git submodule--helper name "$sm_path") || exit
431 displaypath=$(git submodule--helper relative-path "$sm_path" "$wt_prefix")
433 # Remove the submodule work tree (unless the user already did it)
434 if test -d "$sm_path"
436 # Protect submodules containing a .git directory
437 if test -d "$sm_path/.git"
439 echo >&2 "$(eval_gettext "Submodule work tree '\$displaypath' contains a .git directory")"
440 die "$(eval_gettext "(use 'rm -rf' if you really want to remove it including all of its history)")"
445 git rm -qn "$sm_path" ||
446 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
449 say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
450 say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
453 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
455 # Remove the .git/config entries (unless the user already did it)
456 if test -n "$(git config --get-regexp submodule."$name\.")"
458 # Remove the whole section so we have a clean state when
459 # the user later decides to init this submodule again
460 url=$(git config submodule."$name".url)
461 git config --remove-section submodule."$name" 2>/dev/null &&
462 say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
467 is_tip_reachable () (
468 sanitize_submodule_env &&
470 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
474 fetch_in_submodule () (
475 sanitize_submodule_env &&
481 git fetch $(get_default_remote) "$2" ;;
486 # Update each submodule path to correct revision, using clone and checkout as needed
488 # $@ = requested paths (default to all)
492 # parse $args after "submodule ... update".
515 case "$2" in '') usage ;; esac
516 reference="--reference=$2"
532 case "$2" in '') usage ;; esac
540 case "$2" in '') usage ;; esac
563 cmd_init "--" "$@" || return
567 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
568 ${wt_prefix:+--prefix "$wt_prefix"} \
569 ${prefix:+--recursive-prefix "$prefix"} \
570 ${update:+--update "$update"} \
571 ${reference:+--reference "$reference"} \
572 ${depth:+--depth "$depth"} \
574 "$@" || echo "#unmatched"
577 while read mode sha1 stage just_cloned sm_path
579 die_if_unmatched "$mode"
581 name=$(git submodule--helper name "$sm_path") || exit
582 url=$(git config submodule."$name".url)
583 branch=$(get_submodule_config "$name" branch master)
584 if ! test -z "$update"
586 update_module=$update
588 update_module=$(git config submodule."$name".update)
589 if test -z "$update_module"
591 update_module="checkout"
595 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
597 if test $just_cloned -eq 1
600 update_module=checkout
602 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
603 git rev-parse --verify HEAD) ||
604 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
609 if test -z "$nofetch"
611 # Fetch remote before determining tracking $sha1
612 (sanitize_submodule_env; cd "$sm_path" && git-fetch) ||
613 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
615 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
616 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
617 git rev-parse --verify "${remote_name}/${branch}") ||
618 die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
621 if test "$subsha1" != "$sha1" || test -n "$force"
624 # If we don't already have a -f flag and the submodule has never been checked out
625 if test -z "$subsha1" && test -z "$force"
630 if test -z "$nofetch"
632 # Run fetch only if $sha1 isn't present or it
633 # is not reachable from a ref.
634 is_tip_reachable "$sm_path" "$sha1" ||
635 fetch_in_submodule "$sm_path" ||
636 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
638 # Now we tried the usual fetch, but $sha1 may
639 # not be reachable from any of the refs
640 is_tip_reachable "$sm_path" "$sha1" ||
641 fetch_in_submodule "$sm_path" "$sha1" ||
642 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain $sha1. Direct fetching of that commit failed.")"
646 case "$update_module" in
648 command="git checkout $subforce -q"
649 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
650 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
654 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
655 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
656 must_die_on_failure=yes
660 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
661 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
662 must_die_on_failure=yes
665 command="${update_module#!}"
666 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
667 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
668 must_die_on_failure=yes
671 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
674 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
677 elif test -n "$must_die_on_failure"
679 die_with_status 2 "$die_msg"
681 err="${err};$die_msg"
686 if test -n "$recursive"
689 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
691 sanitize_submodule_env
698 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
701 err="${err};$die_msg"
704 die_with_status $res "$die_msg"
729 sanitize_submodule_env
731 git describe "$2" 2>/dev/null ||
732 git describe --tags "$2" 2>/dev/null ||
733 git describe --contains "$2" 2>/dev/null ||
734 git describe --all --always "$2"
737 test -z "$revname" || revname=" ($revname)"
740 # Show commit summary for submodules in index or working tree
742 # If '--cached' is given, show summary between index and given commit,
743 # or between working tree and given commit
745 # $@ = [commit (default 'HEAD'),] requested paths (default all)
752 # parse $args after "submodule ... summary".
767 isnumber "$summary_limit" || usage
771 summary_limit="${1#--summary-limit=}"
772 isnumber "$summary_limit" || usage
788 test $summary_limit = 0 && return
790 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
794 elif test -z "$1" || test "$1" = "HEAD"
796 # before the first commit: compare with an empty tree
797 head=$(git hash-object -w -t tree --stdin </dev/null)
798 test -z "$1" || shift
806 die "$(gettext "The --cached option cannot be used with the --files option")"
812 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
813 # Get modified modules cared by user
814 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
815 sane_egrep '^:([0-7]* )?160000' |
816 while read mod_src mod_dst sha1_src sha1_dst status sm_path
818 # Always show modules deleted or type-changed (blob<->module)
819 if test "$status" = D || test "$status" = T
821 printf '%s\n' "$sm_path"
824 # Respect the ignore setting for --for-status.
825 if test -n "$for_status"
827 name=$(git submodule--helper name "$sm_path")
828 ignore_config=$(get_submodule_config "$name" ignore none)
829 test $status != A && test $ignore_config = all && continue
831 # Also show added or modified modules which are checked out
832 GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
833 printf '%s\n' "$sm_path"
837 test -z "$modules" && return
839 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
840 sane_egrep '^:([0-7]* )?160000' |
842 while read mod_src mod_dst sha1_src sha1_dst status name
844 if test -z "$cached" &&
845 test $sha1_dst = 0000000000000000000000000000000000000000
849 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
851 100644 | 100755 | 120000)
852 sha1_dst=$(git hash-object $name)
858 eval_gettextln "unexpected mode \$mod_dst" >&2
865 test $mod_src = 160000 &&
866 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
869 test $mod_dst = 160000 &&
870 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
873 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
876 case "$missing_src,$missing_dst" in
878 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
881 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
884 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
889 if test $mod_src = 160000 && test $mod_dst = 160000
891 range="$sha1_src...$sha1_dst"
892 elif test $mod_src = 160000
898 GIT_DIR="$name/.git" \
899 git rev-list --first-parent $range -- | wc -l
901 total_commits=" ($(($total_commits + 0)))"
905 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
906 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
909 blob="$(gettext "blob")"
910 submodule="$(gettext "submodule")"
911 if test $mod_dst = 160000
913 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
915 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
918 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
922 # Don't give error msg for modification whose dst is not submodule
923 # i.e. deleted or changed to blob
924 test $mod_dst = 160000 && echo "$errmsg"
926 if test $mod_src = 160000 && test $mod_dst = 160000
929 test $summary_limit -gt 0 && limit="-$summary_limit"
930 GIT_DIR="$name/.git" \
931 git log $limit --pretty='format: %m %s' \
932 --first-parent $sha1_src...$sha1_dst
933 elif test $mod_dst = 160000
935 GIT_DIR="$name/.git" \
936 git log --pretty='format: > %s' -1 $sha1_dst
938 GIT_DIR="$name/.git" \
939 git log --pretty='format: < %s' -1 $sha1_src
947 # List all submodules, prefixed with:
948 # - submodule not initialized
949 # + different revision checked out
951 # If --cached was specified the revision in the index will be printed
952 # instead of the currently checked out revision.
954 # $@ = requested paths (default to all)
958 # parse $args after "submodule ... status".
986 git submodule--helper list --prefix "$wt_prefix" "$@" ||
989 while read mode sha1 stage sm_path
991 die_if_unmatched "$mode"
992 name=$(git submodule--helper name "$sm_path") || exit
993 url=$(git config submodule."$name".url)
994 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
997 say "U$sha1 $displaypath"
1000 if test -z "$url" ||
1002 ! test -d "$sm_path"/.git &&
1003 ! test -f "$sm_path"/.git
1006 say "-$sha1 $displaypath"
1009 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1011 set_name_rev "$sm_path" "$sha1"
1012 say " $sha1 $displaypath$revname"
1014 if test -z "$cached"
1016 sha1=$(sanitize_submodule_env; cd "$sm_path" && git rev-parse --verify HEAD)
1018 set_name_rev "$sm_path" "$sha1"
1019 say "+$sha1 $displaypath$revname"
1022 if test -n "$recursive"
1025 prefix="$displaypath/"
1026 sanitize_submodule_env
1031 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1036 # Sync remote urls for submodules
1037 # This makes the value for remote.$remote.url match the value
1038 # specified in .gitmodules.
1067 git submodule--helper list --prefix "$wt_prefix" "$@" ||
1070 while read mode sha1 stage sm_path
1072 die_if_unmatched "$mode"
1073 name=$(git submodule--helper name "$sm_path")
1074 url=$(git config -f .gitmodules --get submodule."$name".url)
1076 # Possibly a url relative to parent
1079 # rewrite foo/bar as ../.. to find path from
1080 # submodule work tree to superproject work tree
1081 up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1082 # guarantee a trailing /
1083 up_path=${up_path%/}/ &&
1084 # path from submodule work tree to submodule origin repo
1085 sub_origin_url=$(git submodule--helper resolve-relative-url "$url" "$up_path") &&
1086 # path from superproject work tree to submodule origin repo
1087 super_config_url=$(git submodule--helper resolve-relative-url "$url") || exit
1090 sub_origin_url="$url"
1091 super_config_url="$url"
1095 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1097 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
1098 say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1099 git config submodule."$name".url "$super_config_url"
1101 if test -e "$sm_path"/.git
1104 sanitize_submodule_env
1106 remote=$(get_default_remote)
1107 git config remote."$remote".url "$sub_origin_url"
1109 if test -n "$recursive"
1111 prefix="$prefix$sm_path/"
1120 # This loop parses the command line arguments to find the
1121 # subcommand name to dispatch. Parsing of the subcommand specific
1122 # options are primarily done by the subcommand implementations.
1123 # Subcommand specific options such as --branch and --cached are
1124 # parsed here as well, for backward compatibility.
1126 while test $# != 0 && test -z "$command"
1129 add | foreach | init | deinit | update | status | summary | sync)
1159 # No command word defaults to "status"
1160 if test -z "$command"
1170 # "-b branch" is accepted only by "add"
1171 if test -n "$branch" && test "$command" != add
1176 # "--cached" is accepted only by "status" and "summary"
1177 if test -n "$cached" && test "$command" != status && test "$command" != summary