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 # Sanitize the local git environment for use within a submodule. We
86 # can't simply use clear_local_git_env since we want to preserve some
87 # of the settings from GIT_CONFIG_PARAMETERS.
88 sanitize_submodule_env()
90 save_config=$GIT_CONFIG_PARAMETERS
92 GIT_CONFIG_PARAMETERS=$save_config
93 export GIT_CONFIG_PARAMETERS
97 # Add a new submodule to the working tree, .gitmodules and the index
101 # optional branch is stored in global branch variable
105 # parse $args after "submodule ... add".
111 case "$2" in '') usage ;; esac
122 case "$2" in '') usage ;; esac
127 reference_path="${1#--reference=}"
130 case "$2" in '') usage ;; esac
135 case "$2" in '') usage ;; esac
156 if test -n "$reference_path"
158 is_absolute_path "$reference_path" ||
159 reference_path="$wt_prefix$reference_path"
161 reference="--reference=$reference_path"
167 if test -z "$sm_path"; then
168 sm_path=$(printf '%s\n' "$repo" |
169 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
172 if test -z "$repo" || test -z "$sm_path"; then
176 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
178 # assure repo is absolute or relative to parent
181 test -z "$wt_prefix" ||
182 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
184 # dereference source url relative to parent's url
185 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
192 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
197 # multiple //; leading ./; /./; /../; trailing /
198 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 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
214 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
217 if test -z "$force" &&
218 ! git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev/null 2>&1
220 eval_gettextln "The following path is ignored by one of your .gitignore files:
222 Use -f if you really want to add it." >&2
226 if test -n "$custom_name"
228 sm_name="$custom_name"
233 if ! git submodule--helper check-name "$sm_name"
235 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
238 # perhaps the path exists and is already a git repo, else clone it
239 if test -e "$sm_path"
241 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
243 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
245 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
249 if test -d ".git/modules/$sm_name"
253 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
254 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
255 die "$(eval_gettextln "\
256 If you want to reuse this local git directory instead of cloning again from
258 use the '--force' option. If the local git directory is not the correct repo
259 or you are unsure what this means choose another name with the '--name' option.")"
261 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
264 git submodule--helper clone ${GIT_QUIET:+--quiet} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${depth:+"$depth"} || exit
266 sanitize_submodule_env
268 # ash fails to wordsplit ${branch:+-b "$branch"...}
270 '') git checkout -f -q ;;
271 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
273 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
275 git config submodule."$sm_name".url "$realrepo"
277 git add --no-warn-embedded-repo $force "$sm_path" ||
278 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
280 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
281 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
284 git config -f .gitmodules submodule."$sm_name".branch "$branch"
286 git add --force .gitmodules ||
287 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
289 # NEEDSWORK: In a multi-working-tree world, this needs to be
290 # set in the per-worktree config.
291 if git config --get submodule.active >/dev/null
293 # If the submodule being adding isn't already covered by the
294 # current configured pathspec, set the submodule's active flag
295 if ! git submodule--helper is-active "$sm_path"
297 git config submodule."$sm_name".active "true"
300 git config submodule."$sm_name".active "true"
305 # Execute an arbitrary command sequence in each checked out
308 # $@ = command to execute
312 # parse $args after "submodule ... foreach".
334 # dup stdin so that it can be restored when running the external
335 # command in the subshell (and a recursive call to this function)
339 git submodule--helper list --prefix "$wt_prefix" ||
342 while read -r mode sha1 stage sm_path
344 die_if_unmatched "$mode" "$sha1"
345 if test -e "$sm_path"/.git
347 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
348 say "$(eval_gettext "Entering '\$displaypath'")"
349 name=$(git submodule--helper name "$sm_path")
351 prefix="$prefix$sm_path/"
352 sanitize_submodule_env
354 sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") &&
355 # we make $path available to scripts ...
363 if test -n "$recursive"
365 cmd_foreach "--recursive" "$@"
368 die "$(eval_gettext "Stopping at '\$displaypath'; script returned non-zero status.")"
374 # Register submodules in .git/config
376 # $@ = requested paths (default to all)
380 # parse $args after "submodule ... init".
401 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} "$@"
405 # Unregister submodules from .git/config and remove their work tree
409 # parse $args after "submodule ... deinit".
437 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
440 is_tip_reachable () (
441 sanitize_submodule_env &&
443 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
447 fetch_in_submodule () (
448 sanitize_submodule_env &&
455 git fetch $(get_default_remote) "$@" ;;
460 # Update each submodule path to correct revision, using clone and checkout as needed
462 # $@ = requested paths (default to all)
466 # parse $args after "submodule ... update".
474 progress="--progress"
496 case "$2" in '') usage ;; esac
497 reference="--reference=$2"
513 recommend_shallow="--recommend-shallow"
515 --no-recommend-shallow)
516 recommend_shallow="--no-recommend-shallow"
519 case "$2" in '') usage ;; esac
527 case "$2" in '') usage ;; esac
550 cmd_init "--" "$@" || return
554 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
555 ${progress:+"$progress"} \
556 ${wt_prefix:+--prefix "$wt_prefix"} \
557 ${prefix:+--recursive-prefix "$prefix"} \
558 ${update:+--update "$update"} \
559 ${reference:+"$reference"} \
560 ${depth:+--depth "$depth"} \
561 ${require_init:+--require-init} \
562 ${recommend_shallow:+"$recommend_shallow"} \
564 "$@" || echo "#unmatched" $?
567 while read -r mode sha1 stage just_cloned sm_path
569 die_if_unmatched "$mode" "$sha1"
571 name=$(git submodule--helper name "$sm_path") || exit
572 if ! test -z "$update"
574 update_module=$update
576 update_module=$(git config submodule."$name".update)
577 if test -z "$update_module"
579 update_module="checkout"
583 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
585 if test $just_cloned -eq 1
588 case "$update_module" in
589 merge | rebase | none)
590 update_module=checkout ;;
593 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
594 git rev-parse --verify HEAD) ||
595 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
600 branch=$(git submodule--helper remote-branch "$sm_path")
601 if test -z "$nofetch"
603 # Fetch remote before determining tracking $sha1
604 fetch_in_submodule "$sm_path" $depth ||
605 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
607 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
608 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
609 git rev-parse --verify "${remote_name}/${branch}") ||
610 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
613 if test "$subsha1" != "$sha1" || test -n "$force"
616 # If we don't already have a -f flag and the submodule has never been checked out
617 if test -z "$subsha1" && test -z "$force"
622 if test -z "$nofetch"
624 # Run fetch only if $sha1 isn't present or it
625 # is not reachable from a ref.
626 is_tip_reachable "$sm_path" "$sha1" ||
627 fetch_in_submodule "$sm_path" $depth ||
628 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
630 # Now we tried the usual fetch, but $sha1 may
631 # not be reachable from any of the refs
632 is_tip_reachable "$sm_path" "$sha1" ||
633 fetch_in_submodule "$sm_path" $depth "$sha1" ||
634 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
638 case "$update_module" in
640 command="git checkout $subforce -q"
641 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
642 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
646 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
647 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
648 must_die_on_failure=yes
652 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
653 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
654 must_die_on_failure=yes
657 command="${update_module#!}"
658 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
659 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
660 must_die_on_failure=yes
663 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
666 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
669 elif test -n "$must_die_on_failure"
671 die_with_status 2 "$die_msg"
673 err="${err};$die_msg"
678 if test -n "$recursive"
681 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
683 sanitize_submodule_env
690 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
693 err="${err};$die_msg"
696 die_with_status $res "$die_msg"
720 # Show commit summary for submodules in index or working tree
722 # If '--cached' is given, show summary between index and given commit,
723 # or between working tree and given commit
725 # $@ = [commit (default 'HEAD'),] requested paths (default all)
732 # parse $args after "submodule ... summary".
747 isnumber "$summary_limit" || usage
751 summary_limit="${1#--summary-limit=}"
752 isnumber "$summary_limit" || usage
768 test $summary_limit = 0 && return
770 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
774 elif test -z "$1" || test "$1" = "HEAD"
776 # before the first commit: compare with an empty tree
777 head=$(git hash-object -w -t tree --stdin </dev/null)
778 test -z "$1" || shift
786 die "$(gettext "The --cached option cannot be used with the --files option")"
792 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
793 # Get modified modules cared by user
794 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
795 sane_egrep '^:([0-7]* )?160000' |
796 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
798 # Always show modules deleted or type-changed (blob<->module)
799 if test "$status" = D || test "$status" = T
801 printf '%s\n' "$sm_path"
804 # Respect the ignore setting for --for-status.
805 if test -n "$for_status"
807 name=$(git submodule--helper name "$sm_path")
808 ignore_config=$(get_submodule_config "$name" ignore none)
809 test $status != A && test $ignore_config = all && continue
811 # Also show added or modified modules which are checked out
812 GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
813 printf '%s\n' "$sm_path"
817 test -z "$modules" && return
819 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
820 sane_egrep '^:([0-7]* )?160000' |
822 while read -r mod_src mod_dst sha1_src sha1_dst status name
824 if test -z "$cached" &&
825 test $sha1_dst = 0000000000000000000000000000000000000000
829 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
831 100644 | 100755 | 120000)
832 sha1_dst=$(git hash-object $name)
838 eval_gettextln "unexpected mode \$mod_dst" >&2
845 test $mod_src = 160000 &&
846 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
849 test $mod_dst = 160000 &&
850 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
853 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
856 case "$missing_src,$missing_dst" in
858 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
861 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
864 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
869 if test $mod_src = 160000 && test $mod_dst = 160000
871 range="$sha1_src...$sha1_dst"
872 elif test $mod_src = 160000
878 GIT_DIR="$name/.git" \
879 git rev-list --first-parent $range -- | wc -l
881 total_commits=" ($(($total_commits + 0)))"
885 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
886 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
889 blob="$(gettext "blob")"
890 submodule="$(gettext "submodule")"
891 if test $mod_dst = 160000
893 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
895 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
898 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
902 # Don't give error msg for modification whose dst is not submodule
903 # i.e. deleted or changed to blob
904 test $mod_dst = 160000 && echo "$errmsg"
906 if test $mod_src = 160000 && test $mod_dst = 160000
909 test $summary_limit -gt 0 && limit="-$summary_limit"
910 GIT_DIR="$name/.git" \
911 git log $limit --pretty='format: %m %s' \
912 --first-parent $sha1_src...$sha1_dst
913 elif test $mod_dst = 160000
915 GIT_DIR="$name/.git" \
916 git log --pretty='format: > %s' -1 $sha1_dst
918 GIT_DIR="$name/.git" \
919 git log --pretty='format: < %s' -1 $sha1_src
927 # List all submodules, prefixed with:
928 # - submodule not initialized
929 # + different revision checked out
931 # If --cached was specified the revision in the index will be printed
932 # instead of the currently checked out revision.
934 # $@ = requested paths (default to all)
938 # parse $args after "submodule ... status".
965 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
968 # Sync remote urls for submodules
969 # This makes the value for remote.$remote.url match the value
970 # specified in .gitmodules.
998 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
1003 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
1006 # This loop parses the command line arguments to find the
1007 # subcommand name to dispatch. Parsing of the subcommand specific
1008 # options are primarily done by the subcommand implementations.
1009 # Subcommand specific options such as --branch and --cached are
1010 # parsed here as well, for backward compatibility.
1012 while test $# != 0 && test -z "$command"
1015 add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
1045 # No command word defaults to "status"
1046 if test -z "$command"
1056 # "-b branch" is accepted only by "add"
1057 if test -n "$branch" && test "$command" != add
1062 # "--cached" is accepted only by "status" and "summary"
1063 if test -n "$cached" && test "$command" != status && test "$command" != summary