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] [--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>...]"
21 wt_prefix
=$
(git rev-parse
--show-prefix)
24 # Restrict ourselves to a vanilla subset of protocols; the URLs
25 # we get are under control of a remote repository, and we do not
26 # want them kicking off arbitrary git-remote-* programs.
28 # If the user has already specified a set of allowed protocols,
29 # we assume they know what they're doing and use that instead.
30 : ${GIT_ALLOW_PROTOCOL=file:git:http:https:ssh}
31 export GIT_ALLOW_PROTOCOL
48 # Resolve a path to be relative to another path. This is intended for
49 # converting submodule paths when git-submodule is run in a subdirectory
50 # and only handles paths where the directory separator is '/'.
52 # The output is the first argument as a path relative to the second argument,
53 # which defaults to $wt_prefix if it is omitted.
56 local target curdir result
58 curdir
=${2-$wt_prefix}
62 while test -n "$curdir"
66 target
=${target#"$curdir"/}
72 if test "$curdir" = "${curdir%/*}"
85 if test "$1" = "#unmatched"
92 # Print a submodule configuration setting
98 # Checks in the usual git-config places first (for overrides),
99 # otherwise it falls back on .gitmodules. This allows you to
100 # distribute project-wide defaults in .gitmodules, while still
101 # customizing individual repositories if necessary. If the option is
102 # not in .gitmodules either, print a default value.
104 get_submodule_config
() {
108 value
=$
(git config submodule.
"$name".
"$option")
111 value
=$
(git config
-f .gitmodules submodule.
"$name".
"$option")
113 printf '%s' "${value:-$default}"
118 n
=$
(($1 + 0)) 2>/dev
/null
&& test "$n" = "$1"
121 # Sanitize the local git environment for use within a submodule. We
122 # can't simply use clear_local_git_env since we want to preserve some
123 # of the settings from GIT_CONFIG_PARAMETERS.
124 sanitize_submodule_env
()
126 save_config
=$GIT_CONFIG_PARAMETERS
128 GIT_CONFIG_PARAMETERS
=$save_config
129 export GIT_CONFIG_PARAMETERS
133 # Add a new submodule to the working tree, .gitmodules and the index
137 # optional branch is stored in global branch variable
141 # parse $args after "submodule ... add".
147 case "$2" in '') usage
;; esac
158 case "$2" in '') usage
;; esac
163 reference_path
="${1#--reference=}"
166 case "$2" in '') usage
;; esac
171 case "$2" in '') usage
;; esac
192 if test -n "$reference_path"
194 is_absolute_path
"$reference_path" ||
195 reference_path
="$wt_prefix$reference_path"
197 reference
="--reference=$reference_path"
203 if test -z "$sm_path"; then
204 sm_path
=$
(printf '%s\n' "$repo" |
205 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
208 if test -z "$repo" ||
test -z "$sm_path"; then
212 is_absolute_path
"$sm_path" || sm_path
="$wt_prefix$sm_path"
214 # assure repo is absolute or relative to parent
217 test -z "$wt_prefix" ||
218 die
"$(gettext "Relative path can only be used from the toplevel of the working tree
")"
220 # dereference source url relative to parent's url
221 realrepo
=$
(git submodule--helper resolve-relative-url
"$repo") ||
exit
228 die
"$(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
233 # multiple //; leading ./; /./; /../; trailing /
234 sm_path
=$
(printf '%s/\n' "$sm_path" |
244 git ls-files
--error-unmatch "$sm_path" > /dev
/null
2>&1 &&
245 die
"$(eval_gettext "'\$sm_path' already exists
in the index
")"
247 if test -z "$force" && ! git add
--dry-run --ignore-missing "$sm_path" > /dev
/null
2>&1
249 eval_gettextln
"The following path is ignored by one of your .gitignore files:
251 Use -f if you really want to add it." >&2
255 if test -n "$custom_name"
257 sm_name
="$custom_name"
262 # perhaps the path exists and is already a git repo, else clone it
263 if test -e "$sm_path"
265 if test -d "$sm_path"/.git ||
test -f "$sm_path"/.git
267 eval_gettextln
"Adding existing repo at '\$sm_path' to the index"
269 die
"$(eval_gettext "'\$sm_path' already exists and is not a valid git repo
")"
273 if test -d ".git/modules/$sm_name"
277 eval_gettextln
>&2 "A git directory for '\$sm_name' is found locally with remote(s):"
278 GIT_DIR
=".git/modules/$sm_name" GIT_WORK_TREE
=. git remote
-v |
grep '(fetch)' |
sed -e s
,^
," ", -e s
,' (fetch)',, >&2
279 die
"$(eval_gettextln "\
280 If you want to reuse this
local git directory instead of cloning again from
282 use the
'--force' option. If the
local git directory is not the correct repo
283 or you are unsure what this means choose another name with the
'--name' option.
")"
285 eval_gettextln
"Reactivating local git directory for submodule '\$sm_name'."
288 git submodule--helper clone
${GIT_QUIET:+--quiet} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${depth:+"$depth"} ||
exit
290 sanitize_submodule_env
292 # ash fails to wordsplit ${branch:+-b "$branch"...}
294 '') git checkout
-f -q ;;
295 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
297 ) || die
"$(eval_gettext "Unable to checkout submodule
'\$sm_path'")"
299 git config submodule.
"$sm_name".url
"$realrepo"
301 git add
$force "$sm_path" ||
302 die
"$(eval_gettext "Failed to add submodule
'\$sm_path'")"
304 git config
-f .gitmodules submodule.
"$sm_name".path
"$sm_path" &&
305 git config
-f .gitmodules submodule.
"$sm_name".url
"$repo" &&
308 git config
-f .gitmodules submodule.
"$sm_name".branch
"$branch"
310 git add
--force .gitmodules ||
311 die
"$(eval_gettext "Failed to register submodule
'\$sm_path'")"
315 # Execute an arbitrary command sequence in each checked out
318 # $@ = command to execute
322 # parse $args after "submodule ... foreach".
344 # dup stdin so that it can be restored when running the external
345 # command in the subshell (and a recursive call to this function)
348 git submodule--helper list
--prefix "$wt_prefix"|
349 while read mode sha1 stage sm_path
351 die_if_unmatched
"$mode"
352 if test -e "$sm_path"/.git
354 displaypath
=$
(relative_path
"$prefix$sm_path")
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
=$
(relative_path
"$sm_path") &&
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"} submodule--helper init ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} "$@"
412 # Unregister submodules from .git/config and remove their work tree
414 # $@ = requested paths (use '.' to deinit all submodules)
418 # parse $args after "submodule ... deinit".
446 if test -n "$deinit_all" && test "$#" -ne 0
448 echo >&2 "$(eval_gettext "pathspec and
--all are incompatible
")"
451 if test $# = 0 && test -z "$deinit_all"
453 die
"$(eval_gettext "Use
'--all' if you really want to deinitialize all submodules
")"
456 git submodule--helper list
--prefix "$wt_prefix" "$@" |
457 while read mode sha1 stage sm_path
459 die_if_unmatched
"$mode"
460 name
=$
(git submodule--helper name
"$sm_path") ||
exit
462 displaypath
=$
(relative_path
"$sm_path")
464 # Remove the submodule work tree (unless the user already did it)
465 if test -d "$sm_path"
467 # Protect submodules containing a .git directory
468 if test -d "$sm_path/.git"
470 die
"$(eval_gettext "\
471 Submodule work tree
'\$displaypath' contains a .git directory
472 (use
'rm -rf' if you really want to remove it including all of its
history)")"
477 git
rm -qn "$sm_path" ||
478 die
"$(eval_gettext "Submodule work tree
'\$displaypath' contains
local modifications
; use
'-f' to discard them
")"
481 say
"$(eval_gettext "Cleared directory
'\$displaypath'")" ||
482 say
"$(eval_gettext "Could not remove submodule work tree
'\$displaypath'")"
485 mkdir
"$sm_path" || say
"$(eval_gettext "Could not create empty submodule directory
'\$displaypath'")"
487 # Remove the .git/config entries (unless the user already did it)
488 if test -n "$(git config --get-regexp submodule."$name\.
")"
490 # Remove the whole section so we have a clean state when
491 # the user later decides to init this submodule again
492 url
=$
(git config submodule.
"$name".url
)
493 git config
--remove-section submodule.
"$name" 2>/dev
/null
&&
494 say
"$(eval_gettext "Submodule
'\$name' (\
$url) unregistered
for path
'\$displaypath'")"
499 is_tip_reachable
() (
500 sanitize_submodule_env
&&
502 rev=$
(git rev-list
-n 1 "$2" --not --all 2>/dev
/null
) &&
506 fetch_in_submodule
() (
507 sanitize_submodule_env
&&
513 git fetch $
(get_default_remote
) "$2" ;;
518 # Update each submodule path to correct revision, using clone and checkout as needed
520 # $@ = requested paths (default to all)
524 # parse $args after "submodule ... update".
547 case "$2" in '') usage
;; esac
548 reference
="--reference=$2"
564 case "$2" in '') usage
;; esac
572 case "$2" in '') usage
;; esac
595 cmd_init
"--" "$@" ||
return
599 git submodule--helper update-clone
${GIT_QUIET:+--quiet} \
600 ${wt_prefix:+--prefix "$wt_prefix"} \
601 ${prefix:+--recursive-prefix "$prefix"} \
602 ${update:+--update "$update"} \
603 ${reference:+--reference "$reference"} \
604 ${depth:+--depth "$depth"} \
606 "$@" ||
echo "#unmatched"
609 while read mode sha1 stage just_cloned sm_path
611 die_if_unmatched
"$mode"
613 name
=$
(git submodule--helper name
"$sm_path") ||
exit
614 url
=$
(git config submodule.
"$name".url
)
615 branch
=$
(get_submodule_config
"$name" branch master
)
616 if ! test -z "$update"
618 update_module
=$update
620 update_module
=$
(git config submodule.
"$name".update
)
621 if test -z "$update_module"
623 update_module
="checkout"
627 displaypath
=$
(relative_path
"$prefix$sm_path")
629 if test $just_cloned -eq 1
632 update_module
=checkout
634 subsha1
=$
(sanitize_submodule_env
; cd "$sm_path" &&
635 git rev-parse
--verify HEAD
) ||
636 die
"$(eval_gettext "Unable to
find current revision
in submodule path
'\$displaypath'")"
641 if test -z "$nofetch"
643 # Fetch remote before determining tracking $sha1
644 (sanitize_submodule_env
; cd "$sm_path" && git-fetch
) ||
645 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$sm_path'")"
647 remote_name
=$
(sanitize_submodule_env
; cd "$sm_path" && get_default_remote
)
648 sha1
=$
(sanitize_submodule_env
; cd "$sm_path" &&
649 git rev-parse
--verify "${remote_name}/${branch}") ||
650 die
"$(eval_gettext "Unable to
find current \
${remote_name}/\
${branch} revision
in submodule path
'\$sm_path'")"
653 if test "$subsha1" != "$sha1" ||
test -n "$force"
656 # If we don't already have a -f flag and the submodule has never been checked out
657 if test -z "$subsha1" && test -z "$force"
662 if test -z "$nofetch"
664 # Run fetch only if $sha1 isn't present or it
665 # is not reachable from a ref.
666 is_tip_reachable
"$sm_path" "$sha1" ||
667 fetch_in_submodule
"$sm_path" ||
668 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$displaypath'")"
670 # Now we tried the usual fetch, but $sha1 may
671 # not be reachable from any of the refs
672 is_tip_reachable
"$sm_path" "$sha1" ||
673 fetch_in_submodule
"$sm_path" "$sha1" ||
674 die
"$(eval_gettext "Fetched
in submodule path
'\$displaypath', but it did not contain \
$sha1. Direct fetching of that commit failed.
")"
678 case "$update_module" in
680 command="git checkout $subforce -q"
681 die_msg
="$(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$displaypath'")"
682 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': checked out
'\$sha1'")"
686 die_msg
="$(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$displaypath'")"
687 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': rebased into
'\$sha1'")"
688 must_die_on_failure
=yes
692 die_msg
="$(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$displaypath'")"
693 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': merged
in '\$sha1'")"
694 must_die_on_failure
=yes
697 command="${update_module#!}"
698 die_msg
="$(eval_gettext "Execution of
'\$command \$sha1' failed
in submodule path
'\$displaypath'")"
699 say_msg
="$(eval_gettext "Submodule path
'\$displaypath': '\$command \$sha1'")"
700 must_die_on_failure
=yes
703 die
"$(eval_gettext "Invalid update mode
'$update_module' for submodule
'$name'")"
706 if (sanitize_submodule_env
; cd "$sm_path" && $command "$sha1")
709 elif test -n "$must_die_on_failure"
711 die_with_status
2 "$die_msg"
713 err
="${err};$die_msg"
718 if test -n "$recursive"
721 prefix
=$
(relative_path
"$prefix$sm_path/")
723 sanitize_submodule_env
730 die_msg
="$(eval_gettext "Failed to recurse into submodule path
'\$displaypath'")"
733 err
="${err};$die_msg"
736 die_with_status
$res "$die_msg"
761 sanitize_submodule_env
763 git describe
"$2" 2>/dev
/null ||
764 git describe
--tags "$2" 2>/dev
/null ||
765 git describe
--contains "$2" 2>/dev
/null ||
766 git describe
--all --always "$2"
769 test -z "$revname" || revname
=" ($revname)"
772 # Show commit summary for submodules in index or working tree
774 # If '--cached' is given, show summary between index and given commit,
775 # or between working tree and given commit
777 # $@ = [commit (default 'HEAD'),] requested paths (default all)
784 # parse $args after "submodule ... summary".
799 isnumber
"$summary_limit" || usage
803 summary_limit
="${1#--summary-limit=}"
804 isnumber
"$summary_limit" || usage
820 test $summary_limit = 0 && return
822 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
826 elif test -z "$1" ||
test "$1" = "HEAD"
828 # before the first commit: compare with an empty tree
829 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
830 test -z "$1" ||
shift
838 die
"$(gettext "The
--cached option cannot be used with the
--files option
")"
844 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@
")"
845 # Get modified modules cared by user
846 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
847 sane_egrep
'^:([0-7]* )?160000' |
848 while read mod_src mod_dst sha1_src sha1_dst status sm_path
850 # Always show modules deleted or type-changed (blob<->module)
851 if test "$status" = D ||
test "$status" = T
853 printf '%s\n' "$sm_path"
856 # Respect the ignore setting for --for-status.
857 if test -n "$for_status"
859 name
=$
(git submodule--helper name
"$sm_path")
860 ignore_config
=$
(get_submodule_config
"$name" ignore none
)
861 test $status != A
&& test $ignore_config = all
&& continue
863 # Also show added or modified modules which are checked out
864 GIT_DIR
="$sm_path/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
865 printf '%s\n' "$sm_path"
869 test -z "$modules" && return
871 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
872 sane_egrep
'^:([0-7]* )?160000' |
874 while read mod_src mod_dst sha1_src sha1_dst status name
876 if test -z "$cached" &&
877 test $sha1_dst = 0000000000000000000000000000000000000000
881 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
883 100644 |
100755 |
120000)
884 sha1_dst
=$
(git hash-object
$name)
890 eval_gettextln
"unexpected mode \$mod_dst" >&2
897 test $mod_src = 160000 &&
898 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
901 test $mod_dst = 160000 &&
902 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
905 display_name
=$
(relative_path
"$name")
908 case "$missing_src,$missing_dst" in
910 errmsg
="$(eval_gettext " Warn
: \
$display_name doesn
't contain commit \$sha1_src")"
913 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \
$sha1_dst")"
916 errmsg
="$(eval_gettext " Warn
: \
$display_name doesn
't contain commits \$sha1_src and \$sha1_dst")"
921 if test $mod_src = 160000 && test $mod_dst = 160000
923 range="$sha1_src...$sha1_dst"
924 elif test $mod_src = 160000
930 GIT_DIR="$name/.git" \
931 git rev-list --first-parent $range -- | wc -l
933 total_commits=" ($(($total_commits + 0)))"
937 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
938 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
941 blob="$(gettext "blob")"
942 submodule="$(gettext "submodule")"
943 if test $mod_dst = 160000
945 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
947 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
950 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
954 # Don't give error msg
for modification whose dst is not submodule
955 # i.e. deleted or changed to blob
956 test $mod_dst = 160000 && echo "$errmsg"
958 if test $mod_src = 160000 && test $mod_dst = 160000
961 test $summary_limit -gt 0 && limit
="-$summary_limit"
962 GIT_DIR
="$name/.git" \
963 git log
$limit --pretty='format: %m %s' \
964 --first-parent $sha1_src...
$sha1_dst
965 elif test $mod_dst = 160000
967 GIT_DIR
="$name/.git" \
968 git log
--pretty='format: > %s' -1 $sha1_dst
970 GIT_DIR
="$name/.git" \
971 git log
--pretty='format: < %s' -1 $sha1_src
979 # List all submodules, prefixed with:
980 # - submodule not initialized
981 # + different revision checked out
983 # If --cached was specified the revision in the index will be printed
984 # instead of the currently checked out revision.
986 # $@ = requested paths (default to all)
990 # parse $args after "submodule ... status".
1017 git submodule--helper list
--prefix "$wt_prefix" "$@" |
1018 while read mode sha1 stage sm_path
1020 die_if_unmatched
"$mode"
1021 name
=$
(git submodule--helper name
"$sm_path") ||
exit
1022 url
=$
(git config submodule.
"$name".url
)
1023 displaypath
=$
(relative_path
"$prefix$sm_path")
1024 if test "$stage" = U
1026 say
"U$sha1 $displaypath"
1029 if test -z "$url" ||
1031 ! test -d "$sm_path"/.git
&&
1032 ! test -f "$sm_path"/.git
1035 say
"-$sha1 $displaypath"
1038 if git diff-files
--ignore-submodules=dirty
--quiet -- "$sm_path"
1040 set_name_rev
"$sm_path" "$sha1"
1041 say
" $sha1 $displaypath$revname"
1043 if test -z "$cached"
1045 sha1
=$
(sanitize_submodule_env
; cd "$sm_path" && git rev-parse
--verify HEAD
)
1047 set_name_rev
"$sm_path" "$sha1"
1048 say
"+$sha1 $displaypath$revname"
1051 if test -n "$recursive"
1054 prefix
="$displaypath/"
1055 sanitize_submodule_env
1060 die
"$(eval_gettext "Failed to recurse into submodule path
'\$sm_path'")"
1065 # Sync remote urls for submodules
1066 # This makes the value for remote.$remote.url match the value
1067 # specified in .gitmodules.
1095 git submodule--helper list
--prefix "$wt_prefix" "$@" |
1096 while read mode sha1 stage sm_path
1098 die_if_unmatched
"$mode"
1099 name
=$
(git submodule--helper name
"$sm_path")
1100 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
1102 # Possibly a url relative to parent
1105 # rewrite foo/bar as ../.. to find path from
1106 # submodule work tree to superproject work tree
1107 up_path
="$(printf '%s\n' "$sm_path" | sed "s
/[^
/][^
/]*/..
/g
")" &&
1108 # guarantee a trailing /
1109 up_path
=${up_path%/}/ &&
1110 # path from submodule work tree to submodule origin repo
1111 sub_origin_url
=$
(git submodule--helper resolve-relative-url
"$url" "$up_path") &&
1112 # path from superproject work tree to submodule origin repo
1113 super_config_url
=$
(git submodule--helper resolve-relative-url
"$url") ||
exit
1116 sub_origin_url
="$url"
1117 super_config_url
="$url"
1121 if git config
"submodule.$name.url" >/dev
/null
2>/dev
/null
1123 displaypath
=$
(relative_path
"$prefix$sm_path")
1124 say
"$(eval_gettext "Synchronizing submodule url
for '\$displaypath'")"
1125 git config submodule.
"$name".url
"$super_config_url"
1127 if test -e "$sm_path"/.git
1130 sanitize_submodule_env
1132 remote
=$
(get_default_remote
)
1133 git config remote.
"$remote".url
"$sub_origin_url"
1135 if test -n "$recursive"
1137 prefix
="$prefix$sm_path/"
1146 # This loop parses the command line arguments to find the
1147 # subcommand name to dispatch. Parsing of the subcommand specific
1148 # options are primarily done by the subcommand implementations.
1149 # Subcommand specific options such as --branch and --cached are
1150 # parsed here as well, for backward compatibility.
1152 while test $# != 0 && test -z "$command"
1155 add | foreach | init | deinit | update | status | summary | sync
)
1185 # No command word defaults to "status"
1186 if test -z "$command"
1196 # "-b branch" is accepted only by "add"
1197 if test -n "$branch" && test "$command" != add
1202 # "--cached" is accepted only by "status" and "summary"
1203 if test -n "$cached" && test "$command" != status
&& test "$command" != summary