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
50 if test "$1" = "#unmatched"
57 # Print a submodule configuration setting
63 # Checks in the usual git-config places first (for overrides),
64 # otherwise it falls back on .gitmodules. This allows you to
65 # distribute project-wide defaults in .gitmodules, while still
66 # customizing individual repositories if necessary. If the option is
67 # not in .gitmodules either, print a default value.
69 get_submodule_config () {
73 value=$(git config submodule."$name"."$option")
76 value=$(git config -f .gitmodules submodule."$name"."$option")
78 printf '%s' "${value:-$default}"
83 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
86 # Sanitize the local git environment for use within a submodule. We
87 # can't simply use clear_local_git_env since we want to preserve some
88 # of the settings from GIT_CONFIG_PARAMETERS.
89 sanitize_submodule_env()
91 save_config=$GIT_CONFIG_PARAMETERS
93 GIT_CONFIG_PARAMETERS=$save_config
94 export GIT_CONFIG_PARAMETERS
98 # Add a new submodule to the working tree, .gitmodules and the index
102 # optional branch is stored in global branch variable
106 # parse $args after "submodule ... add".
112 case "$2" in '') usage ;; esac
126 case "$2" in '') usage ;; esac
131 reference_path="${1#--reference=}"
137 case "$2" in '') usage ;; esac
142 case "$2" in '') usage ;; esac
163 if test -n "$reference_path"
165 is_absolute_path "$reference_path" ||
166 reference_path="$wt_prefix$reference_path"
168 reference="--reference=$reference_path"
174 if test -z "$sm_path"; then
175 sm_path=$(printf '%s\n' "$repo" |
176 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
179 if test -z "$repo" || test -z "$sm_path"; then
183 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
185 # assure repo is absolute or relative to parent
188 test -z "$wt_prefix" ||
189 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
191 # dereference source url relative to parent's url
192 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
199 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
204 # multiple //; leading ./; /./; /../; trailing /
205 sm_path=$(printf '%s/\n' "$sm_path" |
217 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
218 die "$(eval_gettext "'\$sm_path' already exists in the index")"
220 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
221 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
224 if test -z "$force" &&
225 ! git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev/null 2>&1
227 eval_gettextln "The following path is ignored by one of your .gitignore files:
229 Use -f if you really want to add it." >&2
233 if test -n "$custom_name"
235 sm_name="$custom_name"
240 if ! git submodule--helper check-name "$sm_name"
242 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
245 # perhaps the path exists and is already a git repo, else clone it
246 if test -e "$sm_path"
248 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
250 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
252 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
256 if test -d ".git/modules/$sm_name"
260 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
261 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
262 die "$(eval_gettextln "\
263 If you want to reuse this local git directory instead of cloning again from
265 use the '--force' option. If the local git directory is not the correct repo
266 or you are unsure what this means choose another name with the '--name' option.")"
268 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
271 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
273 sanitize_submodule_env
275 # ash fails to wordsplit ${branch:+-b "$branch"...}
277 '') git checkout -f -q ;;
278 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
280 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
282 git config submodule."$sm_name".url "$realrepo"
284 git add --no-warn-embedded-repo $force "$sm_path" ||
285 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
287 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
288 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
291 git config -f .gitmodules submodule."$sm_name".branch "$branch"
293 git add --force .gitmodules ||
294 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
296 # NEEDSWORK: In a multi-working-tree world, this needs to be
297 # set in the per-worktree config.
298 if git config --get submodule.active >/dev/null
300 # If the submodule being adding isn't already covered by the
301 # current configured pathspec, set the submodule's active flag
302 if ! git submodule--helper is-active "$sm_path"
304 git config submodule."$sm_name".active "true"
307 git config submodule."$sm_name".active "true"
312 # Execute an arbitrary command sequence in each checked out
315 # $@ = command to execute
319 # parse $args after "submodule ... foreach".
341 # dup stdin so that it can be restored when running the external
342 # command in the subshell (and a recursive call to this function)
346 git submodule--helper list --prefix "$wt_prefix" ||
349 while read -r mode sha1 stage sm_path
351 die_if_unmatched "$mode" "$sha1"
352 if test -e "$sm_path"/.git
354 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
355 say "$(eval_gettext "Entering '\$displaypath'")"
356 name=$(git submodule--helper name "$sm_path")
358 prefix="$prefix$sm_path/"
359 sanitize_submodule_env
361 sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") &&
362 # we make $path available to scripts ...
370 if test -n "$recursive"
372 cmd_foreach "--recursive" "$@"
375 die "$(eval_gettext "Stopping at '\$displaypath'; script returned non-zero status.")"
381 # Register submodules in .git/config
383 # $@ = requested paths (default to all)
387 # parse $args after "submodule ... init".
408 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} "$@"
412 # Unregister submodules from .git/config and remove their work tree
416 # parse $args after "submodule ... deinit".
444 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
447 is_tip_reachable () (
448 sanitize_submodule_env &&
450 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
454 fetch_in_submodule () (
455 sanitize_submodule_env &&
462 git fetch $(get_default_remote) "$@" ;;
467 # Update each submodule path to correct revision, using clone and checkout as needed
469 # $@ = requested paths (default to all)
473 # parse $args after "submodule ... update".
503 case "$2" in '') usage ;; esac
504 reference="--reference=$2"
523 recommend_shallow="--recommend-shallow"
525 --no-recommend-shallow)
526 recommend_shallow="--no-recommend-shallow"
529 case "$2" in '') usage ;; esac
537 case "$2" in '') usage ;; esac
560 cmd_init "--" "$@" || return
564 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
565 ${progress:+"--progress"} \
566 ${wt_prefix:+--prefix "$wt_prefix"} \
567 ${prefix:+--recursive-prefix "$prefix"} \
568 ${update:+--update "$update"} \
569 ${reference:+"$reference"} \
570 ${dissociate:+"--dissociate"} \
571 ${depth:+--depth "$depth"} \
572 ${require_init:+--require-init} \
575 "$@" || echo "#unmatched" $?
578 while read -r mode sha1 stage just_cloned sm_path
580 die_if_unmatched "$mode" "$sha1"
582 name=$(git submodule--helper name "$sm_path") || exit
583 if ! test -z "$update"
585 update_module=$update
587 update_module=$(git config submodule."$name".update)
588 if test -z "$update_module"
590 update_module="checkout"
594 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
596 if test $just_cloned -eq 1
599 case "$update_module" in
600 merge | rebase | none)
601 update_module=checkout ;;
604 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
605 git rev-parse --verify HEAD) ||
606 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
611 branch=$(git submodule--helper remote-branch "$sm_path")
612 if test -z "$nofetch"
614 # Fetch remote before determining tracking $sha1
615 fetch_in_submodule "$sm_path" $depth ||
616 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
618 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
619 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
620 git rev-parse --verify "${remote_name}/${branch}") ||
621 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
624 if test "$subsha1" != "$sha1" || test -n "$force"
627 # If we don't already have a -f flag and the submodule has never been checked out
628 if test -z "$subsha1" && test -z "$force"
633 if test -z "$nofetch"
635 # Run fetch only if $sha1 isn't present or it
636 # is not reachable from a ref.
637 is_tip_reachable "$sm_path" "$sha1" ||
638 fetch_in_submodule "$sm_path" $depth ||
639 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
641 # Now we tried the usual fetch, but $sha1 may
642 # not be reachable from any of the refs
643 is_tip_reachable "$sm_path" "$sha1" ||
644 fetch_in_submodule "$sm_path" $depth "$sha1" ||
645 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
649 case "$update_module" in
651 command="git checkout $subforce -q"
652 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
653 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
657 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
658 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
659 must_die_on_failure=yes
663 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
664 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
665 must_die_on_failure=yes
668 command="${update_module#!}"
669 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
670 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
671 must_die_on_failure=yes
674 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
677 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
680 elif test -n "$must_die_on_failure"
682 die_with_status 2 "$die_msg"
684 err="${err};$die_msg"
689 if test -n "$recursive"
692 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
694 sanitize_submodule_env
701 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
704 err="${err};$die_msg"
707 die_with_status $res "$die_msg"
731 # Show commit summary for submodules in index or working tree
733 # If '--cached' is given, show summary between index and given commit,
734 # or between working tree and given commit
736 # $@ = [commit (default 'HEAD'),] requested paths (default all)
743 # parse $args after "submodule ... summary".
758 isnumber "$summary_limit" || usage
762 summary_limit="${1#--summary-limit=}"
763 isnumber "$summary_limit" || usage
779 test $summary_limit = 0 && return
781 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
785 elif test -z "$1" || test "$1" = "HEAD"
787 # before the first commit: compare with an empty tree
788 head=$(git hash-object -w -t tree --stdin </dev/null)
789 test -z "$1" || shift
797 die "$(gettext "The --cached option cannot be used with the --files option")"
803 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
804 # Get modified modules cared by user
805 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
806 sane_egrep '^:([0-7]* )?160000' |
807 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
809 # Always show modules deleted or type-changed (blob<->module)
810 if test "$status" = D || test "$status" = T
812 printf '%s\n' "$sm_path"
815 # Respect the ignore setting for --for-status.
816 if test -n "$for_status"
818 name=$(git submodule--helper name "$sm_path")
819 ignore_config=$(get_submodule_config "$name" ignore none)
820 test $status != A && test $ignore_config = all && continue
822 # Also show added or modified modules which are checked out
823 GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
824 printf '%s\n' "$sm_path"
828 test -z "$modules" && return
830 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
831 sane_egrep '^:([0-7]* )?160000' |
833 while read -r mod_src mod_dst sha1_src sha1_dst status name
835 if test -z "$cached" &&
836 test $sha1_dst = 0000000000000000000000000000000000000000
840 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
842 100644 | 100755 | 120000)
843 sha1_dst=$(git hash-object $name)
849 eval_gettextln "unexpected mode \$mod_dst" >&2
856 test $mod_src = 160000 &&
857 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
860 test $mod_dst = 160000 &&
861 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
864 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
867 case "$missing_src,$missing_dst" in
869 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
872 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
875 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
880 if test $mod_src = 160000 && test $mod_dst = 160000
882 range="$sha1_src...$sha1_dst"
883 elif test $mod_src = 160000
889 GIT_DIR="$name/.git" \
890 git rev-list --first-parent $range -- | wc -l
892 total_commits=" ($(($total_commits + 0)))"
896 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
897 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
900 blob="$(gettext "blob")"
901 submodule="$(gettext "submodule")"
902 if test $mod_dst = 160000
904 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
906 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
909 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
913 # Don't give error msg for modification whose dst is not submodule
914 # i.e. deleted or changed to blob
915 test $mod_dst = 160000 && echo "$errmsg"
917 if test $mod_src = 160000 && test $mod_dst = 160000
920 test $summary_limit -gt 0 && limit="-$summary_limit"
921 GIT_DIR="$name/.git" \
922 git log $limit --pretty='format: %m %s' \
923 --first-parent $sha1_src...$sha1_dst
924 elif test $mod_dst = 160000
926 GIT_DIR="$name/.git" \
927 git log --pretty='format: > %s' -1 $sha1_dst
929 GIT_DIR="$name/.git" \
930 git log --pretty='format: < %s' -1 $sha1_src
938 # List all submodules, prefixed with:
939 # - submodule not initialized
940 # + different revision checked out
942 # If --cached was specified the revision in the index will be printed
943 # instead of the currently checked out revision.
945 # $@ = requested paths (default to all)
949 # parse $args after "submodule ... status".
976 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
979 # Sync remote urls for submodules
980 # This makes the value for remote.$remote.url match the value
981 # specified in .gitmodules.
1009 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
1014 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
1017 # This loop parses the command line arguments to find the
1018 # subcommand name to dispatch. Parsing of the subcommand specific
1019 # options are primarily done by the subcommand implementations.
1020 # Subcommand specific options such as --branch and --cached are
1021 # parsed here as well, for backward compatibility.
1023 while test $# != 0 && test -z "$command"
1026 add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
1056 # No command word defaults to "status"
1057 if test -z "$command"
1067 # "-b branch" is accepted only by "add"
1068 if test -n "$branch" && test "$command" != add
1073 # "--cached" is accepted only by "status" and "summary"
1074 if test -n "$cached" && test "$command" != status && test "$command" != summary