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
56 if test "$1" = "#unmatched"
64 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
67 # Given a full hex object ID, is this the zero OID?
69 echo "$1" | sane_egrep '^0+$' >/dev/null 2>&1
72 # Sanitize the local git environment for use within a submodule. We
73 # can't simply use clear_local_git_env since we want to preserve some
74 # of the settings from GIT_CONFIG_PARAMETERS.
75 sanitize_submodule_env()
77 save_config=$GIT_CONFIG_PARAMETERS
79 GIT_CONFIG_PARAMETERS=$save_config
80 export GIT_CONFIG_PARAMETERS
84 # Add a new submodule to the working tree, .gitmodules and the index
88 # optional branch is stored in global branch variable
92 # parse $args after "submodule ... add".
98 case "$2" in '') usage ;; esac
112 case "$2" in '') usage ;; esac
117 reference_path="${1#--reference=}"
123 case "$2" in '') usage ;; esac
128 case "$2" in '') usage ;; esac
149 if ! git submodule--helper config --check-writeable >/dev/null 2>&1
151 die "$(eval_gettext "please make sure that the .gitmodules file is in the working tree")"
154 if test -n "$reference_path"
156 is_absolute_path "$reference_path" ||
157 reference_path="$wt_prefix$reference_path"
159 reference="--reference=$reference_path"
165 if test -z "$sm_path"; then
166 sm_path=$(printf '%s\n' "$repo" |
167 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
170 if test -z "$repo" || test -z "$sm_path"; then
174 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
176 # assure repo is absolute or relative to parent
179 test -z "$wt_prefix" ||
180 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
182 # dereference source url relative to parent's url
183 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
190 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
195 # multiple //; leading ./; /./; /../; trailing /
196 sm_path=$(printf '%s/\n' "$sm_path" |
208 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
209 die "$(eval_gettext "'\$sm_path' already exists in the index")"
211 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
212 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
215 if test -d "$sm_path" &&
216 test -z $(git -C "$sm_path" rev-parse --show-cdup 2>/dev/null)
218 git -C "$sm_path" rev-parse --verify -q HEAD >/dev/null ||
219 die "$(eval_gettext "'\$sm_path' does not have a commit checked out")"
224 dryerr=$(git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" 2>&1 >/dev/null)
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 submodule--helper config submodule."$sm_name".path "$sm_path" &&
288 git submodule--helper config submodule."$sm_name".url "$repo" &&
291 git submodule--helper config 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".
339 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
343 # Register submodules in .git/config
345 # $@ = requested paths (default to all)
349 # parse $args after "submodule ... init".
370 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} -- "$@"
374 # Unregister submodules from .git/config and remove their work tree
378 # parse $args after "submodule ... deinit".
406 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} -- "$@"
409 is_tip_reachable () (
410 sanitize_submodule_env &&
412 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
416 fetch_in_submodule () (
417 sanitize_submodule_env &&
424 git fetch $(get_default_remote) "$@" ;;
429 # Update each submodule path to correct revision, using clone and checkout as needed
431 # $@ = requested paths (default to all)
435 # 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
510 single_branch="--single-branch"
513 single_branch="--no-single-branch"
531 cmd_init "--" "$@" || return
535 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
536 ${progress:+"--progress"} \
537 ${wt_prefix:+--prefix "$wt_prefix"} \
538 ${prefix:+--recursive-prefix "$prefix"} \
539 ${update:+--update "$update"} \
540 ${reference:+"$reference"} \
541 ${dissociate:+"--dissociate"} \
542 ${depth:+--depth "$depth"} \
543 ${require_init:+--require-init} \
548 "$@" || echo "#unmatched" $?
551 while read -r quickabort sha1 just_cloned sm_path
553 die_if_unmatched "$quickabort" "$sha1"
555 git submodule--helper ensure-core-worktree "$sm_path" || exit 1
557 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
559 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
561 if test $just_cloned -eq 1
565 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
566 git rev-parse --verify HEAD) ||
567 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
572 branch=$(git submodule--helper remote-branch "$sm_path")
573 if test -z "$nofetch"
575 # Fetch remote before determining tracking $sha1
576 fetch_in_submodule "$sm_path" $depth ||
577 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
579 remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
580 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
581 git rev-parse --verify "${remote_name}/${branch}") ||
582 die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
585 if test "$subsha1" != "$sha1" || test -n "$force"
588 # If we don't already have a -f flag and the submodule has never been checked out
589 if test -z "$subsha1" && test -z "$force"
594 if test -z "$nofetch"
596 # Run fetch only if $sha1 isn't present or it
597 # is not reachable from a ref.
598 is_tip_reachable "$sm_path" "$sha1" ||
599 fetch_in_submodule "$sm_path" $depth ||
600 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'; trying to directly fetch \$sha1:")"
602 # Now we tried the usual fetch, but $sha1 may
603 # not be reachable from any of the refs
604 is_tip_reachable "$sm_path" "$sha1" ||
605 fetch_in_submodule "$sm_path" $depth "$sha1" ||
606 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
610 case "$update_module" in
612 command="git checkout $subforce -q"
613 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
614 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
617 command="git rebase ${GIT_QUIET:+--quiet}"
618 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
619 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
620 must_die_on_failure=yes
623 command="git merge ${GIT_QUIET:+--quiet}"
624 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
625 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
626 must_die_on_failure=yes
629 command="${update_module#!}"
630 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
631 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
632 must_die_on_failure=yes
635 die "$(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
638 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
641 elif test -n "$must_die_on_failure"
643 die_with_status 2 "$die_msg"
645 err="${err};$die_msg"
650 if test -n "$recursive"
653 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
655 sanitize_submodule_env
662 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
665 err="${err};$die_msg"
668 die_with_status $res "$die_msg"
692 # Configures a submodule's default branch
694 # $@ = requested path
704 # we don't do anything with this but we need to accept it
710 case "$2" in '') usage ;; esac
728 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper set-branch ${GIT_QUIET:+--quiet} ${branch:+--branch "$branch"} ${default:+--default} -- "$@"
732 # Configures a submodule's remote url
734 # $@ = requested path, requested url
757 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper set-url ${GIT_QUIET:+--quiet} -- "$@"
761 # Show commit summary for submodules in index or working tree
763 # If '--cached' is given, show summary between index and given commit,
764 # or between working tree and given commit
766 # $@ = [commit (default 'HEAD'),] requested paths (default all)
773 # parse $args after "submodule ... summary".
788 isnumber "$summary_limit" || usage
792 summary_limit="${1#--summary-limit=}"
793 isnumber "$summary_limit" || usage
809 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper summary ${prefix:+--prefix "$prefix"} ${files:+--files} ${cached:+--cached} ${for_status:+--for-status} ${summary_limit:+-n $summary_limit} -- "$@"
812 # List all submodules, prefixed with:
813 # - submodule not initialized
814 # + different revision checked out
816 # If --cached was specified the revision in the index will be printed
817 # instead of the currently checked out revision.
819 # $@ = requested paths (default to all)
823 # parse $args after "submodule ... status".
850 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@"
853 # Sync remote urls for submodules
854 # This makes the value for remote.$remote.url match the value
855 # specified in .gitmodules.
883 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
888 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
891 # This loop parses the command line arguments to find the
892 # subcommand name to dispatch. Parsing of the subcommand specific
893 # options are primarily done by the subcommand implementations.
894 # Subcommand specific options such as --branch and --cached are
895 # parsed here as well, for backward compatibility.
897 while test $# != 0 && test -z "$command"
900 add | foreach | init | deinit | update | set-branch | set-url | status | summary | sync | absorbgitdirs)
930 # No command word defaults to "status"
931 if test -z "$command"
941 # "-b branch" is accepted only by "add" and "set-branch"
942 if test -n "$branch" && (test "$command" != add || test "$command" != set-branch)
947 # "--cached" is accepted only by "status" and "summary"
948 if test -n "$cached" && test "$command" != status && test "$command" != summary
953 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"