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] [--[no-]recommend-shallow] [--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>...]
16 or: $dashless [--quiet] absorbgitdirs [--] [<path>...]"
22 wt_prefix=$(git rev-parse --show-prefix)
25 # Tell the rest of git that any URLs we get don't come
26 # directly from the user, so it can apply policy as appropriate.
27 GIT_PROTOCOL_FROM_USER=0
28 export GIT_PROTOCOL_FROM_USER
48 if test "$1" = "#unmatched"
55 # Print a submodule configuration setting
61 # Checks in the usual git-config places first (for overrides),
62 # otherwise it falls back on .gitmodules. This allows you to
63 # distribute project-wide defaults in .gitmodules, while still
64 # customizing individual repositories if necessary. If the option is
65 # not in .gitmodules either, print a default value.
67 get_submodule_config () {
71 value=$(git config submodule."$name"."$option")
74 value=$(git config -f .gitmodules submodule."$name"."$option")
76 printf '%s' "${value:-$default}"
81 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
84 # Sanitize the local git environment for use within a submodule. We
85 # can't simply use clear_local_git_env since we want to preserve some
86 # of the settings from GIT_CONFIG_PARAMETERS.
87 sanitize_submodule_env()
89 save_config=$GIT_CONFIG_PARAMETERS
91 GIT_CONFIG_PARAMETERS=$save_config
92 export GIT_CONFIG_PARAMETERS
96 # Add a new submodule to the working tree, .gitmodules and the index
100 # optional branch is stored in global branch variable
104 # parse $args after "submodule ... add".
110 case "$2" in '') usage ;; esac
121 case "$2" in '') usage ;; esac
126 reference_path="${1#--reference=}"
129 case "$2" in '') usage ;; esac
134 case "$2" in '') usage ;; esac
155 if test -n "$reference_path"
157 is_absolute_path "$reference_path" ||
158 reference_path="$wt_prefix$reference_path"
160 reference="--reference=$reference_path"
166 if test -z "$sm_path"; then
167 sm_path=$(printf '%s\n' "$repo" |
168 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
171 if test -z "$repo" || test -z "$sm_path"; then
175 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
177 # assure repo is absolute or relative to parent
180 test -z "$wt_prefix" ||
181 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
183 # dereference source url relative to parent's url
184 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
191 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
196 # multiple //; leading ./; /./; /../; trailing /
197 sm_path=$(printf '%s/\n' "$sm_path" |
209 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
210 die "$(eval_gettext "'\$sm_path' already exists in the index")"
212 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
213 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
216 if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
218 eval_gettextln "The following path is ignored by one of your .gitignore files:
220 Use -f if you really want to add it." >&2
224 if test -n "$custom_name"
226 sm_name="$custom_name"
231 if ! git submodule--helper check-name "$sm_name"
233 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
236 # perhaps the path exists and is already a git repo, else clone it
237 if test -e "$sm_path"
239 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
241 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
243 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
247 if test -d ".git/modules/$sm_name"
251 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
252 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
253 die "$(eval_gettextln "\
254 If you want to reuse this local git directory instead of cloning again from
256 use the '--force' option. If the local git directory is not the correct repo
257 or you are unsure what this means choose another name with the '--name' option.")"
259 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
262 git submodule--helper clone ${GIT_QUIET:+--quiet} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${depth:+"$depth"} || exit
264 sanitize_submodule_env
266 # ash fails to wordsplit ${branch:+-b "$branch"...}
268 '') git checkout -f -q ;;
269 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
271 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
273 git config submodule."$sm_name".url "$realrepo"
275 git add $force "$sm_path" ||
276 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
278 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
279 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
282 git config -f .gitmodules submodule."$sm_name".branch "$branch"
284 git add --force .gitmodules ||
285 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
287 # NEEDSWORK: In a multi-working-tree world, this needs to be
288 # set in the per-worktree config.
289 if git config --get submodule.active >/dev/null
291 # If the submodule being adding isn't already covered by the
292 # current configured pathspec, set the submodule's active flag
293 if ! git submodule--helper is-active "$sm_path"
295 git config submodule."$sm_name".active "true"
298 git config submodule."$sm_name".active "true"
303 # Execute an arbitrary command sequence in each checked out
306 # $@ = command to execute
310 # parse $args after "submodule ... foreach".
332 # dup stdin so that it can be restored when running the external
333 # command in the subshell (and a recursive call to this function)
337 git submodule--helper list --prefix "$wt_prefix" ||
340 while read -r mode sha1 stage sm_path
342 die_if_unmatched "$mode" "$sha1"
343 if test -e "$sm_path"/.git
345 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
346 say "$(eval_gettext "Entering '\$displaypath'")"
347 name=$(git submodule--helper name "$sm_path")
349 prefix="$prefix$sm_path/"
350 sanitize_submodule_env
352 sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") &&
353 # we make $path available to scripts ...
361 if test -n "$recursive"
363 cmd_foreach "--recursive" "$@"
366 die "$(eval_gettext "Stopping at '\$displaypath'; script returned non-zero status.")"
372 # Register submodules in .git/config
374 # $@ = requested paths (default to all)
378 # parse $args after "submodule ... init".
399 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} "$@"
403 # Unregister submodules from .git/config and remove their work tree
407 # parse $args after "submodule ... deinit".
435 if test -n "$deinit_all" && test "$#" -ne 0
437 echo >&2 "$(eval_gettext "pathspec and --all are incompatible")"
440 if test $# = 0 && test -z "$deinit_all"
442 die "$(eval_gettext "Use '--all' if you really want to deinitialize all submodules")"
446 git submodule--helper list --prefix "$wt_prefix" "$@" ||
449 while read -r mode sha1 stage sm_path
451 die_if_unmatched "$mode" "$sha1"
452 name=$(git submodule--helper name "$sm_path") || exit
454 displaypath=$(git submodule--helper relative-path "$sm_path" "$wt_prefix")
456 # Remove the submodule work tree (unless the user already did it)
457 if test -d "$sm_path"
459 # Protect submodules containing a .git directory
460 if test -d "$sm_path/.git"
462 die "$(eval_gettext "\
463 Submodule work tree '\$displaypath' contains a .git directory
464 (use 'rm -rf' if you really want to remove it including all of its history)")"
469 git rm -qn "$sm_path" ||
470 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
473 say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
474 say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
477 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
479 # Remove the .git/config entries (unless the user already did it)
480 if test -n "$(git config --get-regexp submodule."$name\.")"
482 # Remove the whole section so we have a clean state when
483 # the user later decides to init this submodule again
484 url=$(git config submodule."$name".url)
485 git config --remove-section submodule."$name" 2>/dev/null &&
486 say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
491 is_tip_reachable () (
492 sanitize_submodule_env &&
494 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
498 fetch_in_submodule () (
499 sanitize_submodule_env &&
506 git fetch $(get_default_remote) "$@" ;;
511 # Update each submodule path to correct revision, using clone and checkout as needed
513 # $@ = requested paths (default to all)
517 # parse $args after "submodule ... update".
525 progress="--progress"
543 case "$2" in '') usage ;; esac
544 reference="--reference=$2"
560 recommend_shallow="--recommend-shallow"
562 --no-recommend-shallow)
563 recommend_shallow="--no-recommend-shallow"
566 case "$2" in '') usage ;; esac
574 case "$2" in '') usage ;; esac
597 cmd_init "--" "$@" || return
601 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
602 ${progress:+"$progress"} \
603 ${wt_prefix:+--prefix "$wt_prefix"} \
604 ${prefix:+--recursive-prefix "$prefix"} \
605 ${update:+--update "$update"} \
606 ${reference:+"$reference"} \
607 ${depth:+--depth "$depth"} \
608 ${recommend_shallow:+"$recommend_shallow"} \
610 "$@" || echo "#unmatched" $?
613 while read -r mode sha1 stage just_cloned sm_path
615 die_if_unmatched "$mode" "$sha1"
617 name=$(git submodule--helper name "$sm_path") || exit
618 url=$(git config submodule."$name".url)
619 if ! test -z "$update"
621 update_module=$update
623 update_module=$(git config submodule."$name".update)
624 if test -z "$update_module"
626 update_module="checkout"
630 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
632 if test $just_cloned -eq 1
635 case "$update_module" in
636 merge | rebase | none)
637 update_module=checkout ;;
640 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
641 git rev-parse --verify HEAD) ||
642 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
647 branch=$(git submodule--helper remote-branch "$sm_path")
648 if test -z "$nofetch"
650 # Fetch remote before determining tracking $sha1
651 fetch_in_submodule "$sm_path" $depth ||
652 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
654 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
655 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
656 git rev-parse --verify "${remote_name}/${branch}") ||
657 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
660 if test "$subsha1" != "$sha1" || test -n "$force"
663 # If we don't already have a -f flag and the submodule has never been checked out
664 if test -z "$subsha1" && test -z "$force"
669 if test -z "$nofetch"
671 # Run fetch only if $sha1 isn't present or it
672 # is not reachable from a ref.
673 is_tip_reachable "$sm_path" "$sha1" ||
674 fetch_in_submodule "$sm_path" $depth ||
675 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
677 # Now we tried the usual fetch, but $sha1 may
678 # not be reachable from any of the refs
679 is_tip_reachable "$sm_path" "$sha1" ||
680 fetch_in_submodule "$sm_path" $depth "$sha1" ||
681 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
685 case "$update_module" in
687 command="git checkout $subforce -q"
688 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
689 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
693 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
694 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
695 must_die_on_failure=yes
699 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
700 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
701 must_die_on_failure=yes
704 command="${update_module#!}"
705 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
706 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
707 must_die_on_failure=yes
710 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
713 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
716 elif test -n "$must_die_on_failure"
718 die_with_status 2 "$die_msg"
720 err="${err};$die_msg"
725 if test -n "$recursive"
728 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
730 sanitize_submodule_env
737 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
740 err="${err};$die_msg"
743 die_with_status $res "$die_msg"
768 sanitize_submodule_env
770 git describe "$2" 2>/dev/null ||
771 git describe --tags "$2" 2>/dev/null ||
772 git describe --contains "$2" 2>/dev/null ||
773 git describe --all --always "$2"
776 test -z "$revname" || revname=" ($revname)"
779 # Show commit summary for submodules in index or working tree
781 # If '--cached' is given, show summary between index and given commit,
782 # or between working tree and given commit
784 # $@ = [commit (default 'HEAD'),] requested paths (default all)
791 # parse $args after "submodule ... summary".
806 isnumber "$summary_limit" || usage
810 summary_limit="${1#--summary-limit=}"
811 isnumber "$summary_limit" || usage
827 test $summary_limit = 0 && return
829 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
833 elif test -z "$1" || test "$1" = "HEAD"
835 # before the first commit: compare with an empty tree
836 head=$(git hash-object -w -t tree --stdin </dev/null)
837 test -z "$1" || shift
845 die "$(gettext "The --cached option cannot be used with the --files option")"
851 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
852 # Get modified modules cared by user
853 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
854 sane_egrep '^:([0-7]* )?160000' |
855 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
857 # Always show modules deleted or type-changed (blob<->module)
858 if test "$status" = D || test "$status" = T
860 printf '%s\n' "$sm_path"
863 # Respect the ignore setting for --for-status.
864 if test -n "$for_status"
866 name=$(git submodule--helper name "$sm_path")
867 ignore_config=$(get_submodule_config "$name" ignore none)
868 test $status != A && test $ignore_config = all && continue
870 # Also show added or modified modules which are checked out
871 GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
872 printf '%s\n' "$sm_path"
876 test -z "$modules" && return
878 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
879 sane_egrep '^:([0-7]* )?160000' |
881 while read -r mod_src mod_dst sha1_src sha1_dst status name
883 if test -z "$cached" &&
884 test $sha1_dst = 0000000000000000000000000000000000000000
888 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
890 100644 | 100755 | 120000)
891 sha1_dst=$(git hash-object $name)
897 eval_gettextln "unexpected mode \$mod_dst" >&2
904 test $mod_src = 160000 &&
905 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
908 test $mod_dst = 160000 &&
909 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
912 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
915 case "$missing_src,$missing_dst" in
917 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
920 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
923 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
928 if test $mod_src = 160000 && test $mod_dst = 160000
930 range="$sha1_src...$sha1_dst"
931 elif test $mod_src = 160000
937 GIT_DIR="$name/.git" \
938 git rev-list --first-parent $range -- | wc -l
940 total_commits=" ($(($total_commits + 0)))"
944 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
945 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
948 blob="$(gettext "blob")"
949 submodule="$(gettext "submodule")"
950 if test $mod_dst = 160000
952 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
954 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
957 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
961 # Don't give error msg for modification whose dst is not submodule
962 # i.e. deleted or changed to blob
963 test $mod_dst = 160000 && echo "$errmsg"
965 if test $mod_src = 160000 && test $mod_dst = 160000
968 test $summary_limit -gt 0 && limit="-$summary_limit"
969 GIT_DIR="$name/.git" \
970 git log $limit --pretty='format: %m %s' \
971 --first-parent $sha1_src...$sha1_dst
972 elif test $mod_dst = 160000
974 GIT_DIR="$name/.git" \
975 git log --pretty='format: > %s' -1 $sha1_dst
977 GIT_DIR="$name/.git" \
978 git log --pretty='format: < %s' -1 $sha1_src
986 # List all submodules, prefixed with:
987 # - submodule not initialized
988 # + different revision checked out
990 # If --cached was specified the revision in the index will be printed
991 # instead of the currently checked out revision.
993 # $@ = requested paths (default to all)
997 # parse $args after "submodule ... status".
1025 git submodule--helper list --prefix "$wt_prefix" "$@" ||
1026 echo "#unmatched" $?
1028 while read -r mode sha1 stage sm_path
1030 die_if_unmatched "$mode" "$sha1"
1031 name=$(git submodule--helper name "$sm_path") || exit
1032 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
1033 if test "$stage" = U
1035 say "U$sha1 $displaypath"
1038 if ! git submodule--helper is-active "$sm_path" ||
1040 ! test -d "$sm_path"/.git &&
1041 ! test -f "$sm_path"/.git
1044 say "-$sha1 $displaypath"
1047 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1049 set_name_rev "$sm_path" "$sha1"
1050 say " $sha1 $displaypath$revname"
1052 if test -z "$cached"
1054 sha1=$(sanitize_submodule_env; cd "$sm_path" && git rev-parse --verify HEAD)
1056 set_name_rev "$sm_path" "$sha1"
1057 say "+$sha1 $displaypath$revname"
1060 if test -n "$recursive"
1063 prefix="$displaypath/"
1064 sanitize_submodule_env
1069 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1074 # Sync remote urls for submodules
1075 # This makes the value for remote.$remote.url match the value
1076 # specified in .gitmodules.
1105 git submodule--helper list --prefix "$wt_prefix" "$@" ||
1106 echo "#unmatched" $?
1108 while read -r mode sha1 stage sm_path
1110 die_if_unmatched "$mode" "$sha1"
1112 # skip inactive submodules
1113 if ! git submodule--helper is-active "$sm_path"
1118 name=$(git submodule--helper name "$sm_path")
1119 url=$(git config -f .gitmodules --get submodule."$name".url)
1121 # Possibly a url relative to parent
1124 # rewrite foo/bar as ../.. to find path from
1125 # submodule work tree to superproject work tree
1126 up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1127 # guarantee a trailing /
1128 up_path=${up_path%/}/ &&
1129 # path from submodule work tree to submodule origin repo
1130 sub_origin_url=$(git submodule--helper resolve-relative-url "$url" "$up_path") &&
1131 # path from superproject work tree to submodule origin repo
1132 super_config_url=$(git submodule--helper resolve-relative-url "$url") || exit
1135 sub_origin_url="$url"
1136 super_config_url="$url"
1140 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
1141 say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1142 git config submodule."$name".url "$super_config_url"
1144 if test -e "$sm_path"/.git
1147 sanitize_submodule_env
1149 remote=$(get_default_remote)
1150 git config remote."$remote".url "$sub_origin_url"
1152 if test -n "$recursive"
1154 prefix="$prefix$sm_path/"
1164 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
1167 # This loop parses the command line arguments to find the
1168 # subcommand name to dispatch. Parsing of the subcommand specific
1169 # options are primarily done by the subcommand implementations.
1170 # Subcommand specific options such as --branch and --cached are
1171 # parsed here as well, for backward compatibility.
1173 while test $# != 0 && test -z "$command"
1176 add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
1206 # No command word defaults to "status"
1207 if test -z "$command"
1217 # "-b branch" is accepted only by "add"
1218 if test -n "$branch" && test "$command" != add
1223 # "--cached" is accepted only by "status" and "summary"
1224 if test -n "$cached" && test "$command" != status && test "$command" != summary