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] [--[no-]single-branch] [--] [<path>...]
14 or: $dashless [--quiet] set-branch (--default|--branch <branch>) [--] <path>
15 or: $dashless [--quiet] set-url [--] <path> <newurl>
16 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
17 or: $dashless [--quiet] foreach [--recursive] <command>
18 or: $dashless [--quiet] sync [--recursive] [--] [<path>...]
19 or: $dashless [--quiet] absorbgitdirs [--] [<path>...]"
25 wt_prefix=$(git rev-parse --show-prefix)
28 # Tell the rest of git that any URLs we get don't come
29 # directly from the user, so it can apply policy as appropriate.
30 GIT_PROTOCOL_FROM_USER=0
31 export GIT_PROTOCOL_FROM_USER
54 if test "$1" = "#unmatched"
61 # Print a submodule configuration setting
67 # Checks in the usual git-config places first (for overrides),
68 # otherwise it falls back on .gitmodules. This allows you to
69 # distribute project-wide defaults in .gitmodules, while still
70 # customizing individual repositories if necessary. If the option is
71 # not in .gitmodules either, print a default value.
73 get_submodule_config () {
77 value=$(git config submodule."$name"."$option")
80 value=$(git submodule--helper config submodule."$name"."$option")
82 printf '%s' "${value:-$default}"
87 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
90 # Given a full hex object ID, is this the zero OID?
92 echo "$1" | sane_egrep '^0+$' >/dev/null 2>&1
95 # Sanitize the local git environment for use within a submodule. We
96 # can't simply use clear_local_git_env since we want to preserve some
97 # of the settings from GIT_CONFIG_PARAMETERS.
98 sanitize_submodule_env()
100 save_config=$GIT_CONFIG_PARAMETERS
102 GIT_CONFIG_PARAMETERS=$save_config
103 export GIT_CONFIG_PARAMETERS
107 # Add a new submodule to the working tree, .gitmodules and the index
111 # optional branch is stored in global branch variable
115 # parse $args after "submodule ... add".
121 case "$2" in '') usage ;; esac
135 case "$2" in '') usage ;; esac
140 reference_path="${1#--reference=}"
146 case "$2" in '') usage ;; esac
151 case "$2" in '') usage ;; esac
172 if ! git submodule--helper config --check-writeable >/dev/null 2>&1
174 die "$(eval_gettext "please make sure that the .gitmodules file is in the working tree")"
177 if test -n "$reference_path"
179 is_absolute_path "$reference_path" ||
180 reference_path="$wt_prefix$reference_path"
182 reference="--reference=$reference_path"
188 if test -z "$sm_path"; then
189 sm_path=$(printf '%s\n' "$repo" |
190 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
193 if test -z "$repo" || test -z "$sm_path"; then
197 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
199 # assure repo is absolute or relative to parent
202 test -z "$wt_prefix" ||
203 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
205 # dereference source url relative to parent's url
206 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
213 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
218 # multiple //; leading ./; /./; /../; trailing /
219 sm_path=$(printf '%s/\n' "$sm_path" |
231 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
232 die "$(eval_gettext "'\$sm_path' already exists in the index")"
234 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
235 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
238 if test -d "$sm_path" &&
239 test -z $(git -C "$sm_path" rev-parse --show-cdup 2>/dev/null)
241 git -C "$sm_path" rev-parse --verify -q HEAD >/dev/null ||
242 die "$(eval_gettext "'\$sm_path' does not have a commit checked out")"
247 dryerr=$(git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" 2>&1 >/dev/null)
256 if test -n "$custom_name"
258 sm_name="$custom_name"
263 if ! git submodule--helper check-name "$sm_name"
265 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
268 # perhaps the path exists and is already a git repo, else clone it
269 if test -e "$sm_path"
271 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
273 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
275 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
279 if test -d ".git/modules/$sm_name"
283 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
284 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
285 die "$(eval_gettextln "\
286 If you want to reuse this local git directory instead of cloning again from
288 use the '--force' option. If the local git directory is not the correct repo
289 or you are unsure what this means choose another name with the '--name' option.")"
291 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
294 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
296 sanitize_submodule_env
298 # ash fails to wordsplit ${branch:+-b "$branch"...}
300 '') git checkout -f -q ;;
301 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
303 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
305 git config submodule."$sm_name".url "$realrepo"
307 git add --no-warn-embedded-repo $force "$sm_path" ||
308 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
310 git submodule--helper config submodule."$sm_name".path "$sm_path" &&
311 git submodule--helper config submodule."$sm_name".url "$repo" &&
314 git submodule--helper config submodule."$sm_name".branch "$branch"
316 git add --force .gitmodules ||
317 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
319 # NEEDSWORK: In a multi-working-tree world, this needs to be
320 # set in the per-worktree config.
321 if git config --get submodule.active >/dev/null
323 # If the submodule being adding isn't already covered by the
324 # current configured pathspec, set the submodule's active flag
325 if ! git submodule--helper is-active "$sm_path"
327 git config submodule."$sm_name".active "true"
330 git config submodule."$sm_name".active "true"
335 # Execute an arbitrary command sequence in each checked out
338 # $@ = command to execute
342 # parse $args after "submodule ... foreach".
362 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
366 # Register submodules in .git/config
368 # $@ = requested paths (default to all)
372 # parse $args after "submodule ... init".
393 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} -- "$@"
397 # Unregister submodules from .git/config and remove their work tree
401 # parse $args after "submodule ... deinit".
429 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} -- "$@"
432 is_tip_reachable () (
433 sanitize_submodule_env &&
435 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
439 fetch_in_submodule () (
440 sanitize_submodule_env &&
447 git fetch $(get_default_remote) "$@" ;;
452 # Update each submodule path to correct revision, using clone and checkout as needed
454 # $@ = requested paths (default to all)
458 # parse $args after "submodule ... update".
491 case "$2" in '') usage ;; esac
492 reference="--reference=$2"
511 recommend_shallow="--recommend-shallow"
513 --no-recommend-shallow)
514 recommend_shallow="--no-recommend-shallow"
517 case "$2" in '') usage ;; esac
525 case "$2" in '') usage ;; esac
533 single_branch="--single-branch"
536 single_branch="--no-single-branch"
554 cmd_init "--" "$@" || return
558 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
559 ${progress:+"--progress"} \
560 ${wt_prefix:+--prefix "$wt_prefix"} \
561 ${prefix:+--recursive-prefix "$prefix"} \
562 ${update:+--update "$update"} \
563 ${reference:+"$reference"} \
564 ${dissociate:+"--dissociate"} \
565 ${depth:+--depth "$depth"} \
566 ${require_init:+--require-init} \
571 "$@" || echo "#unmatched" $?
574 while read -r quickabort sha1 just_cloned sm_path
576 die_if_unmatched "$quickabort" "$sha1"
578 git submodule--helper ensure-core-worktree "$sm_path" || exit 1
580 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
582 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
584 if test $just_cloned -eq 1
588 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
589 git rev-parse --verify HEAD) ||
590 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
595 branch=$(git submodule--helper remote-branch "$sm_path")
596 if test -z "$nofetch"
598 # Fetch remote before determining tracking $sha1
599 fetch_in_submodule "$sm_path" $depth ||
600 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
602 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
603 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
604 git rev-parse --verify "${remote_name}/${branch}") ||
605 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
608 if test "$subsha1" != "$sha1" || test -n "$force"
611 # If we don't already have a -f flag and the submodule has never been checked out
612 if test -z "$subsha1" && test -z "$force"
617 if test -z "$nofetch"
619 # Run fetch only if $sha1 isn't present or it
620 # is not reachable from a ref.
621 is_tip_reachable "$sm_path" "$sha1" ||
622 fetch_in_submodule "$sm_path" $depth ||
623 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'; trying to directly fetch \$sha1:")"
625 # Now we tried the usual fetch, but $sha1 may
626 # not be reachable from any of the refs
627 is_tip_reachable "$sm_path" "$sha1" ||
628 fetch_in_submodule "$sm_path" $depth "$sha1" ||
629 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
633 case "$update_module" in
635 command="git checkout $subforce -q"
636 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
637 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
641 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
642 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
643 must_die_on_failure=yes
647 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
648 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
649 must_die_on_failure=yes
652 command="${update_module#!}"
653 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
654 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
655 must_die_on_failure=yes
658 die "$(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
661 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
664 elif test -n "$must_die_on_failure"
666 die_with_status 2 "$die_msg"
668 err="${err};$die_msg"
673 if test -n "$recursive"
676 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
678 sanitize_submodule_env
685 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
688 err="${err};$die_msg"
691 die_with_status $res "$die_msg"
715 # Configures a submodule's default branch
717 # $@ = requested path
727 # we don't do anything with this but we need to accept it
733 case "$2" in '') usage ;; esac
756 # we can't use `git submodule--helper name` here because internally, it
757 # hashes the path so a trailing slash could lead to an unintentional no match
758 name="$(git submodule--helper list "$1" | cut -f2)"
764 test -n "$branch"; has_branch=$?
765 test "$unset_branch" = true; has_unset_branch=$?
767 if test $((!$has_branch != !$has_unset_branch)) -eq 0
772 if test $has_branch -eq 0
774 git submodule--helper config submodule."$name".branch "$branch"
776 git submodule--helper config --unset submodule."$name".branch
781 # Configures a submodule's remote url
783 # $@ = requested path, requested url
811 # we can't use `git submodule--helper name` here because internally, it
812 # hashes the path so a trailing slash could lead to an unintentional no match
813 name="$(git submodule--helper list "$1" | cut -f2)"
825 git submodule--helper config submodule."$name".url "$url"
826 git submodule--helper sync ${GIT_QUIET:+--quiet} "$name"
830 # Show commit summary for submodules in index or working tree
832 # If '--cached' is given, show summary between index and given commit,
833 # or between working tree and given commit
835 # $@ = [commit (default 'HEAD'),] requested paths (default all)
842 # parse $args after "submodule ... summary".
857 isnumber "$summary_limit" || usage
861 summary_limit="${1#--summary-limit=}"
862 isnumber "$summary_limit" || usage
878 test $summary_limit = 0 && return
880 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
884 elif test -z "$1" || test "$1" = "HEAD"
886 # before the first commit: compare with an empty tree
887 head=$(git hash-object -w -t tree --stdin </dev/null)
888 test -z "$1" || shift
896 die "$(gettext "The --cached option cannot be used with the --files option")"
902 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
903 # Get modified modules cared by user
904 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
905 sane_egrep '^:([0-7]* )?160000' |
906 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
908 # Always show modules deleted or type-changed (blob<->module)
909 if test "$status" = D || test "$status" = T
911 printf '%s\n' "$sm_path"
914 # Respect the ignore setting for --for-status.
915 if test -n "$for_status"
917 name=$(git submodule--helper name "$sm_path")
918 ignore_config=$(get_submodule_config "$name" ignore none)
919 test $status != A && test $ignore_config = all && continue
921 # Also show added or modified modules which are checked out
922 GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
923 printf '%s\n' "$sm_path"
927 test -z "$modules" && return
929 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
930 sane_egrep '^:([0-7]* )?160000' |
932 while read -r mod_src mod_dst sha1_src sha1_dst status name
934 if test -z "$cached" &&
935 is_zero_oid $sha1_dst
939 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
941 100644 | 100755 | 120000)
942 sha1_dst=$(git hash-object $name)
948 eval_gettextln "unexpected mode \$mod_dst" >&2
955 test $mod_src = 160000 &&
956 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
959 test $mod_dst = 160000 &&
960 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
963 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
966 case "$missing_src,$missing_dst" in
968 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
971 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
974 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
979 if test $mod_src = 160000 && test $mod_dst = 160000
981 range="$sha1_src...$sha1_dst"
982 elif test $mod_src = 160000
988 GIT_DIR="$name/.git" \
989 git rev-list --first-parent $range -- | wc -l
991 total_commits=" ($(($total_commits + 0)))"
995 sha1_abbr_src=$(GIT_DIR="$name/.git" git rev-parse --short $sha1_src 2>/dev/null ||
996 echo $sha1_src | cut -c1-7)
997 sha1_abbr_dst=$(GIT_DIR="$name/.git" git rev-parse --short $sha1_dst 2>/dev/null ||
998 echo $sha1_dst | cut -c1-7)
1002 blob="$(gettext "blob")"
1003 submodule="$(gettext "submodule")"
1004 if test $mod_dst = 160000
1006 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1008 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1011 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1013 if test -n "$errmsg"
1015 # Don't give error msg for modification whose dst is not submodule
1016 # i.e. deleted or changed to blob
1017 test $mod_dst = 160000 && echo "$errmsg"
1019 if test $mod_src = 160000 && test $mod_dst = 160000
1022 test $summary_limit -gt 0 && limit="-$summary_limit"
1023 GIT_DIR="$name/.git" \
1024 git log $limit --pretty='format: %m %s' \
1025 --first-parent $sha1_src...$sha1_dst
1026 elif test $mod_dst = 160000
1028 GIT_DIR="$name/.git" \
1029 git log --pretty='format: > %s' -1 $sha1_dst
1031 GIT_DIR="$name/.git" \
1032 git log --pretty='format: < %s' -1 $sha1_src
1040 # List all submodules, prefixed with:
1041 # - submodule not initialized
1042 # + different revision checked out
1044 # If --cached was specified the revision in the index will be printed
1045 # instead of the currently checked out revision.
1047 # $@ = requested paths (default to all)
1051 # parse $args after "submodule ... status".
1078 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@"
1081 # Sync remote urls for submodules
1082 # This makes the value for remote.$remote.url match the value
1083 # specified in .gitmodules.
1111 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
1116 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
1119 # This loop parses the command line arguments to find the
1120 # subcommand name to dispatch. Parsing of the subcommand specific
1121 # options are primarily done by the subcommand implementations.
1122 # Subcommand specific options such as --branch and --cached are
1123 # parsed here as well, for backward compatibility.
1125 while test $# != 0 && test -z "$command"
1128 add | foreach | init | deinit | update | set-branch | set-url | status | summary | sync | absorbgitdirs)
1158 # No command word defaults to "status"
1159 if test -z "$command"
1169 # "-b branch" is accepted only by "add" and "set-branch"
1170 if test -n "$branch" && (test "$command" != add || test "$command" != set-branch)
1175 # "--cached" is accepted only by "status" and "summary"
1176 if test -n "$cached" && test "$command" != status && test "$command" != summary
1181 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"