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] [--cached]
9 or: $dashless [--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
10 or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
11 or: $dashless [--quiet] init [--] [<path>...]
12 or: $dashless [--quiet] deinit [-f|--force] (--all| [--] <path>...)
13 or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--[no-]recommend-shallow] [--reference <repository>] [--recursive] [--] [<path>...]
14 or: $dashless [--quiet] set-branch (--default|--branch <branch>) [--] <path>
15 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
16 or: $dashless [--quiet] foreach [--recursive] <command>
17 or: $dashless [--quiet] sync [--recursive] [--] [<path>...]
18 or: $dashless [--quiet] absorbgitdirs [--] [<path>...]"
24 wt_prefix=$(git rev-parse --show-prefix)
27 # Tell the rest of git that any URLs we get don't come
28 # directly from the user, so it can apply policy as appropriate.
29 GIT_PROTOCOL_FROM_USER=0
30 export GIT_PROTOCOL_FROM_USER
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 submodule--helper config submodule."$name"."$option")
79 printf '%s' "${value:-$default}"
84 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
87 # Given a full hex object ID, is this the zero OID?
89 echo "$1" | sane_egrep '^0+$' >/dev/null 2>&1
92 # Sanitize the local git environment for use within a submodule. We
93 # can't simply use clear_local_git_env since we want to preserve some
94 # of the settings from GIT_CONFIG_PARAMETERS.
95 sanitize_submodule_env()
97 save_config=$GIT_CONFIG_PARAMETERS
99 GIT_CONFIG_PARAMETERS=$save_config
100 export GIT_CONFIG_PARAMETERS
104 # Add a new submodule to the working tree, .gitmodules and the index
108 # optional branch is stored in global branch variable
112 # parse $args after "submodule ... add".
118 case "$2" in '') usage ;; esac
132 case "$2" in '') usage ;; esac
137 reference_path="${1#--reference=}"
143 case "$2" in '') usage ;; esac
148 case "$2" in '') usage ;; esac
169 if ! git submodule--helper config --check-writeable >/dev/null 2>&1
171 die "$(eval_gettext "please make sure that the .gitmodules file is in the working tree")"
174 if test -n "$reference_path"
176 is_absolute_path "$reference_path" ||
177 reference_path="$wt_prefix$reference_path"
179 reference="--reference=$reference_path"
185 if test -z "$sm_path"; then
186 sm_path=$(printf '%s\n' "$repo" |
187 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
190 if test -z "$repo" || test -z "$sm_path"; then
194 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
196 # assure repo is absolute or relative to parent
199 test -z "$wt_prefix" ||
200 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
202 # dereference source url relative to parent's url
203 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
210 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
215 # multiple //; leading ./; /./; /../; trailing /
216 sm_path=$(printf '%s/\n' "$sm_path" |
228 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
229 die "$(eval_gettext "'\$sm_path' already exists in the index")"
231 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
232 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
235 if test -z "$force" &&
236 ! git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev/null 2>&1
238 eval_gettextln "The following path is ignored by one of your .gitignore files:
240 Use -f if you really want to add it." >&2
244 if test -n "$custom_name"
246 sm_name="$custom_name"
251 if ! git submodule--helper check-name "$sm_name"
253 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
256 # perhaps the path exists and is already a git repo, else clone it
257 if test -e "$sm_path"
259 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
261 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
263 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
267 if test -d ".git/modules/$sm_name"
271 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
272 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
273 die "$(eval_gettextln "\
274 If you want to reuse this local git directory instead of cloning again from
276 use the '--force' option. If the local git directory is not the correct repo
277 or you are unsure what this means choose another name with the '--name' option.")"
279 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
282 git submodule--helper clone ${GIT_QUIET:+--quiet} ${progress:+"--progress"} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${dissociate:+"--dissociate"} ${depth:+"$depth"} || exit
284 sanitize_submodule_env
286 # ash fails to wordsplit ${branch:+-b "$branch"...}
288 '') git checkout -f -q ;;
289 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
291 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
293 git config submodule."$sm_name".url "$realrepo"
295 git add --no-warn-embedded-repo $force "$sm_path" ||
296 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
298 git submodule--helper config submodule."$sm_name".path "$sm_path" &&
299 git submodule--helper config submodule."$sm_name".url "$repo" &&
302 git submodule--helper config submodule."$sm_name".branch "$branch"
304 git add --force .gitmodules ||
305 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
307 # NEEDSWORK: In a multi-working-tree world, this needs to be
308 # set in the per-worktree config.
309 if git config --get submodule.active >/dev/null
311 # If the submodule being adding isn't already covered by the
312 # current configured pathspec, set the submodule's active flag
313 if ! git submodule--helper is-active "$sm_path"
315 git config submodule."$sm_name".active "true"
318 git config submodule."$sm_name".active "true"
323 # Execute an arbitrary command sequence in each checked out
326 # $@ = command to execute
330 # parse $args after "submodule ... foreach".
350 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
354 # Register submodules in .git/config
356 # $@ = requested paths (default to all)
360 # parse $args after "submodule ... init".
381 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} "$@"
385 # Unregister submodules from .git/config and remove their work tree
389 # parse $args after "submodule ... deinit".
417 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
420 is_tip_reachable () (
421 sanitize_submodule_env &&
423 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
427 fetch_in_submodule () (
428 sanitize_submodule_env &&
435 git fetch $(get_default_remote) "$@" ;;
440 # Update each submodule path to correct revision, using clone and checkout as needed
442 # $@ = requested paths (default to all)
446 # parse $args after "submodule ... update".
475 case "$2" in '') usage ;; esac
476 reference="--reference=$2"
495 recommend_shallow="--recommend-shallow"
497 --no-recommend-shallow)
498 recommend_shallow="--no-recommend-shallow"
501 case "$2" in '') usage ;; esac
509 case "$2" in '') usage ;; esac
532 cmd_init "--" "$@" || return
536 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
537 ${progress:+"--progress"} \
538 ${wt_prefix:+--prefix "$wt_prefix"} \
539 ${prefix:+--recursive-prefix "$prefix"} \
540 ${update:+--update "$update"} \
541 ${reference:+"$reference"} \
542 ${dissociate:+"--dissociate"} \
543 ${depth:+--depth "$depth"} \
546 "$@" || echo "#unmatched" $?
549 while read -r quickabort sha1 just_cloned sm_path
551 die_if_unmatched "$quickabort" "$sha1"
553 git submodule--helper ensure-core-worktree "$sm_path" || exit 1
555 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
557 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
559 if test $just_cloned -eq 1
563 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
564 git rev-parse --verify HEAD) ||
565 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
570 branch=$(git submodule--helper remote-branch "$sm_path")
571 if test -z "$nofetch"
573 # Fetch remote before determining tracking $sha1
574 fetch_in_submodule "$sm_path" $depth ||
575 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
577 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
578 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
579 git rev-parse --verify "${remote_name}/${branch}") ||
580 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
583 if test "$subsha1" != "$sha1" || test -n "$force"
586 # If we don't already have a -f flag and the submodule has never been checked out
587 if test -z "$subsha1" && test -z "$force"
592 if test -z "$nofetch"
594 # Run fetch only if $sha1 isn't present or it
595 # is not reachable from a ref.
596 is_tip_reachable "$sm_path" "$sha1" ||
597 fetch_in_submodule "$sm_path" $depth ||
598 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'; trying to directly fetch \$sha1:")"
600 # Now we tried the usual fetch, but $sha1 may
601 # not be reachable from any of the refs
602 is_tip_reachable "$sm_path" "$sha1" ||
603 fetch_in_submodule "$sm_path" $depth "$sha1" ||
604 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
608 case "$update_module" in
610 command="git checkout $subforce -q"
611 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
612 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
616 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
617 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
618 must_die_on_failure=yes
622 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
623 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
624 must_die_on_failure=yes
627 command="${update_module#!}"
628 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
629 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
630 must_die_on_failure=yes
633 die "$(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
636 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
639 elif test -n "$must_die_on_failure"
641 die_with_status 2 "$die_msg"
643 err="${err};$die_msg"
648 if test -n "$recursive"
651 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
653 sanitize_submodule_env
660 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
663 err="${err};$die_msg"
666 die_with_status $res "$die_msg"
690 # Configures a submodule's default branch
692 # $@ = requested path
702 # we don't do anything with this but we need to accept it
708 case "$2" in '') usage ;; esac
731 # we can't use `git submodule--helper name` here because internally, it
732 # hashes the path so a trailing slash could lead to an unintentional no match
733 name="$(git submodule--helper list "$1" | cut -f2)"
739 test -n "$branch"; has_branch=$?
740 test "$unset_branch" = true; has_unset_branch=$?
742 if test $((!$has_branch != !$has_unset_branch)) -eq 0
747 if test $has_branch -eq 0
749 git submodule--helper config submodule."$name".branch "$branch"
751 git submodule--helper config --unset submodule."$name".branch
756 # Show commit summary for submodules in index or working tree
758 # If '--cached' is given, show summary between index and given commit,
759 # or between working tree and given commit
761 # $@ = [commit (default 'HEAD'),] requested paths (default all)
768 # parse $args after "submodule ... summary".
783 isnumber "$summary_limit" || usage
787 summary_limit="${1#--summary-limit=}"
788 isnumber "$summary_limit" || usage
804 test $summary_limit = 0 && return
806 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
810 elif test -z "$1" || test "$1" = "HEAD"
812 # before the first commit: compare with an empty tree
813 head=$(git hash-object -w -t tree --stdin </dev/null)
814 test -z "$1" || shift
822 die "$(gettext "The --cached option cannot be used with the --files option")"
828 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
829 # Get modified modules cared by user
830 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
831 sane_egrep '^:([0-7]* )?160000' |
832 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
834 # Always show modules deleted or type-changed (blob<->module)
835 if test "$status" = D || test "$status" = T
837 printf '%s\n' "$sm_path"
840 # Respect the ignore setting for --for-status.
841 if test -n "$for_status"
843 name=$(git submodule--helper name "$sm_path")
844 ignore_config=$(get_submodule_config "$name" ignore none)
845 test $status != A && test $ignore_config = all && continue
847 # Also show added or modified modules which are checked out
848 GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
849 printf '%s\n' "$sm_path"
853 test -z "$modules" && return
855 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
856 sane_egrep '^:([0-7]* )?160000' |
858 while read -r mod_src mod_dst sha1_src sha1_dst status name
860 if test -z "$cached" &&
861 is_zero_oid $sha1_dst
865 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
867 100644 | 100755 | 120000)
868 sha1_dst=$(git hash-object $name)
874 eval_gettextln "unexpected mode \$mod_dst" >&2
881 test $mod_src = 160000 &&
882 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
885 test $mod_dst = 160000 &&
886 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
889 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
892 case "$missing_src,$missing_dst" in
894 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
897 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
900 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
905 if test $mod_src = 160000 && test $mod_dst = 160000
907 range="$sha1_src...$sha1_dst"
908 elif test $mod_src = 160000
914 GIT_DIR="$name/.git" \
915 git rev-list --first-parent $range -- | wc -l
917 total_commits=" ($(($total_commits + 0)))"
921 sha1_abbr_src=$(GIT_DIR="$name/.git" git rev-parse --short $sha1_src 2>/dev/null ||
922 echo $sha1_src | cut -c1-7)
923 sha1_abbr_dst=$(GIT_DIR="$name/.git" git rev-parse --short $sha1_dst 2>/dev/null ||
924 echo $sha1_dst | cut -c1-7)
928 blob="$(gettext "blob")"
929 submodule="$(gettext "submodule")"
930 if test $mod_dst = 160000
932 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
934 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
937 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
941 # Don't give error msg for modification whose dst is not submodule
942 # i.e. deleted or changed to blob
943 test $mod_dst = 160000 && echo "$errmsg"
945 if test $mod_src = 160000 && test $mod_dst = 160000
948 test $summary_limit -gt 0 && limit="-$summary_limit"
949 GIT_DIR="$name/.git" \
950 git log $limit --pretty='format: %m %s' \
951 --first-parent $sha1_src...$sha1_dst
952 elif test $mod_dst = 160000
954 GIT_DIR="$name/.git" \
955 git log --pretty='format: > %s' -1 $sha1_dst
957 GIT_DIR="$name/.git" \
958 git log --pretty='format: < %s' -1 $sha1_src
966 # List all submodules, prefixed with:
967 # - submodule not initialized
968 # + different revision checked out
970 # If --cached was specified the revision in the index will be printed
971 # instead of the currently checked out revision.
973 # $@ = requested paths (default to all)
977 # parse $args after "submodule ... status".
1004 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
1007 # Sync remote urls for submodules
1008 # This makes the value for remote.$remote.url match the value
1009 # specified in .gitmodules.
1037 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
1042 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
1045 # This loop parses the command line arguments to find the
1046 # subcommand name to dispatch. Parsing of the subcommand specific
1047 # options are primarily done by the subcommand implementations.
1048 # Subcommand specific options such as --branch and --cached are
1049 # parsed here as well, for backward compatibility.
1051 while test $# != 0 && test -z "$command"
1054 add | foreach | init | deinit | update | set-branch | status | summary | sync | absorbgitdirs)
1084 # No command word defaults to "status"
1085 if test -z "$command"
1095 # "-b branch" is accepted only by "add" and "set-branch"
1096 if test -n "$branch" && (test "$command" != add || test "$command" != set-branch)
1101 # "--cached" is accepted only by "status" and "summary"
1102 if test -n "$cached" && test "$command" != status && test "$command" != summary
1107 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"