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 config -f .gitmodules 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 test -n "$reference_path"
169 is_absolute_path "$reference_path" ||
170 reference_path="$wt_prefix$reference_path"
172 reference="--reference=$reference_path"
178 if test -z "$sm_path"; then
179 sm_path=$(printf '%s\n' "$repo" |
180 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
183 if test -z "$repo" || test -z "$sm_path"; then
187 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
189 # assure repo is absolute or relative to parent
192 test -z "$wt_prefix" ||
193 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
195 # dereference source url relative to parent's url
196 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
203 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
208 # multiple //; leading ./; /./; /../; trailing /
209 sm_path=$(printf '%s/\n' "$sm_path" |
221 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
222 die "$(eval_gettext "'\$sm_path' already exists in the index")"
224 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
225 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
228 if test -z "$force" &&
229 ! git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev/null 2>&1
231 eval_gettextln "The following path is ignored by one of your .gitignore files:
233 Use -f if you really want to add it." >&2
237 if test -n "$custom_name"
239 sm_name="$custom_name"
244 if ! git submodule--helper check-name "$sm_name"
246 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
249 # perhaps the path exists and is already a git repo, else clone it
250 if test -e "$sm_path"
252 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
254 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
256 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
260 if test -d ".git/modules/$sm_name"
264 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
265 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
266 die "$(eval_gettextln "\
267 If you want to reuse this local git directory instead of cloning again from
269 use the '--force' option. If the local git directory is not the correct repo
270 or you are unsure what this means choose another name with the '--name' option.")"
272 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
275 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
277 sanitize_submodule_env
279 # ash fails to wordsplit ${branch:+-b "$branch"...}
281 '') git checkout -f -q ;;
282 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
284 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
286 git config submodule."$sm_name".url "$realrepo"
288 git add --no-warn-embedded-repo $force "$sm_path" ||
289 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
291 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
292 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
295 git config -f .gitmodules submodule."$sm_name".branch "$branch"
297 git add --force .gitmodules ||
298 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
300 # NEEDSWORK: In a multi-working-tree world, this needs to be
301 # set in the per-worktree config.
302 if git config --get submodule.active >/dev/null
304 # If the submodule being adding isn't already covered by the
305 # current configured pathspec, set the submodule's active flag
306 if ! git submodule--helper is-active "$sm_path"
308 git config submodule."$sm_name".active "true"
311 git config submodule."$sm_name".active "true"
316 # Execute an arbitrary command sequence in each checked out
319 # $@ = command to execute
323 # parse $args after "submodule ... foreach".
343 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
347 # Register submodules in .git/config
349 # $@ = requested paths (default to all)
353 # parse $args after "submodule ... init".
374 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} "$@"
378 # Unregister submodules from .git/config and remove their work tree
382 # parse $args after "submodule ... deinit".
410 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
413 is_tip_reachable () (
414 sanitize_submodule_env &&
416 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
420 fetch_in_submodule () (
421 sanitize_submodule_env &&
428 git fetch $(get_default_remote) "$@" ;;
433 # Update each submodule path to correct revision, using clone and checkout as needed
435 # $@ = requested paths (default to all)
439 # parse $args after "submodule ... update".
468 case "$2" in '') usage ;; esac
469 reference="--reference=$2"
488 recommend_shallow="--recommend-shallow"
490 --no-recommend-shallow)
491 recommend_shallow="--no-recommend-shallow"
494 case "$2" in '') usage ;; esac
502 case "$2" in '') usage ;; esac
525 cmd_init "--" "$@" || return
529 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
530 ${progress:+"--progress"} \
531 ${wt_prefix:+--prefix "$wt_prefix"} \
532 ${prefix:+--recursive-prefix "$prefix"} \
533 ${update:+--update "$update"} \
534 ${reference:+"$reference"} \
535 ${dissociate:+"--dissociate"} \
536 ${depth:+--depth "$depth"} \
539 "$@" || echo "#unmatched" $?
542 while read -r quickabort sha1 just_cloned sm_path
544 die_if_unmatched "$quickabort" "$sha1"
546 git submodule--helper ensure-core-worktree "$sm_path"
548 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
550 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
552 if test $just_cloned -eq 1
556 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
557 git rev-parse --verify HEAD) ||
558 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
563 branch=$(git submodule--helper remote-branch "$sm_path")
564 if test -z "$nofetch"
566 # Fetch remote before determining tracking $sha1
567 fetch_in_submodule "$sm_path" $depth ||
568 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
570 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
571 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
572 git rev-parse --verify "${remote_name}/${branch}") ||
573 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
576 if test "$subsha1" != "$sha1" || test -n "$force"
579 # If we don't already have a -f flag and the submodule has never been checked out
580 if test -z "$subsha1" && test -z "$force"
585 if test -z "$nofetch"
587 # Run fetch only if $sha1 isn't present or it
588 # is not reachable from a ref.
589 is_tip_reachable "$sm_path" "$sha1" ||
590 fetch_in_submodule "$sm_path" $depth ||
591 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
593 # Now we tried the usual fetch, but $sha1 may
594 # not be reachable from any of the refs
595 is_tip_reachable "$sm_path" "$sha1" ||
596 fetch_in_submodule "$sm_path" $depth "$sha1" ||
597 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
601 case "$update_module" in
603 command="git checkout $subforce -q"
604 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
605 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
609 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
610 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
611 must_die_on_failure=yes
615 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
616 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
617 must_die_on_failure=yes
620 command="${update_module#!}"
621 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
622 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
623 must_die_on_failure=yes
626 die "$(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
629 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
632 elif test -n "$must_die_on_failure"
634 die_with_status 2 "$die_msg"
636 err="${err};$die_msg"
641 if test -n "$recursive"
644 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
646 sanitize_submodule_env
653 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
656 err="${err};$die_msg"
659 die_with_status $res "$die_msg"
683 # Show commit summary for submodules in index or working tree
685 # If '--cached' is given, show summary between index and given commit,
686 # or between working tree and given commit
688 # $@ = [commit (default 'HEAD'),] requested paths (default all)
695 # parse $args after "submodule ... summary".
710 isnumber "$summary_limit" || usage
714 summary_limit="${1#--summary-limit=}"
715 isnumber "$summary_limit" || usage
731 test $summary_limit = 0 && return
733 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
737 elif test -z "$1" || test "$1" = "HEAD"
739 # before the first commit: compare with an empty tree
740 head=$(git hash-object -w -t tree --stdin </dev/null)
741 test -z "$1" || shift
749 die "$(gettext "The --cached option cannot be used with the --files option")"
755 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
756 # Get modified modules cared by user
757 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
758 sane_egrep '^:([0-7]* )?160000' |
759 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
761 # Always show modules deleted or type-changed (blob<->module)
762 if test "$status" = D || test "$status" = T
764 printf '%s\n' "$sm_path"
767 # Respect the ignore setting for --for-status.
768 if test -n "$for_status"
770 name=$(git submodule--helper name "$sm_path")
771 ignore_config=$(get_submodule_config "$name" ignore none)
772 test $status != A && test $ignore_config = all && continue
774 # Also show added or modified modules which are checked out
775 GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
776 printf '%s\n' "$sm_path"
780 test -z "$modules" && return
782 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
783 sane_egrep '^:([0-7]* )?160000' |
785 while read -r mod_src mod_dst sha1_src sha1_dst status name
787 if test -z "$cached" &&
788 is_zero_oid $sha1_dst
792 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
794 100644 | 100755 | 120000)
795 sha1_dst=$(git hash-object $name)
801 eval_gettextln "unexpected mode \$mod_dst" >&2
808 test $mod_src = 160000 &&
809 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
812 test $mod_dst = 160000 &&
813 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
816 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
819 case "$missing_src,$missing_dst" in
821 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
824 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
827 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
832 if test $mod_src = 160000 && test $mod_dst = 160000
834 range="$sha1_src...$sha1_dst"
835 elif test $mod_src = 160000
841 GIT_DIR="$name/.git" \
842 git rev-list --first-parent $range -- | wc -l
844 total_commits=" ($(($total_commits + 0)))"
848 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
849 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
852 blob="$(gettext "blob")"
853 submodule="$(gettext "submodule")"
854 if test $mod_dst = 160000
856 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
858 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
861 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
865 # Don't give error msg for modification whose dst is not submodule
866 # i.e. deleted or changed to blob
867 test $mod_dst = 160000 && echo "$errmsg"
869 if test $mod_src = 160000 && test $mod_dst = 160000
872 test $summary_limit -gt 0 && limit="-$summary_limit"
873 GIT_DIR="$name/.git" \
874 git log $limit --pretty='format: %m %s' \
875 --first-parent $sha1_src...$sha1_dst
876 elif test $mod_dst = 160000
878 GIT_DIR="$name/.git" \
879 git log --pretty='format: > %s' -1 $sha1_dst
881 GIT_DIR="$name/.git" \
882 git log --pretty='format: < %s' -1 $sha1_src
890 # List all submodules, prefixed with:
891 # - submodule not initialized
892 # + different revision checked out
894 # If --cached was specified the revision in the index will be printed
895 # instead of the currently checked out revision.
897 # $@ = requested paths (default to all)
901 # parse $args after "submodule ... status".
928 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
931 # Sync remote urls for submodules
932 # This makes the value for remote.$remote.url match the value
933 # specified in .gitmodules.
961 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
966 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
969 # This loop parses the command line arguments to find the
970 # subcommand name to dispatch. Parsing of the subcommand specific
971 # options are primarily done by the subcommand implementations.
972 # Subcommand specific options such as --branch and --cached are
973 # parsed here as well, for backward compatibility.
975 while test $# != 0 && test -z "$command"
978 add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
1008 # No command word defaults to "status"
1009 if test -z "$command"
1019 # "-b branch" is accepted only by "add"
1020 if test -n "$branch" && test "$command" != add
1025 # "--cached" is accepted only by "status" and "summary"
1026 if test -n "$cached" && test "$command" != status && test "$command" != summary