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
49 if test "$1" = "#unmatched"
56 # Print a submodule configuration setting
62 # Checks in the usual git-config places first (for overrides),
63 # otherwise it falls back on .gitmodules. This allows you to
64 # distribute project-wide defaults in .gitmodules, while still
65 # customizing individual repositories if necessary. If the option is
66 # not in .gitmodules either, print a default value.
68 get_submodule_config () {
72 value=$(git config submodule."$name"."$option")
75 value=$(git submodule--helper config submodule."$name"."$option")
77 printf '%s' "${value:-$default}"
82 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
85 # Given a full hex object ID, is this the zero OID?
87 echo "$1" | sane_egrep '^0+$' >/dev/null 2>&1
90 # Sanitize the local git environment for use within a submodule. We
91 # can't simply use clear_local_git_env since we want to preserve some
92 # of the settings from GIT_CONFIG_PARAMETERS.
93 sanitize_submodule_env()
95 save_config=$GIT_CONFIG_PARAMETERS
97 GIT_CONFIG_PARAMETERS=$save_config
98 export GIT_CONFIG_PARAMETERS
102 # Add a new submodule to the working tree, .gitmodules and the index
106 # optional branch is stored in global branch variable
110 # parse $args after "submodule ... add".
116 case "$2" in '') usage ;; esac
130 case "$2" in '') usage ;; esac
135 reference_path="${1#--reference=}"
141 case "$2" in '') usage ;; esac
146 case "$2" in '') usage ;; esac
167 if ! git submodule--helper config --check-writeable >/dev/null 2>&1
169 die "$(eval_gettext "please make sure that the .gitmodules file is in the working tree")"
172 if test -n "$reference_path"
174 is_absolute_path "$reference_path" ||
175 reference_path="$wt_prefix$reference_path"
177 reference="--reference=$reference_path"
183 if test -z "$sm_path"; then
184 sm_path=$(printf '%s\n' "$repo" |
185 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
188 if test -z "$repo" || test -z "$sm_path"; then
192 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
194 # assure repo is absolute or relative to parent
197 test -z "$wt_prefix" ||
198 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
200 # dereference source url relative to parent's url
201 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
208 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
213 # multiple //; leading ./; /./; /../; trailing /
214 sm_path=$(printf '%s/\n' "$sm_path" |
226 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
227 die "$(eval_gettext "'\$sm_path' already exists in the index")"
229 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
230 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
233 if test -z "$force" &&
234 ! git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev/null 2>&1
236 eval_gettextln "The following path is ignored by one of your .gitignore files:
238 Use -f if you really want to add it." >&2
242 if test -n "$custom_name"
244 sm_name="$custom_name"
249 if ! git submodule--helper check-name "$sm_name"
251 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
254 # perhaps the path exists and is already a git repo, else clone it
255 if test -e "$sm_path"
257 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
259 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
261 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
265 if test -d ".git/modules/$sm_name"
269 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
270 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
271 die "$(eval_gettextln "\
272 If you want to reuse this local git directory instead of cloning again from
274 use the '--force' option. If the local git directory is not the correct repo
275 or you are unsure what this means choose another name with the '--name' option.")"
277 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
280 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
282 sanitize_submodule_env
284 # ash fails to wordsplit ${branch:+-b "$branch"...}
286 '') git checkout -f -q ;;
287 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
289 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
291 git config submodule."$sm_name".url "$realrepo"
293 git add --no-warn-embedded-repo $force "$sm_path" ||
294 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
296 git submodule--helper config submodule."$sm_name".path "$sm_path" &&
297 git submodule--helper config submodule."$sm_name".url "$repo" &&
300 git submodule--helper config submodule."$sm_name".branch "$branch"
302 git add --force .gitmodules ||
303 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
305 # NEEDSWORK: In a multi-working-tree world, this needs to be
306 # set in the per-worktree config.
307 if git config --get submodule.active >/dev/null
309 # If the submodule being adding isn't already covered by the
310 # current configured pathspec, set the submodule's active flag
311 if ! git submodule--helper is-active "$sm_path"
313 git config submodule."$sm_name".active "true"
316 git config submodule."$sm_name".active "true"
321 # Execute an arbitrary command sequence in each checked out
324 # $@ = command to execute
328 # parse $args after "submodule ... foreach".
348 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
352 # Register submodules in .git/config
354 # $@ = requested paths (default to all)
358 # parse $args after "submodule ... init".
379 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} "$@"
383 # Unregister submodules from .git/config and remove their work tree
387 # parse $args after "submodule ... deinit".
415 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
418 is_tip_reachable () (
419 sanitize_submodule_env &&
421 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
425 fetch_in_submodule () (
426 sanitize_submodule_env &&
433 git fetch $(get_default_remote) "$@" ;;
438 # Update each submodule path to correct revision, using clone and checkout as needed
440 # $@ = requested paths (default to all)
444 # parse $args after "submodule ... update".
473 case "$2" in '') usage ;; esac
474 reference="--reference=$2"
493 recommend_shallow="--recommend-shallow"
495 --no-recommend-shallow)
496 recommend_shallow="--no-recommend-shallow"
499 case "$2" in '') usage ;; esac
507 case "$2" in '') usage ;; esac
530 cmd_init "--" "$@" || return
534 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
535 ${progress:+"--progress"} \
536 ${wt_prefix:+--prefix "$wt_prefix"} \
537 ${prefix:+--recursive-prefix "$prefix"} \
538 ${update:+--update "$update"} \
539 ${reference:+"$reference"} \
540 ${dissociate:+"--dissociate"} \
541 ${depth:+--depth "$depth"} \
544 "$@" || echo "#unmatched" $?
547 while read -r quickabort sha1 just_cloned sm_path
549 die_if_unmatched "$quickabort" "$sha1"
551 git submodule--helper ensure-core-worktree "$sm_path"
553 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
555 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
557 if test $just_cloned -eq 1
561 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
562 git rev-parse --verify HEAD) ||
563 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
568 branch=$(git submodule--helper remote-branch "$sm_path")
569 if test -z "$nofetch"
571 # Fetch remote before determining tracking $sha1
572 fetch_in_submodule "$sm_path" $depth ||
573 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
575 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
576 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
577 git rev-parse --verify "${remote_name}/${branch}") ||
578 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
581 if test "$subsha1" != "$sha1" || test -n "$force"
584 # If we don't already have a -f flag and the submodule has never been checked out
585 if test -z "$subsha1" && test -z "$force"
590 if test -z "$nofetch"
592 # Run fetch only if $sha1 isn't present or it
593 # is not reachable from a ref.
594 is_tip_reachable "$sm_path" "$sha1" ||
595 fetch_in_submodule "$sm_path" $depth ||
596 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
598 # Now we tried the usual fetch, but $sha1 may
599 # not be reachable from any of the refs
600 is_tip_reachable "$sm_path" "$sha1" ||
601 fetch_in_submodule "$sm_path" $depth "$sha1" ||
602 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
606 case "$update_module" in
608 command="git checkout $subforce -q"
609 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
610 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
614 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
615 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
616 must_die_on_failure=yes
620 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
621 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
622 must_die_on_failure=yes
625 command="${update_module#!}"
626 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
627 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
628 must_die_on_failure=yes
631 die "$(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
634 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
637 elif test -n "$must_die_on_failure"
639 die_with_status 2 "$die_msg"
641 err="${err};$die_msg"
646 if test -n "$recursive"
649 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
651 sanitize_submodule_env
658 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
661 err="${err};$die_msg"
664 die_with_status $res "$die_msg"
688 # Show commit summary for submodules in index or working tree
690 # If '--cached' is given, show summary between index and given commit,
691 # or between working tree and given commit
693 # $@ = [commit (default 'HEAD'),] requested paths (default all)
700 # parse $args after "submodule ... summary".
715 isnumber "$summary_limit" || usage
719 summary_limit="${1#--summary-limit=}"
720 isnumber "$summary_limit" || usage
736 test $summary_limit = 0 && return
738 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
742 elif test -z "$1" || test "$1" = "HEAD"
744 # before the first commit: compare with an empty tree
745 head=$(git hash-object -w -t tree --stdin </dev/null)
746 test -z "$1" || shift
754 die "$(gettext "The --cached option cannot be used with the --files option")"
760 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
761 # Get modified modules cared by user
762 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
763 sane_egrep '^:([0-7]* )?160000' |
764 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
766 # Always show modules deleted or type-changed (blob<->module)
767 if test "$status" = D || test "$status" = T
769 printf '%s\n' "$sm_path"
772 # Respect the ignore setting for --for-status.
773 if test -n "$for_status"
775 name=$(git submodule--helper name "$sm_path")
776 ignore_config=$(get_submodule_config "$name" ignore none)
777 test $status != A && test $ignore_config = all && continue
779 # Also show added or modified modules which are checked out
780 GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
781 printf '%s\n' "$sm_path"
785 test -z "$modules" && return
787 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
788 sane_egrep '^:([0-7]* )?160000' |
790 while read -r mod_src mod_dst sha1_src sha1_dst status name
792 if test -z "$cached" &&
793 is_zero_oid $sha1_dst
797 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
799 100644 | 100755 | 120000)
800 sha1_dst=$(git hash-object $name)
806 eval_gettextln "unexpected mode \$mod_dst" >&2
813 test $mod_src = 160000 &&
814 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
817 test $mod_dst = 160000 &&
818 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
821 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
824 case "$missing_src,$missing_dst" in
826 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
829 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
832 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
837 if test $mod_src = 160000 && test $mod_dst = 160000
839 range="$sha1_src...$sha1_dst"
840 elif test $mod_src = 160000
846 GIT_DIR="$name/.git" \
847 git rev-list --first-parent $range -- | wc -l
849 total_commits=" ($(($total_commits + 0)))"
853 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
854 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
857 blob="$(gettext "blob")"
858 submodule="$(gettext "submodule")"
859 if test $mod_dst = 160000
861 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
863 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
866 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
870 # Don't give error msg for modification whose dst is not submodule
871 # i.e. deleted or changed to blob
872 test $mod_dst = 160000 && echo "$errmsg"
874 if test $mod_src = 160000 && test $mod_dst = 160000
877 test $summary_limit -gt 0 && limit="-$summary_limit"
878 GIT_DIR="$name/.git" \
879 git log $limit --pretty='format: %m %s' \
880 --first-parent $sha1_src...$sha1_dst
881 elif test $mod_dst = 160000
883 GIT_DIR="$name/.git" \
884 git log --pretty='format: > %s' -1 $sha1_dst
886 GIT_DIR="$name/.git" \
887 git log --pretty='format: < %s' -1 $sha1_src
895 # List all submodules, prefixed with:
896 # - submodule not initialized
897 # + different revision checked out
899 # If --cached was specified the revision in the index will be printed
900 # instead of the currently checked out revision.
902 # $@ = requested paths (default to all)
906 # parse $args after "submodule ... status".
933 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
936 # Sync remote urls for submodules
937 # This makes the value for remote.$remote.url match the value
938 # specified in .gitmodules.
966 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
971 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
974 # This loop parses the command line arguments to find the
975 # subcommand name to dispatch. Parsing of the subcommand specific
976 # options are primarily done by the subcommand implementations.
977 # Subcommand specific options such as --branch and --cached are
978 # parsed here as well, for backward compatibility.
980 while test $# != 0 && test -z "$command"
983 add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
1013 # No command word defaults to "status"
1014 if test -z "$command"
1024 # "-b branch" is accepted only by "add"
1025 if test -n "$branch" && test "$command" != add
1030 # "--cached" is accepted only by "status" and "summary"
1031 if test -n "$cached" && test "$command" != status && test "$command" != summary