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] [--] [<path>...]
14 or: $dashless [--quiet] set-branch (--default|--branch <branch>) [--] <path>
15 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
16 or: $dashless [--quiet] foreach [--recursive] <command>
17 or: $dashless [--quiet] sync [--recursive] [--] [<path>...]
18 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
51 if test "$1" = "#unmatched"
58 # Print a submodule configuration setting
64 # Checks in the usual git-config places first (for overrides),
65 # otherwise it falls back on .gitmodules. This allows you to
66 # distribute project-wide defaults in .gitmodules, while still
67 # customizing individual repositories if necessary. If the option is
68 # not in .gitmodules either, print a default value.
70 get_submodule_config
() {
74 value
=$
(git config submodule.
"$name".
"$option")
77 value
=$
(git submodule--helper config submodule.
"$name".
"$option")
79 printf '%s' "${value:-$default}"
84 n
=$
(($1 + 0)) 2>/dev
/null
&& test "$n" = "$1"
87 # Given a full hex object ID, is this the zero OID?
89 echo "$1" | sane_egrep
'^0+$' >/dev
/null
2>&1
92 # Sanitize the local git environment for use within a submodule. We
93 # can't simply use clear_local_git_env since we want to preserve some
94 # of the settings from GIT_CONFIG_PARAMETERS.
95 sanitize_submodule_env
()
97 save_config
=$GIT_CONFIG_PARAMETERS
99 GIT_CONFIG_PARAMETERS
=$save_config
100 export GIT_CONFIG_PARAMETERS
104 # Add a new submodule to the working tree, .gitmodules and the index
108 # optional branch is stored in global branch variable
112 # parse $args after "submodule ... add".
118 case "$2" in '') usage
;; esac
132 case "$2" in '') usage
;; esac
137 reference_path
="${1#--reference=}"
143 case "$2" in '') usage
;; esac
148 case "$2" in '') usage
;; esac
169 if ! git submodule--helper config
--check-writeable >/dev
/null
2>&1
171 die
"$(eval_gettext "please
make sure that the .gitmodules
file is
in the working tree
")"
174 if test -n "$reference_path"
176 is_absolute_path
"$reference_path" ||
177 reference_path
="$wt_prefix$reference_path"
179 reference
="--reference=$reference_path"
185 if test -z "$sm_path"; then
186 sm_path
=$
(printf '%s\n' "$repo" |
187 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
190 if test -z "$repo" ||
test -z "$sm_path"; then
194 is_absolute_path
"$sm_path" || sm_path
="$wt_prefix$sm_path"
196 # assure repo is absolute or relative to parent
199 test -z "$wt_prefix" ||
200 die
"$(gettext "Relative path can only be used from the toplevel of the working tree
")"
202 # dereference source url relative to parent's url
203 realrepo
=$
(git submodule--helper resolve-relative-url
"$repo") ||
exit
210 die
"$(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
215 # multiple //; leading ./; /./; /../; trailing /
216 sm_path
=$
(printf '%s/\n' "$sm_path" |
228 git ls-files
--error-unmatch "$sm_path" > /dev
/null
2>&1 &&
229 die
"$(eval_gettext "'\$sm_path' already exists
in the index
")"
231 git ls-files
-s "$sm_path" | sane_grep
-v "^160000" > /dev
/null
2>&1 &&
232 die
"$(eval_gettext "'\$sm_path' already exists
in the index and is not a submodule
")"
235 if test -z "$force" &&
236 ! git add
--dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev
/null
2>&1
238 eval_gettextln
"The following path is ignored by one of your .gitignore files:
240 Use -f if you really want to add it." >&2
244 if test -n "$custom_name"
246 sm_name
="$custom_name"
251 if ! git submodule--helper check-name
"$sm_name"
253 die
"$(eval_gettext "'$sm_name' is not a valid submodule name
")"
256 # perhaps the path exists and is already a git repo, else clone it
257 if test -e "$sm_path"
259 if test -d "$sm_path"/.git ||
test -f "$sm_path"/.git
261 eval_gettextln
"Adding existing repo at '\$sm_path' to the index"
263 die
"$(eval_gettext "'\$sm_path' already exists and is not a valid git repo
")"
267 if test -d ".git/modules/$sm_name"
271 eval_gettextln
>&2 "A git directory for '\$sm_name' is found locally with remote(s):"
272 GIT_DIR
=".git/modules/$sm_name" GIT_WORK_TREE
=. git remote
-v |
grep '(fetch)' |
sed -e s
,^
," ", -e s
,' (fetch)',, >&2
273 die
"$(eval_gettextln "\
274 If you want to reuse this
local git directory instead of cloning again from
276 use the
'--force' option. If the
local git directory is not the correct repo
277 or you are unsure what this means choose another name with the
'--name' option.
")"
279 eval_gettextln
"Reactivating local git directory for submodule '\$sm_name'."
282 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
284 sanitize_submodule_env
286 # ash fails to wordsplit ${branch:+-b "$branch"...}
288 '') git checkout
-f -q ;;
289 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
291 ) || die
"$(eval_gettext "Unable to checkout submodule
'\$sm_path'")"
293 git config submodule.
"$sm_name".url
"$realrepo"
295 git add
--no-warn-embedded-repo $force "$sm_path" ||
296 die
"$(eval_gettext "Failed to add submodule
'\$sm_path'")"
298 git submodule--helper config submodule.
"$sm_name".path
"$sm_path" &&
299 git submodule--helper config submodule.
"$sm_name".url
"$repo" &&
302 git submodule--helper config submodule.
"$sm_name".branch
"$branch"
304 git add
--force .gitmodules ||
305 die
"$(eval_gettext "Failed to register submodule
'\$sm_path'")"
307 # NEEDSWORK: In a multi-working-tree world, this needs to be
308 # set in the per-worktree config.
309 if git config
--get submodule.active
>/dev
/null
311 # If the submodule being adding isn't already covered by the
312 # current configured pathspec, set the submodule's active flag
313 if ! git submodule--helper is-active
"$sm_path"
315 git config submodule.
"$sm_name".active
"true"
318 git config submodule.
"$sm_name".active
"true"
323 # Execute an arbitrary command sequence in each checked out
326 # $@ = command to execute
330 # parse $args after "submodule ... foreach".
350 git
${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
354 # Register submodules in .git/config
356 # $@ = requested paths (default to all)
360 # parse $args after "submodule ... init".
381 git
${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} -- "$@"
385 # Unregister submodules from .git/config and remove their work tree
389 # parse $args after "submodule ... deinit".
417 git
${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} -- "$@"
420 is_tip_reachable
() (
421 sanitize_submodule_env
&&
423 rev=$
(git rev-list
-n 1 "$2" --not --all 2>/dev
/null
) &&
427 fetch_in_submodule
() (
428 sanitize_submodule_env
&&
435 git fetch $
(get_default_remote
) "$@" ;;
440 # Update each submodule path to correct revision, using clone and checkout as needed
442 # $@ = requested paths (default to all)
446 # parse $args after "submodule ... update".
475 case "$2" in '') usage
;; esac
476 reference
="--reference=$2"
495 recommend_shallow
="--recommend-shallow"
497 --no-recommend-shallow)
498 recommend_shallow
="--no-recommend-shallow"
501 case "$2" in '') usage
;; esac
509 case "$2" in '') usage
;; esac
532 cmd_init
"--" "$@" ||
return
536 git submodule--helper update-clone
${GIT_QUIET:+--quiet} \
537 ${progress:+"--progress"} \
538 ${wt_prefix:+--prefix "$wt_prefix"} \
539 ${prefix:+--recursive-prefix "$prefix"} \
540 ${update:+--update "$update"} \
541 ${reference:+"$reference"} \
542 ${dissociate:+"--dissociate"} \
543 ${depth:+--depth "$depth"} \
547 "$@" ||
echo "#unmatched" $?
550 while read -r quickabort sha1 just_cloned sm_path
552 die_if_unmatched
"$quickabort" "$sha1"
554 git submodule--helper ensure-core-worktree
"$sm_path" ||
exit 1
556 update_module
=$
(git submodule--helper update-module-mode
$just_cloned "$sm_path" $update)
558 displaypath
=$
(git submodule--helper relative-path
"$prefix$sm_path" "$wt_prefix")
560 if test $just_cloned -eq 1
564 subsha1
=$
(sanitize_submodule_env
; cd "$sm_path" &&
565 git rev-parse
--verify HEAD
) ||
566 die
"$(eval_gettext "Unable to
find current revision
in submodule path
'\$displaypath'")"
571 branch
=$
(git submodule--helper remote-branch
"$sm_path")
572 if test -z "$nofetch"
574 # Fetch remote before determining tracking $sha1
575 fetch_in_submodule
"$sm_path" $depth ||
576 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$sm_path'")"
578 remote_name
=$
(sanitize_submodule_env
; cd "$sm_path" && get_default_remote
)
579 sha1
=$
(sanitize_submodule_env
; cd "$sm_path" &&
580 git rev-parse
--verify "${remote_name}/${branch}") ||
581 die
"$(eval_gettext "Unable to
find current \
${remote_name}/\
${branch} revision
in submodule path
'\$sm_path'")"
584 if test "$subsha1" != "$sha1" ||
test -n "$force"
587 # If we don't already have a -f flag and the submodule has never been checked out
588 if test -z "$subsha1" && test -z "$force"
593 if test -z "$nofetch"
595 # Run fetch only if $sha1 isn't present or it
596 # is not reachable from a ref.
597 is_tip_reachable
"$sm_path" "$sha1" ||
598 fetch_in_submodule
"$sm_path" $depth ||
599 say
"$(eval_gettext "Unable to fetch
in submodule path
'\$displaypath'; trying to directly fetch \
$sha1:")"
601 # Now we tried the usual fetch, but $sha1 may
602 # not be reachable from any of the refs
603 is_tip_reachable
"$sm_path" "$sha1" ||
604 fetch_in_submodule
"$sm_path" $depth "$sha1" ||
605 die
"$(eval_gettext "Fetched
in submodule path
'\$displaypath', but it did not contain \
$sha1. Direct fetching of that commit failed.
")"
609 case "$update_module" in
611 command="git checkout $subforce -q"
612 die_msg
="$(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$displaypath'")"
613 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': checked out
'\$sha1'")"
617 die_msg
="$(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$displaypath'")"
618 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': rebased into
'\$sha1'")"
619 must_die_on_failure
=yes
623 die_msg
="$(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$displaypath'")"
624 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': merged
in '\$sha1'")"
625 must_die_on_failure
=yes
628 command="${update_module#!}"
629 die_msg
="$(eval_gettext "Execution of
'\$command \$sha1' failed
in submodule path
'\$displaypath'")"
630 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': '\$command \$sha1'")"
631 must_die_on_failure
=yes
634 die
"$(eval_gettext "Invalid update mode
'$update_module' for submodule path
'$path'")"
637 if (sanitize_submodule_env
; cd "$sm_path" && $command "$sha1")
640 elif test -n "$must_die_on_failure"
642 die_with_status
2 "$die_msg"
644 err
="${err};$die_msg"
649 if test -n "$recursive"
652 prefix
=$
(git submodule--helper relative-path
"$prefix$sm_path/" "$wt_prefix")
654 sanitize_submodule_env
661 die_msg
="$(eval_gettext "Failed to recurse into submodule path
'\$displaypath'")"
664 err
="${err};$die_msg"
667 die_with_status
$res "$die_msg"
691 # Configures a submodule's default branch
693 # $@ = requested path
703 # we don't do anything with this but we need to accept it
709 case "$2" in '') usage
;; esac
732 # we can't use `git submodule--helper name` here because internally, it
733 # hashes the path so a trailing slash could lead to an unintentional no match
734 name
="$(git submodule--helper list "$1" | cut -f2)"
740 test -n "$branch"; has_branch
=$?
741 test "$unset_branch" = true
; has_unset_branch
=$?
743 if test $
((!$has_branch != !$has_unset_branch)) -eq 0
748 if test $has_branch -eq 0
750 git submodule--helper config submodule.
"$name".branch
"$branch"
752 git submodule--helper config
--unset submodule.
"$name".branch
757 # Show commit summary for submodules in index or working tree
759 # If '--cached' is given, show summary between index and given commit,
760 # or between working tree and given commit
762 # $@ = [commit (default 'HEAD'),] requested paths (default all)
769 # parse $args after "submodule ... summary".
784 isnumber
"$summary_limit" || usage
788 summary_limit
="${1#--summary-limit=}"
789 isnumber
"$summary_limit" || usage
805 test $summary_limit = 0 && return
807 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
811 elif test -z "$1" ||
test "$1" = "HEAD"
813 # before the first commit: compare with an empty tree
814 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
815 test -z "$1" ||
shift
823 die
"$(gettext "The
--cached option cannot be used with the
--files option
")"
829 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@
")"
830 # Get modified modules cared by user
831 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
832 sane_egrep
'^:([0-7]* )?160000' |
833 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
835 # Always show modules deleted or type-changed (blob<->module)
836 if test "$status" = D ||
test "$status" = T
838 printf '%s\n' "$sm_path"
841 # Respect the ignore setting for --for-status.
842 if test -n "$for_status"
844 name
=$
(git submodule--helper name
"$sm_path")
845 ignore_config
=$
(get_submodule_config
"$name" ignore none
)
846 test $status != A
&& test $ignore_config = all
&& continue
848 # Also show added or modified modules which are checked out
849 GIT_DIR
="$sm_path/.git" git rev-parse
--git-dir >/dev
/null
2>&1 &&
850 printf '%s\n' "$sm_path"
854 test -z "$modules" && return
856 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
857 sane_egrep
'^:([0-7]* )?160000' |
859 while read -r mod_src mod_dst sha1_src sha1_dst status name
861 if test -z "$cached" &&
862 is_zero_oid
$sha1_dst
866 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
868 100644 |
100755 |
120000)
869 sha1_dst
=$
(git hash-object
$name)
875 eval_gettextln
"unexpected mode \$mod_dst" >&2
882 test $mod_src = 160000 &&
883 ! GIT_DIR
="$name/.git" git rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
886 test $mod_dst = 160000 &&
887 ! GIT_DIR
="$name/.git" git rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
890 display_name
=$
(git submodule--helper relative-path
"$name" "$wt_prefix")
893 case "$missing_src,$missing_dst" in
895 errmsg
="$(eval_gettext " Warn
: \
$display_name doesn
't contain commit \$sha1_src")"
898 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \
$sha1_dst")"
901 errmsg
="$(eval_gettext " Warn
: \
$display_name doesn
't contain commits \$sha1_src and \$sha1_dst")"
906 if test $mod_src = 160000 && test $mod_dst = 160000
908 range="$sha1_src...$sha1_dst"
909 elif test $mod_src = 160000
915 GIT_DIR="$name/.git" \
916 git rev-list --first-parent $range -- | wc -l
918 total_commits=" ($(($total_commits + 0)))"
922 sha1_abbr_src=$(GIT_DIR="$name/.git" git rev-parse --short $sha1_src 2>/dev/null ||
923 echo $sha1_src | cut -c1-7)
924 sha1_abbr_dst=$(GIT_DIR="$name/.git" git rev-parse --short $sha1_dst 2>/dev/null ||
925 echo $sha1_dst | cut -c1-7)
929 blob="$(gettext "blob")"
930 submodule="$(gettext "submodule")"
931 if test $mod_dst = 160000
933 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
935 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
938 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
942 # Don't give error msg
for modification whose dst is not submodule
943 # i.e. deleted or changed to blob
944 test $mod_dst = 160000 && echo "$errmsg"
946 if test $mod_src = 160000 && test $mod_dst = 160000
949 test $summary_limit -gt 0 && limit
="-$summary_limit"
950 GIT_DIR
="$name/.git" \
951 git log
$limit --pretty='format: %m %s' \
952 --first-parent $sha1_src...
$sha1_dst
953 elif test $mod_dst = 160000
955 GIT_DIR
="$name/.git" \
956 git log
--pretty='format: > %s' -1 $sha1_dst
958 GIT_DIR
="$name/.git" \
959 git log
--pretty='format: < %s' -1 $sha1_src
967 # List all submodules, prefixed with:
968 # - submodule not initialized
969 # + different revision checked out
971 # If --cached was specified the revision in the index will be printed
972 # instead of the currently checked out revision.
974 # $@ = requested paths (default to all)
978 # parse $args after "submodule ... status".
1005 git
${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@"
1008 # Sync remote urls for submodules
1009 # This makes the value for remote.$remote.url match the value
1010 # specified in .gitmodules.
1038 git
${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
1043 git submodule--helper absorb-git-dirs
--prefix "$wt_prefix" "$@"
1046 # This loop parses the command line arguments to find the
1047 # subcommand name to dispatch. Parsing of the subcommand specific
1048 # options are primarily done by the subcommand implementations.
1049 # Subcommand specific options such as --branch and --cached are
1050 # parsed here as well, for backward compatibility.
1052 while test $# != 0 && test -z "$command"
1055 add | foreach | init | deinit | update | set-branch | status | summary | sync | absorbgitdirs
)
1085 # No command word defaults to "status"
1086 if test -z "$command"
1096 # "-b branch" is accepted only by "add" and "set-branch"
1097 if test -n "$branch" && (test "$command" != add ||
test "$command" != set-branch
)
1102 # "--cached" is accepted only by "status" and "summary"
1103 if test -n "$cached" && test "$command" != status
&& test "$command" != summary
1108 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"