3 # git-submodules.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 a
=$
(cd "$gitdir" && pwd)/
154 b
=$
(cd "$sm_path" && pwd)/
155 # Remove all common leading directories after a sanity check
156 if test "${a#$b}" != "$a" ||
test "${b#$a}" != "$b"; then
157 die
"$(eval_gettext "Gitdir
'\$a' is part of the submodule path
'\$b' or vice versa
")"
159 while test "${a%%/*}" = "${b%%/*}"
164 # Now chop off the trailing '/'s that were added in the beginning
168 # Turn each leading "*/" component into "../"
169 rel
=$
(echo $b |
sed -e 's|[^/][^/]*|..|g')
170 echo "gitdir: $rel/$a" >"$sm_path/.git"
172 rel
=$
(echo $a |
sed -e 's|[^/][^/]*|..|g')
173 (clear_local_git_env
; cd "$sm_path" && GIT_WORK_TREE
=. git config core.worktree
"$rel/$b")
177 # Add a new submodule to the working tree, .gitmodules and the index
181 # optional branch is stored in global branch variable
185 # parse $args after "submodule ... add".
190 case "$2" in '') usage
;; esac
201 case "$2" in '') usage
;; esac
202 reference
="--reference=$2"
226 if test -z "$sm_path"; then
227 sm_path
=$
(echo "$repo" |
228 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
231 if test -z "$repo" -o -z "$sm_path"; then
235 # assure repo is absolute or relative to parent
238 # dereference source url relative to parent's url
239 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
246 die
"$(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
251 # multiple //; leading ./; /./; /../; trailing /
252 sm_path
=$
(printf '%s/\n' "$sm_path" |
262 git ls-files
--error-unmatch "$sm_path" > /dev
/null
2>&1 &&
263 die
"$(eval_gettext "'\$sm_path' already exists
in the index
")"
265 if test -z "$force" && ! git add
--dry-run --ignore-missing "$sm_path" > /dev
/null
2>&1
268 The following path is ignored by one of your .gitignore files:
269 $(eval_gettextln $sm_path)
270 Use -f if you really want to add it.
275 # perhaps the path exists and is already a git repo, else clone it
276 if test -e "$sm_path"
278 if test -d "$sm_path"/.git
-o -f "$sm_path"/.git
280 eval_gettextln
"Adding existing repo at '\$sm_path' to the index"
282 die
"$(eval_gettext "'\$sm_path' already exists and is not a valid git repo
")"
287 module_clone
"$sm_path" "$realrepo" "$reference" ||
exit
291 # ash fails to wordsplit ${branch:+-b "$branch"...}
293 '') git checkout
-f -q ;;
294 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
296 ) || die
"$(eval_gettext "Unable to checkout submodule
'\$sm_path'")"
298 git config submodule.
"$sm_path".url
"$realrepo"
300 git add
$force "$sm_path" ||
301 die
"$(eval_gettext "Failed to add submodule
'\$sm_path'")"
303 git config
-f .gitmodules submodule.
"$sm_path".path
"$sm_path" &&
304 git config
-f .gitmodules submodule.
"$sm_path".url
"$repo" &&
305 git add
--force .gitmodules ||
306 die
"$(eval_gettext "Failed to register submodule
'\$sm_path'")"
310 # Execute an arbitrary command sequence in each checked out
313 # $@ = command to execute
317 # parse $args after "submodule ... foreach".
339 # dup stdin so that it can be restored when running the external
340 # command in the subshell (and a recursive call to this function)
344 while read mode sha1 stage sm_path
346 if test -e "$sm_path"/.git
348 say
"$(eval_gettext "Entering
'\$prefix\$sm_path'")"
349 name
=$
(module_name
"$sm_path")
351 prefix
="$prefix$sm_path/"
353 # we make $path available to scripts ...
357 if test -n "$recursive"
359 cmd_foreach
"--recursive" "$@"
362 die
"$(eval_gettext "Stopping
at '\$sm_path'; script returned non-zero status.
")"
368 # Register submodules in .git/config
370 # $@ = requested paths (default to all)
374 # parse $args after "submodule ... init".
396 while read mode sha1 stage sm_path
398 # Skip already registered paths
399 name
=$
(module_name
"$sm_path") ||
exit
400 if test -z "$(git config "submodule.
$name.url
")"
402 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
404 die
"$(eval_gettext "No url found
for submodule path
'\$sm_path' in .gitmodules
")"
406 # Possibly a url relative to parent
409 url
=$
(resolve_relative_url
"$url") ||
exit
412 git config submodule.
"$name".url
"$url" ||
413 die
"$(eval_gettext "Failed to register url
for submodule path
'\$sm_path'")"
416 # Copy "update" setting when it is not set yet
417 upd
="$(git config -f .gitmodules submodule."$name".update)"
419 test -n "$(git config submodule."$name".update)" ||
420 git config submodule.
"$name".update
"$upd" ||
421 die
"$(eval_gettext "Failed to register update mode
for submodule path
'\$sm_path'")"
423 say
"$(eval_gettext "Submodule
'\$name' (\
$url) registered
for path
'\$sm_path'")"
428 # Update each submodule path to correct revision, using clone and checkout as needed
430 # $@ = requested paths (default to all)
434 # parse $args after "submodule ... update".
455 case "$2" in '') usage
;; esac
456 reference
="--reference=$2"
457 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
483 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
489 cmd_init
"--" "$@" ||
return
495 while read mode sha1 stage sm_path
499 echo >&2 "Skipping unmerged submodule $sm_path"
502 name
=$
(module_name
"$sm_path") ||
exit
503 url
=$
(git config submodule.
"$name".url
)
504 if ! test -z "$update"
506 update_module
=$update
508 update_module
=$
(git config submodule.
"$name".update
)
511 if test "$update_module" = "none"
513 echo "Skipping submodule '$sm_path'"
519 # Only mention uninitialized submodules when its
520 # path have been specified
522 say
"$(eval_gettext "Submodule path
'\$sm_path' not initialized
523 Maybe you want to use
'update --init'?
")"
527 if ! test -d "$sm_path"/.git
-o -f "$sm_path"/.git
529 module_clone
"$sm_path" "$url" "$reference"||
exit
530 cloned_modules
="$cloned_modules;$name"
533 subsha1
=$
(clear_local_git_env
; cd "$sm_path" &&
534 git rev-parse
--verify HEAD
) ||
535 die
"$(eval_gettext "Unable to
find current revision
in submodule path
'\$sm_path'")"
538 if test "$subsha1" != "$sha1"
541 # If we don't already have a -f flag and the submodule has never been checked out
542 if test -z "$subsha1" -a -z "$force"
547 if test -z "$nofetch"
549 # Run fetch only if $sha1 isn't present or it
550 # is not reachable from a ref.
551 (clear_local_git_env
; cd "$sm_path" &&
552 ( (rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
553 test -z "$rev") || git-fetch
)) ||
554 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$sm_path'")"
557 # Is this something we just cloned?
558 case ";$cloned_modules;" in
560 # then there is no local change to integrate
565 case "$update_module" in
568 die_msg
="$(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$sm_path'")"
569 say_msg
="$(eval_gettext "Submodule path
'\$sm_path': rebased into
'\$sha1'")"
570 must_die_on_failure
=yes
574 die_msg
="$(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$sm_path'")"
575 say_msg
="$(eval_gettext "Submodule path
'\$sm_path': merged
in '\$sha1'")"
576 must_die_on_failure
=yes
579 command="git checkout $subforce -q"
580 die_msg
="$(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$sm_path'")"
581 say_msg
="$(eval_gettext "Submodule path
'\$sm_path': checked out
'\$sha1'")"
585 if (clear_local_git_env
; cd "$sm_path" && $command "$sha1")
588 elif test -n "$must_die_on_failure"
590 die_with_status
2 "$die_msg"
592 err
="${err};$die_msg"
597 if test -n "$recursive"
599 (clear_local_git_env
; cd "$sm_path" && eval cmd_update
"$orig_flags")
603 die_msg
="$(eval_gettext "Failed to recurse into submodule path
'\$sm_path'")"
606 err
="${err};$die_msg"
609 die_with_status
$res "$die_msg"
636 git describe
"$2" 2>/dev
/null ||
637 git describe
--tags "$2" 2>/dev
/null ||
638 git describe
--contains "$2" 2>/dev
/null ||
639 git describe
--all --always "$2"
642 test -z "$revname" || revname
=" ($revname)"
645 # Show commit summary for submodules in index or working tree
647 # If '--cached' is given, show summary between index and given commit,
648 # or between working tree and given commit
650 # $@ = [commit (default 'HEAD'),] requested paths (default all)
657 # parse $args after "submodule ... summary".
671 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
693 test $summary_limit = 0 && return
695 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
699 elif test -z "$1" -o "$1" = "HEAD"
701 # before the first commit: compare with an empty tree
702 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
703 test -z "$1" ||
shift
711 die
"$(gettext -- "--cached cannot be used with
--files")"
717 # Get modified modules cared by user
718 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
719 sane_egrep
'^:([0-7]* )?160000' |
720 while read mod_src mod_dst sha1_src sha1_dst status name
722 # Always show modules deleted or type-changed (blob<->module)
723 test $status = D
-o $status = T
&& echo "$name" && continue
724 # Also show added or modified modules which are checked out
725 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
730 test -z "$modules" && return
732 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
733 sane_egrep
'^:([0-7]* )?160000' |
735 while read mod_src mod_dst sha1_src sha1_dst status name
737 if test -z "$cached" &&
738 test $sha1_dst = 0000000000000000000000000000000000000000
742 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
744 100644 |
100755 |
120000)
745 sha1_dst
=$
(git hash-object
$name)
751 eval_gettextln
"unexpected mode \$mod_dst" >&2
758 test $mod_src = 160000 &&
759 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
762 test $mod_dst = 160000 &&
763 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
767 case "$missing_src,$missing_dst" in
769 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commit \$sha1_src")"
772 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \
$sha1_dst")"
775 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commits \$sha1_src and \$sha1_dst")"
780 if test $mod_src = 160000 -a $mod_dst = 160000
782 range="$sha1_src...$sha1_dst"
783 elif test $mod_src = 160000
789 GIT_DIR="$name/.git" \
790 git rev-list --first-parent $range -- | wc -l
792 total_commits=" ($(($total_commits + 0)))"
796 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
797 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
800 blob="$(gettext "blob")"
801 submodule="$(gettext "submodule")"
802 if test $mod_dst = 160000
804 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
806 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
809 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
813 # Don't give error msg
for modification whose dst is not submodule
814 # i.e. deleted or changed to blob
815 test $mod_dst = 160000 && echo "$errmsg"
817 if test $mod_src = 160000 -a $mod_dst = 160000
820 test $summary_limit -gt 0 && limit
="-$summary_limit"
821 GIT_DIR
="$name/.git" \
822 git log
$limit --pretty='format: %m %s' \
823 --first-parent $sha1_src...
$sha1_dst
824 elif test $mod_dst = 160000
826 GIT_DIR
="$name/.git" \
827 git log
--pretty='format: > %s' -1 $sha1_dst
829 GIT_DIR
="$name/.git" \
830 git log
--pretty='format: < %s' -1 $sha1_src
836 if test -n "$for_status"; then
837 if [ -n "$files" ]; then
838 status_msg
="$(gettextln "# Submodules changed but not updated:")"
840 status_msg
="$(gettextln "# Submodule changes to be committed:")"
842 status_sed
=$
(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