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>...]"
24 wt_prefix
=$
(git rev-parse
--show-prefix)
27 # Tell the rest of git that any URLs we get don't come
28 # directly from the user, so it can apply policy as appropriate.
29 GIT_PROTOCOL_FROM_USER
=0
30 export GIT_PROTOCOL_FROM_USER
55 if test "$1" = "#unmatched"
63 n
=$
(($1 + 0)) 2>/dev
/null
&& test "$n" = "$1"
66 # Given a full hex object ID, is this the zero OID?
68 echo "$1" | sane_egrep
'^0+$' >/dev
/null
2>&1
71 # Sanitize the local git environment for use within a submodule. We
72 # can't simply use clear_local_git_env since we want to preserve some
73 # of the settings from GIT_CONFIG_PARAMETERS.
74 sanitize_submodule_env
()
76 save_config
=$GIT_CONFIG_PARAMETERS
78 GIT_CONFIG_PARAMETERS
=$save_config
79 export GIT_CONFIG_PARAMETERS
83 # Add a new submodule to the working tree, .gitmodules and the index
87 # optional branch is stored in global branch variable
91 # parse $args after "submodule ... add".
97 case "$2" in '') usage
;; esac
111 case "$2" in '') usage
;; esac
116 reference_path
="${1#--reference=}"
122 case "$2" in '') usage
;; esac
127 case "$2" in '') usage
;; esac
148 if ! git submodule--helper config
--check-writeable >/dev
/null
2>&1
150 die
"fatal: $(eval_gettext "please
make sure that the .gitmodules
file is
in the working tree
")"
153 if test -n "$reference_path"
155 is_absolute_path
"$reference_path" ||
156 reference_path
="$wt_prefix$reference_path"
158 reference
="--reference=$reference_path"
164 if test -z "$sm_path"; then
165 sm_path
=$
(printf '%s\n' "$repo" |
166 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
169 if test -z "$repo" ||
test -z "$sm_path"; then
173 is_absolute_path
"$sm_path" || sm_path
="$wt_prefix$sm_path"
175 # assure repo is absolute or relative to parent
178 test -z "$wt_prefix" ||
179 die
"fatal: $(gettext "Relative path can only be used from the toplevel of the working tree
")"
181 # dereference source url relative to parent's url
182 realrepo
=$
(git submodule--helper resolve-relative-url
"$repo") ||
exit
189 die
"fatal: $(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
194 # multiple //; leading ./; /./; /../; trailing /
195 sm_path
=$
(printf '%s/\n' "$sm_path" |
207 git ls-files
--error-unmatch "$sm_path" > /dev
/null
2>&1 &&
208 die
"fatal: $(eval_gettext "'\$sm_path' already exists
in the index
")"
210 git ls-files
-s "$sm_path" | sane_grep
-v "^160000" > /dev
/null
2>&1 &&
211 die
"fatal: $(eval_gettext "'\$sm_path' already exists
in the index and is not a submodule
")"
214 if test -d "$sm_path" &&
215 test -z $
(git
-C "$sm_path" rev-parse
--show-cdup 2>/dev
/null
)
217 git
-C "$sm_path" rev-parse
--verify -q HEAD
>/dev
/null ||
218 die
"fatal: $(eval_gettext "'\$sm_path' does not have a commit checked out
")"
223 dryerr
=$
(git add
--dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" 2>&1 >/dev
/null
)
232 if test -n "$custom_name"
234 sm_name
="$custom_name"
239 if ! git submodule--helper check-name
"$sm_name"
241 die
"fatal: $(eval_gettext "'$sm_name' is not a valid submodule name
")"
244 git submodule--helper add-clone
${GIT_QUIET:+--quiet} ${force:+"--force"} ${progress:+"--progress"} ${branch:+--branch "$branch"} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${dissociate:+"--dissociate"} ${depth:+"$depth"} ||
exit
245 git submodule--helper add-config
${force:+--force} ${branch:+--branch "$branch"} --url "$repo" --resolved-url "$realrepo" --path "$sm_path" --name "$sm_name"
249 # Execute an arbitrary command sequence in each checked out
252 # $@ = command to execute
256 # parse $args after "submodule ... foreach".
276 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
280 # Register submodules in .git/config
282 # $@ = requested paths (default to all)
286 # parse $args after "submodule ... init".
307 git
${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} -- "$@"
311 # Unregister submodules from .git/config and remove their work tree
315 # parse $args after "submodule ... deinit".
343 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${force:+--force} ${deinit_all:+--all} -- "$@"
346 is_tip_reachable
() (
347 sanitize_submodule_env
&&
349 rev=$
(git rev-list
-n 1 "$2" --not --all 2>/dev
/null
) &&
353 # usage: fetch_in_submodule <module_path> [<depth>] [<sha1>]
354 # Because arguments are positional, use an empty string to omit <depth>
355 # but include <sha1>.
356 fetch_in_submodule
() (
357 sanitize_submodule_env
&&
361 echo "$3" | git fetch
${GIT_QUIET:+--quiet} --stdin ${2:+"$2"}
363 git fetch
${GIT_QUIET:+--quiet} ${2:+"$2"}
368 # Update each submodule path to correct revision, using clone and checkout as needed
370 # $@ = requested paths (default to all)
374 # parse $args after "submodule ... update".
407 case "$2" in '') usage
;; esac
408 reference
="--reference=$2"
427 recommend_shallow
="--recommend-shallow"
429 --no-recommend-shallow)
430 recommend_shallow
="--no-recommend-shallow"
433 case "$2" in '') usage
;; esac
441 case "$2" in '') usage
;; esac
449 single_branch
="--single-branch"
452 single_branch
="--no-single-branch"
470 cmd_init
"--" "$@" ||
return
474 git submodule--helper update-clone
${GIT_QUIET:+--quiet} \
475 ${progress:+"--progress"} \
476 ${wt_prefix:+--prefix "$wt_prefix"} \
477 ${prefix:+--recursive-prefix "$prefix"} \
478 ${update:+--update "$update"} \
479 ${reference:+"$reference"} \
480 ${dissociate:+"--dissociate"} \
481 ${depth:+--depth "$depth"} \
482 ${require_init:+--require-init} \
487 "$@" ||
echo "#unmatched" $?
490 while read -r quickabort sha1 just_cloned sm_path
492 die_if_unmatched
"$quickabort" "$sha1"
494 git submodule--helper ensure-core-worktree
"$sm_path" ||
exit 1
496 update_module
=$
(git submodule--helper update-module-mode
$just_cloned "$sm_path" $update)
498 displaypath
=$
(git submodule--helper relative-path
"$prefix$sm_path" "$wt_prefix")
500 if test $just_cloned -eq 1
504 subsha1
=$
(sanitize_submodule_env
; cd "$sm_path" &&
505 git rev-parse
--verify HEAD
) ||
506 die
"fatal: $(eval_gettext "Unable to
find current revision
in submodule path
'\$displaypath'")"
511 branch
=$
(git submodule--helper remote-branch
"$sm_path")
512 if test -z "$nofetch"
514 # Fetch remote before determining tracking $sha1
515 fetch_in_submodule
"$sm_path" $depth ||
516 die
"fatal: $(eval_gettext "Unable to fetch
in submodule path
'\$sm_path'")"
518 remote_name
=$
(sanitize_submodule_env
; cd "$sm_path" && git submodule--helper print-default-remote
)
519 sha1
=$
(sanitize_submodule_env
; cd "$sm_path" &&
520 git rev-parse
--verify "${remote_name}/${branch}") ||
521 die
"fatal: $(eval_gettext "Unable to
find current \
${remote_name}/\
${branch} revision
in submodule path
'\$sm_path'")"
524 if test "$subsha1" != "$sha1" ||
test -n "$force"
527 # If we don't already have a -f flag and the submodule has never been checked out
528 if test -z "$subsha1" && test -z "$force"
533 if test -z "$nofetch"
535 # Run fetch only if $sha1 isn't present or it
536 # is not reachable from a ref.
537 is_tip_reachable
"$sm_path" "$sha1" ||
538 fetch_in_submodule
"$sm_path" $depth ||
539 say
"$(eval_gettext "Unable to fetch
in submodule path
'\$displaypath'; trying to directly fetch \
$sha1:")"
541 # Now we tried the usual fetch, but $sha1 may
542 # not be reachable from any of the refs
543 is_tip_reachable
"$sm_path" "$sha1" ||
544 fetch_in_submodule
"$sm_path" "$depth" "$sha1" ||
545 die
"fatal: $(eval_gettext "Fetched
in submodule path
'\$displaypath', but it did not contain \
$sha1. Direct fetching of that commit failed.
")"
549 case "$update_module" in
551 command="git checkout $subforce -q"
552 die_msg
="fatal: $(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$displaypath'")"
553 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': checked out
'\$sha1'")"
556 command="git rebase ${GIT_QUIET:+--quiet}"
557 die_msg
="fatal: $(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$displaypath'")"
558 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': rebased into
'\$sha1'")"
559 must_die_on_failure
=yes
562 command="git merge ${GIT_QUIET:+--quiet}"
563 die_msg
="fatal: $(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$displaypath'")"
564 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': merged
in '\$sha1'")"
565 must_die_on_failure
=yes
568 command="${update_module#!}"
569 die_msg
="fatal: $(eval_gettext "Execution of
'\$command \$sha1' failed
in submodule path
'\$displaypath'")"
570 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': '\$command \$sha1'")"
571 must_die_on_failure
=yes
574 die
"fatal: $(eval_gettext "Invalid update mode
'$update_module' for submodule path
'$path'")"
577 if (sanitize_submodule_env
; cd "$sm_path" && $command "$sha1")
580 elif test -n "$must_die_on_failure"
582 die_with_status
2 "$die_msg"
584 err
="${err};$die_msg"
589 if test -n "$recursive"
592 prefix
=$
(git submodule--helper relative-path
"$prefix$sm_path/" "$wt_prefix")
594 sanitize_submodule_env
601 die_msg
="fatal: $(eval_gettext "Failed to recurse into submodule path
'\$displaypath'")"
604 err
="${err};$die_msg"
607 die_with_status
$res "$die_msg"
631 # Configures a submodule's default branch
633 # $@ = requested path
643 # we don't do anything with this but we need to accept it
649 case "$2" in '') usage
;; esac
667 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper set-branch ${GIT_QUIET:+--quiet} ${branch:+--branch "$branch"} ${default:+--default} -- "$@"
671 # Configures a submodule's remote url
673 # $@ = requested path, requested url
696 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper set-url
${GIT_QUIET:+--quiet} -- "$@"
700 # Show commit summary for submodules in index or working tree
702 # If '--cached' is given, show summary between index and given commit,
703 # or between working tree and given commit
705 # $@ = [commit (default 'HEAD'),] requested paths (default all)
712 # parse $args after "submodule ... summary".
727 isnumber
"$summary_limit" || usage
731 summary_limit
="${1#--summary-limit=}"
732 isnumber
"$summary_limit" || usage
748 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper summary ${files:+--files} ${cached:+--cached} ${for_status:+--for-status} ${summary_limit:+-n $summary_limit} -- "$@"
751 # List all submodules, prefixed with:
752 # - submodule not initialized
753 # + different revision checked out
755 # If --cached was specified the revision in the index will be printed
756 # instead of the currently checked out revision.
758 # $@ = requested paths (default to all)
762 # parse $args after "submodule ... status".
789 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@"
792 # Sync remote urls for submodules
793 # This makes the value for remote.$remote.url match the value
794 # specified in .gitmodules.
822 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
827 git submodule--helper absorb-git-dirs
--prefix "$wt_prefix" "$@"
830 # This loop parses the command line arguments to find the
831 # subcommand name to dispatch. Parsing of the subcommand specific
832 # options are primarily done by the subcommand implementations.
833 # Subcommand specific options such as --branch and --cached are
834 # parsed here as well, for backward compatibility.
836 while test $# != 0 && test -z "$command"
839 add | foreach | init | deinit | update | set-branch | set-url | status | summary | sync | absorbgitdirs
)
869 # No command word defaults to "status"
870 if test -z "$command"
880 # "-b branch" is accepted only by "add" and "set-branch"
881 if test -n "$branch" && (test "$command" != add ||
test "$command" != set-branch
)
886 # "--cached" is accepted only by "status" and "summary"
887 if test -n "$cached" && test "$command" != status
&& test "$command" != summary
892 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"