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] [--reference <repository>] [--] <repository> [<path>]
9 or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
10 or: $dashless [--quiet] init [--] [<path>...]
11 or: $dashless [--quiet] update [--init] [-N|--no-fetch] [-f|--force] [--rebase] [--reference <repository>] [--merge] [--recursive] [--] [<path>...]
12 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
13 or: $dashless [--quiet] foreach [--recursive] <command>
14 or: $dashless [--quiet] sync [--] [<path>...]"
33 # Resolve relative url by appending to parent's url
34 resolve_relative_url
()
36 remote
=$
(get_default_remote
)
37 remoteurl
=$
(git config
"remote.$remote.url") ||
38 remoteurl
=$
(pwd) # the repository is its own authoritative upstream
40 remoteurl
=${remoteurl%/}
49 remoteurl
="${remoteurl%/*}"
52 remoteurl
="${remoteurl%:*}"
56 die
"$(eval_gettext "cannot strip one component off url
'\$remoteurl'")"
67 echo "$remoteurl$sep${url%/}"
71 # Get submodule info for registered submodules
72 # $@ = path to limit submodule list
76 git ls-files
--error-unmatch --stage -- "$@" |
79 my ($null_sha1) = ("0" x 40);
82 my ($mode, $sha1, $stage, $path) =
83 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
84 next unless $mode eq "160000";
86 if (!$unmerged{$path}++) {
87 print "$mode $null_sha1 U\t$path\n";
97 # Map submodule path to submodule name
103 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
105 re
=$
(printf '%s\n' "$1" |
sed -e 's/[].[^$\\*]/\\&/g')
106 name
=$
( git config
-f .gitmodules
--get-regexp '^submodule\..*\.path$' |
107 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
109 die
"$(eval_gettext "No submodule mapping found
in .gitmodules
for path
'\$sm_path'")"
116 # Prior to calling, cmd_update checks that a possibly existing
117 # path is not a git repository.
118 # Likewise, cmd_add checks that path does not exist at all,
119 # since it is the location of a new submodule.
127 if test -n "$GIT_QUIET"
134 name
=$
(module_name
"$sm_path" 2>/dev
/null
)
135 test -n "$name" || name
="$sm_path"
136 base_name
=$
(dirname "$name")
138 gitdir
=$
(git rev-parse
--git-dir)
139 gitdir_base
="$gitdir/modules/$base_name"
140 gitdir
="$gitdir/modules/$name"
145 rm -f "$gitdir/index"
147 mkdir
-p "$gitdir_base"
148 git clone
$quiet -n ${reference:+"$reference"} \
149 --separate-git-dir "$gitdir" "$url" "$sm_path" ||
150 die
"$(eval_gettext "Clone of
'\$url' into submodule path
'\$sm_path' failed
")"
153 # We already are at the root of the work tree but cd_to_toplevel will
154 # resolve any symlinks that might be present in $PWD
155 a
=$
(cd_to_toplevel
&& cd "$gitdir" && pwd)/
156 b
=$
(cd_to_toplevel
&& cd "$sm_path" && pwd)/
157 # normalize Windows-style absolute paths to POSIX-style absolute paths
158 case $a in [a-zA-Z
]:/*) a
=/${a%%:*}${a#*:} ;; esac
159 case $b in [a-zA-Z
]:/*) b
=/${b%%:*}${b#*:} ;; esac
160 # Remove all common leading directories after a sanity check
161 if test "${a#$b}" != "$a" ||
test "${b#$a}" != "$b"; then
162 die
"$(eval_gettext "Gitdir
'\$a' is part of the submodule path
'\$b' or vice versa
")"
164 while test "${a%%/*}" = "${b%%/*}"
169 # Now chop off the trailing '/'s that were added in the beginning
173 # Turn each leading "*/" component into "../"
174 rel
=$
(echo $b |
sed -e 's|[^/][^/]*|..|g')
175 echo "gitdir: $rel/$a" >"$sm_path/.git"
177 rel
=$
(echo $a |
sed -e 's|[^/][^/]*|..|g')
178 (clear_local_git_env
; cd "$sm_path" && GIT_WORK_TREE
=. git config core.worktree
"$rel/$b")
182 # Add a new submodule to the working tree, .gitmodules and the index
186 # optional branch is stored in global branch variable
190 # parse $args after "submodule ... add".
195 case "$2" in '') usage
;; esac
206 case "$2" in '') usage
;; esac
207 reference
="--reference=$2"
231 if test -z "$sm_path"; then
232 sm_path
=$
(echo "$repo" |
233 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
236 if test -z "$repo" -o -z "$sm_path"; then
240 # assure repo is absolute or relative to parent
243 # dereference source url relative to parent's url
244 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
251 die
"$(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
256 # multiple //; leading ./; /./; /../; trailing /
257 sm_path
=$
(printf '%s/\n' "$sm_path" |
267 git ls-files
--error-unmatch "$sm_path" > /dev
/null
2>&1 &&
268 die
"$(eval_gettext "'\$sm_path' already exists
in the index
")"
270 if test -z "$force" && ! git add
--dry-run --ignore-missing "$sm_path" > /dev
/null
2>&1
272 eval_gettextln
"The following path is ignored by one of your .gitignore files:
274 Use -f if you really want to add it." >&2
278 # perhaps the path exists and is already a git repo, else clone it
279 if test -e "$sm_path"
281 if test -d "$sm_path"/.git
-o -f "$sm_path"/.git
283 eval_gettextln
"Adding existing repo at '\$sm_path' to the index"
285 die
"$(eval_gettext "'\$sm_path' already exists and is not a valid git repo
")"
290 module_clone
"$sm_path" "$realrepo" "$reference" ||
exit
294 # ash fails to wordsplit ${branch:+-b "$branch"...}
296 '') git checkout
-f -q ;;
297 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
299 ) || die
"$(eval_gettext "Unable to checkout submodule
'\$sm_path'")"
301 git config submodule.
"$sm_path".url
"$realrepo"
303 git add
$force "$sm_path" ||
304 die
"$(eval_gettext "Failed to add submodule
'\$sm_path'")"
306 git config
-f .gitmodules submodule.
"$sm_path".path
"$sm_path" &&
307 git config
-f .gitmodules submodule.
"$sm_path".url
"$repo" &&
308 git add
--force .gitmodules ||
309 die
"$(eval_gettext "Failed to register submodule
'\$sm_path'")"
313 # Execute an arbitrary command sequence in each checked out
316 # $@ = command to execute
320 # parse $args after "submodule ... foreach".
342 # dup stdin so that it can be restored when running the external
343 # command in the subshell (and a recursive call to this function)
347 while read mode sha1 stage sm_path
349 if test -e "$sm_path"/.git
351 say
"$(eval_gettext "Entering
'\$prefix\$sm_path'")"
352 name
=$
(module_name
"$sm_path")
354 prefix
="$prefix$sm_path/"
356 # we make $path available to scripts ...
360 if test -n "$recursive"
362 cmd_foreach
"--recursive" "$@"
365 die
"$(eval_gettext "Stopping
at '\$sm_path'; script returned non-zero status.
")"
371 # Register submodules in .git/config
373 # $@ = requested paths (default to all)
377 # parse $args after "submodule ... init".
399 while read mode sha1 stage sm_path
401 name
=$
(module_name
"$sm_path") ||
exit
403 # Copy url setting when it is not set yet
404 if test -z "$(git config "submodule.
$name.url
")"
406 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
408 die
"$(eval_gettext "No url found
for submodule path
'\$sm_path' in .gitmodules
")"
410 # Possibly a url relative to parent
413 url
=$
(resolve_relative_url
"$url") ||
exit
416 git config submodule.
"$name".url
"$url" ||
417 die
"$(eval_gettext "Failed to register url
for submodule path
'\$sm_path'")"
419 say
"$(eval_gettext "Submodule
'\$name' (\
$url) registered
for path
'\$sm_path'")"
422 # Copy "update" setting when it is not set yet
423 upd
="$(git config -f .gitmodules submodule."$name".update)"
425 test -n "$(git config submodule."$name".update)" ||
426 git config submodule.
"$name".update
"$upd" ||
427 die
"$(eval_gettext "Failed to register update mode
for submodule path
'\$sm_path'")"
432 # Update each submodule path to correct revision, using clone and checkout as needed
434 # $@ = requested paths (default to all)
438 # parse $args after "submodule ... update".
459 case "$2" in '') usage
;; esac
460 reference
="--reference=$2"
461 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
487 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
493 cmd_init
"--" "$@" ||
return
499 while read mode sha1 stage sm_path
503 echo >&2 "Skipping unmerged submodule $sm_path"
506 name
=$
(module_name
"$sm_path") ||
exit
507 url
=$
(git config submodule.
"$name".url
)
508 if ! test -z "$update"
510 update_module
=$update
512 update_module
=$
(git config submodule.
"$name".update
)
515 if test "$update_module" = "none"
517 echo "Skipping submodule '$sm_path'"
523 # Only mention uninitialized submodules when its
524 # path have been specified
526 say
"$(eval_gettext "Submodule path
'\$sm_path' not initialized
527 Maybe you want to use
'update --init'?
")"
531 if ! test -d "$sm_path"/.git
-o -f "$sm_path"/.git
533 module_clone
"$sm_path" "$url" "$reference"||
exit
534 cloned_modules
="$cloned_modules;$name"
537 subsha1
=$
(clear_local_git_env
; cd "$sm_path" &&
538 git rev-parse
--verify HEAD
) ||
539 die
"$(eval_gettext "Unable to
find current revision
in submodule path
'\$sm_path'")"
542 if test "$subsha1" != "$sha1"
545 # If we don't already have a -f flag and the submodule has never been checked out
546 if test -z "$subsha1" -a -z "$force"
551 if test -z "$nofetch"
553 # Run fetch only if $sha1 isn't present or it
554 # is not reachable from a ref.
555 (clear_local_git_env
; cd "$sm_path" &&
556 ( (rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
557 test -z "$rev") || git-fetch
)) ||
558 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$sm_path'")"
561 # Is this something we just cloned?
562 case ";$cloned_modules;" in
564 # then there is no local change to integrate
569 case "$update_module" in
572 die_msg
="$(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$sm_path'")"
573 say_msg
="$(eval_gettext "Submodule path
'\$sm_path': rebased into
'\$sha1'")"
574 must_die_on_failure
=yes
578 die_msg
="$(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$sm_path'")"
579 say_msg
="$(eval_gettext "Submodule path
'\$sm_path': merged
in '\$sha1'")"
580 must_die_on_failure
=yes
583 command="git checkout $subforce -q"
584 die_msg
="$(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$sm_path'")"
585 say_msg
="$(eval_gettext "Submodule path
'\$sm_path': checked out
'\$sha1'")"
589 if (clear_local_git_env
; cd "$sm_path" && $command "$sha1")
592 elif test -n "$must_die_on_failure"
594 die_with_status
2 "$die_msg"
596 err
="${err};$die_msg"
601 if test -n "$recursive"
603 (clear_local_git_env
; cd "$sm_path" && eval cmd_update
"$orig_flags")
607 die_msg
="$(eval_gettext "Failed to recurse into submodule path
'\$sm_path'")"
610 err
="${err};$die_msg"
613 die_with_status
$res "$die_msg"
640 git describe
"$2" 2>/dev
/null ||
641 git describe
--tags "$2" 2>/dev
/null ||
642 git describe
--contains "$2" 2>/dev
/null ||
643 git describe
--all --always "$2"
646 test -z "$revname" || revname
=" ($revname)"
649 # Show commit summary for submodules in index or working tree
651 # If '--cached' is given, show summary between index and given commit,
652 # or between working tree and given commit
654 # $@ = [commit (default 'HEAD'),] requested paths (default all)
661 # parse $args after "submodule ... summary".
675 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
697 test $summary_limit = 0 && return
699 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
703 elif test -z "$1" -o "$1" = "HEAD"
705 # before the first commit: compare with an empty tree
706 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
707 test -z "$1" ||
shift
715 die
"$(gettext -- "--cached cannot be used with
--files")"
721 # Get modified modules cared by user
722 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
723 sane_egrep
'^:([0-7]* )?160000' |
724 while read mod_src mod_dst sha1_src sha1_dst status name
726 # Always show modules deleted or type-changed (blob<->module)
727 test $status = D
-o $status = T
&& echo "$name" && continue
728 # Also show added or modified modules which are checked out
729 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
734 test -z "$modules" && return
736 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
737 sane_egrep
'^:([0-7]* )?160000' |
739 while read mod_src mod_dst sha1_src sha1_dst status name
741 if test -z "$cached" &&
742 test $sha1_dst = 0000000000000000000000000000000000000000
746 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
748 100644 |
100755 |
120000)
749 sha1_dst
=$
(git hash-object
$name)
755 eval_gettextln
"unexpected mode \$mod_dst" >&2
762 test $mod_src = 160000 &&
763 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
766 test $mod_dst = 160000 &&
767 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
771 case "$missing_src,$missing_dst" in
773 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commit \$sha1_src")"
776 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \
$sha1_dst")"
779 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commits \$sha1_src and \$sha1_dst")"
784 if test $mod_src = 160000 -a $mod_dst = 160000
786 range="$sha1_src...$sha1_dst"
787 elif test $mod_src = 160000
793 GIT_DIR="$name/.git" \
794 git rev-list --first-parent $range -- | wc -l
796 total_commits=" ($(($total_commits + 0)))"
800 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
801 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
804 blob="$(gettext "blob")"
805 submodule="$(gettext "submodule")"
806 if test $mod_dst = 160000
808 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
810 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
813 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
817 # Don't give error msg
for modification whose dst is not submodule
818 # i.e. deleted or changed to blob
819 test $mod_dst = 160000 && echo "$errmsg"
821 if test $mod_src = 160000 -a $mod_dst = 160000
824 test $summary_limit -gt 0 && limit
="-$summary_limit"
825 GIT_DIR
="$name/.git" \
826 git log
$limit --pretty='format: %m %s' \
827 --first-parent $sha1_src...
$sha1_dst
828 elif test $mod_dst = 160000
830 GIT_DIR
="$name/.git" \
831 git log
--pretty='format: > %s' -1 $sha1_dst
833 GIT_DIR
="$name/.git" \
834 git log
--pretty='format: < %s' -1 $sha1_src
840 if test -n "$for_status"; then
841 if [ -n "$files" ]; then
842 gettextln
"# Submodules changed but not updated:"
844 gettextln
"# Submodule changes to be committed:"
847 sed -e 's|^|# |' -e 's|^# $|#|'
853 # List all submodules, prefixed with:
854 # - submodule not initialized
855 # + different revision checked out
857 # If --cached was specified the revision in the index will be printed
858 # instead of the currently checked out revision.
860 # $@ = requested paths (default to all)
864 # parse $args after "submodule ... status".
889 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
894 while read mode sha1 stage sm_path
896 name
=$
(module_name
"$sm_path") ||
exit
897 url
=$
(git config submodule.
"$name".url
)
898 displaypath
="$prefix$sm_path"
901 say
"U$sha1 $displaypath"
904 if test -z "$url" ||
! test -d "$sm_path"/.git
-o -f "$sm_path"/.git
906 say
"-$sha1 $displaypath"
909 set_name_rev
"$sm_path" "$sha1"
910 if git diff-files
--ignore-submodules=dirty
--quiet -- "$sm_path"
912 say
" $sha1 $displaypath$revname"
916 sha1
=$
(clear_local_git_env
; cd "$sm_path" && git rev-parse
--verify HEAD
)
917 set_name_rev
"$sm_path" "$sha1"
919 say
"+$sha1 $displaypath$revname"
922 if test -n "$recursive"
925 prefix
="$displaypath/"
928 eval cmd_status
"$orig_args"
930 die
"$(eval_gettext "Failed to recurse into submodule path
'\$sm_path'")"
935 # Sync remote urls for submodules
936 # This makes the value for remote.$remote.url match the value
937 # specified in .gitmodules.
962 while read mode sha1 stage sm_path
964 name
=$
(module_name
"$sm_path")
965 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
967 # Possibly a url relative to parent
970 url
=$
(resolve_relative_url
"$url") ||
exit
974 if git config
"submodule.$name.url" >/dev
/null
2>/dev
/null
976 say
"$(eval_gettext "Synchronizing submodule url
for '\$name'")"
977 git config submodule.
"$name".url
"$url"
979 if test -e "$sm_path"/.git
984 remote
=$
(get_default_remote
)
985 git config remote.
"$remote".url
"$url"
992 # This loop parses the command line arguments to find the
993 # subcommand name to dispatch. Parsing of the subcommand specific
994 # options are primarily done by the subcommand implementations.
995 # Subcommand specific options such as --branch and --cached are
996 # parsed here as well, for backward compatibility.
998 while test $# != 0 && test -z "$command"
1001 add | foreach | init | update | status | summary | sync
)
1031 # No command word defaults to "status"
1032 test -n "$command" ||
command=status
1034 # "-b branch" is accepted only by "add"
1035 if test -n "$branch" && test "$command" != add
1040 # "--cached" is accepted only by "status" and "summary"
1041 if test -n "$cached" && test "$command" != status
-a "$command" != summary