3 # git-submodules.sh: add, init, update or list git submodules
5 # Copyright (c) 2007 Lars Hjemli
7 USAGE
="[--quiet] [--cached] \
8 [add [-b branch] <repo> <path>]|[status|init|update [-i|--init] [-N|--no-fetch] [--rebase|--merge]|summary [-n|--summary-limit <n>] [<commit>]] \
9 [--] [<path>...]|[foreach <command>]|[sync [--] [<path>...]]"
22 # Resolve relative url by appending to parent's url
23 resolve_relative_url
()
25 remote
=$
(get_default_remote
)
26 remoteurl
=$
(git config
"remote.$remote.url") ||
27 die
"remote ($remote) does not have a url defined in .git/config"
29 remoteurl
=${remoteurl%/}
35 remoteurl
="${remoteurl%/*}"
44 echo "$remoteurl/${url%/}"
48 # Get submodule info for registered submodules
49 # $@ = path to limit submodule list
53 git ls-files
--error-unmatch --stage -- "$@" |
grep '^160000 '
57 # Map submodule path to submodule name
63 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
64 re
=$
(printf '%s\n' "$1" |
sed -e 's/[].[^$\\*]/\\&/g')
65 name
=$
( git config
-f .gitmodules
--get-regexp '^submodule\..*\.path$' |
66 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
68 die
"No submodule mapping found in .gitmodules for path '$path'"
75 # Prior to calling, cmd_update checks that a possibly existing
76 # path is not a git repository.
77 # Likewise, cmd_add checks that path does not exist at all,
78 # since it is the location of a new submodule.
86 # If there already is a directory at the submodule path,
87 # expect it to be empty (since that is the default checkout
88 # action) and try to remove it.
89 # Note: if $path is a symlink to a directory the test will
90 # succeed but the rmdir will fail. We might want to fix this.
93 rmdir "$path" 2>/dev
/null ||
94 die
"Directory '$path' exist, but is neither empty nor a git repository"
98 die
"A file already exist at path '$path'"
100 if test -n "$reference"
102 git-clone
"$reference" -n "$url" "$path"
104 git-clone
-n "$url" "$path"
106 die
"Clone of '$url' into submodule path '$path' failed"
110 # Add a new submodule to the working tree, .gitmodules and the index
114 # optional branch is stored in global branch variable
118 # parse $args after "submodule ... add".
123 case "$2" in '') usage
;; esac
131 case "$2" in '') usage
;; esac
132 reference
="--reference=$2"
156 if test -z "$repo" -o -z "$path"; then
160 # assure repo is absolute or relative to parent
163 # dereference source url relative to parent's url
164 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
171 die
"repo URL: '$repo' must be absolute or begin with ./|../"
176 # multiple //; leading ./; /./; /../; trailing /
177 path
=$
(printf '%s/\n' "$path" |
187 git ls-files
--error-unmatch "$path" > /dev
/null
2>&1 &&
188 die
"'$path' already exists in the index"
190 # perhaps the path exists and is already a git repo, else clone it
193 if test -d "$path"/.git
-o -f "$path"/.git
195 echo "Adding existing repo at '$path' to the index"
197 die
"'$path' already exists and is not a valid git repo"
202 url
=$
(resolve_relative_url
"$repo") ||
exit
208 git config submodule.
"$path".url
"$url"
211 module_clone
"$path" "$realrepo" "$reference" ||
exit
215 # ash fails to wordsplit ${branch:+-b "$branch"...}
217 '') git checkout
-f -q ;;
218 ?
*) git checkout
-f -q -b "$branch" "origin/$branch" ;;
220 ) || die
"Unable to checkout submodule '$path'"
224 die
"Failed to add submodule '$path'"
226 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
227 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
228 git add .gitmodules ||
229 die
"Failed to register submodule '$path'"
233 # Execute an arbitrary command sequence in each checked out
236 # $@ = command to execute
241 while read mode sha1 stage path
243 if test -e "$path"/.git
245 say
"Entering '$path'"
246 name
=$
(module_name
"$path")
247 (cd "$path" && eval "$@") ||
248 die
"Stopping at '$path'; script returned non-zero status."
254 # Register submodules in .git/config
256 # $@ = requested paths (default to all)
260 # parse $args after "submodule ... init".
282 while read mode sha1 stage path
284 # Skip already registered paths
285 name
=$
(module_name
"$path") ||
exit
286 url
=$
(git config submodule.
"$name".url
)
287 test -z "$url" ||
continue
289 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
291 die
"No url found for submodule path '$path' in .gitmodules"
293 # Possibly a url relative to parent
296 url
=$
(resolve_relative_url
"$url") ||
exit
300 git config submodule.
"$name".url
"$url" ||
301 die
"Failed to register url for submodule path '$path'"
303 upd
="$(git config -f .gitmodules submodule."$name".update)"
305 git config submodule.
"$name".update
"$upd" ||
306 die
"Failed to register update mode for submodule path '$path'"
308 say
"Submodule '$name' ($url) registered for path '$path'"
313 # Update each submodule path to correct revision, using clone and checkout as needed
315 # $@ = requested paths (default to all)
319 # parse $args after "submodule ... update".
340 case "$2" in '') usage
;; esac
341 reference
="--reference=$2"
367 cmd_init
"--" "$@" ||
return
371 while read mode sha1 stage path
373 name
=$
(module_name
"$path") ||
exit
374 url
=$
(git config submodule.
"$name".url
)
375 update_module
=$
(git config submodule.
"$name".update
)
378 # Only mention uninitialized submodules when its
379 # path have been specified
381 say
"Submodule path '$path' not initialized" &&
382 say
"Maybe you want to use 'update --init'?"
386 if ! test -d "$path"/.git
-o -f "$path"/.git
388 module_clone
"$path" "$url" "$reference"||
exit
391 subsha1
=$
(unset GIT_DIR
; cd "$path" &&
392 git rev-parse
--verify HEAD
) ||
393 die
"Unable to find current revision in submodule path '$path'"
396 if ! test -z "$update"
398 update_module
=$update
401 if test "$subsha1" != "$sha1"
404 if test -z "$subsha1"
409 if test -z "$nofetch"
411 (unset GIT_DIR
; cd "$path" &&
413 die
"Unable to fetch in submodule path '$path'"
416 case "$update_module" in
428 command="git checkout $force -q"
434 (unset GIT_DIR
; cd "$path" && $command "$sha1") ||
435 die
"Unable to $action '$sha1' in submodule path '$path'"
436 say
"Submodule path '$path': $msg '$sha1'"
445 git describe
"$2" 2>/dev
/null ||
446 git describe
--tags "$2" 2>/dev
/null ||
447 git describe
--contains "$2" 2>/dev
/null ||
448 git describe
--all --always "$2"
451 test -z "$revname" || revname
=" ($revname)"
454 # Show commit summary for submodules in index or working tree
456 # If '--cached' is given, show summary between index and given commit,
457 # or between working tree and given commit
459 # $@ = [commit (default 'HEAD'),] requested paths (default all)
465 # parse $args after "submodule ... summary".
476 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
498 test $summary_limit = 0 && return
500 if rev=$
(git rev-parse
-q --verify "$1^0")
509 # Get modified modules cared by user
510 modules
=$
(git diff-index
$cached --raw $head -- "$@" |
511 egrep '^:([0-7]* )?160000' |
512 while read mod_src mod_dst sha1_src sha1_dst status name
514 # Always show modules deleted or type-changed (blob<->module)
515 test $status = D
-o $status = T
&& echo "$name" && continue
516 # Also show added or modified modules which are checked out
517 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
522 test -z "$modules" && return
524 git diff-index
$cached --raw $head -- $modules |
525 egrep '^:([0-7]* )?160000' |
527 while read mod_src mod_dst sha1_src sha1_dst status name
529 if test -z "$cached" &&
530 test $sha1_dst = 0000000000000000000000000000000000000000
534 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
536 100644 |
100755 |
120000)
537 sha1_dst
=$
(git hash-object
$name)
543 echo >&2 "unexpected mode $mod_dst"
550 test $mod_src = 160000 &&
551 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
554 test $mod_dst = 160000 &&
555 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
559 case "$missing_src,$missing_dst" in
561 errmsg
=" Warn: $name doesn't contain commit $sha1_src"
564 errmsg
=" Warn: $name doesn't contain commit $sha1_dst"
567 errmsg
=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
572 if test $mod_src = 160000 -a $mod_dst = 160000
574 range
="$sha1_src...$sha1_dst"
575 elif test $mod_src = 160000
581 GIT_DIR
="$name/.git" \
582 git log
--pretty=oneline
--first-parent $range |
wc -l
584 total_commits
=" ($(($total_commits + 0)))"
588 sha1_abbr_src
=$
(echo $sha1_src | cut
-c1-7)
589 sha1_abbr_dst
=$
(echo $sha1_dst | cut
-c1-7)
592 if test $mod_dst = 160000
594 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
596 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
599 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
603 # Don't give error msg for modification whose dst is not submodule
604 # i.e. deleted or changed to blob
605 test $mod_dst = 160000 && echo "$errmsg"
607 if test $mod_src = 160000 -a $mod_dst = 160000
610 test $summary_limit -gt 0 && limit
="-$summary_limit"
611 GIT_DIR
="$name/.git" \
612 git log
$limit --pretty='format: %m %s' \
613 --first-parent $sha1_src...
$sha1_dst
614 elif test $mod_dst = 160000
616 GIT_DIR
="$name/.git" \
617 git log
--pretty='format: > %s' -1 $sha1_dst
619 GIT_DIR
="$name/.git" \
620 git log
--pretty='format: < %s' -1 $sha1_src
626 if test -n "$for_status"; then
627 echo "# Modified submodules:"
629 sed -e 's|^|# |' -e 's|^# $|#|'
635 # List all submodules, prefixed with:
636 # - submodule not initialized
637 # + different revision checked out
639 # If --cached was specified the revision in the index will be printed
640 # instead of the currently checked out revision.
642 # $@ = requested paths (default to all)
646 # parse $args after "submodule ... status".
671 while read mode sha1 stage path
673 name
=$
(module_name
"$path") ||
exit
674 url
=$
(git config submodule.
"$name".url
)
675 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
680 set_name_rev
"$path" "$sha1"
681 if git diff-files
--quiet -- "$path"
683 say
" $sha1 $path$revname"
687 sha1
=$
(unset GIT_DIR
; cd "$path" && git rev-parse
--verify HEAD
)
688 set_name_rev
"$path" "$sha1"
690 say
"+$sha1 $path$revname"
695 # Sync remote urls for submodules
696 # This makes the value for remote.$remote.url match the value
697 # specified in .gitmodules.
722 while read mode sha1 stage path
724 name
=$
(module_name
"$path")
725 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
727 # Possibly a url relative to parent
730 url
=$
(resolve_relative_url
"$url") ||
exit
734 if test -e "$path"/.git
739 remote
=$
(get_default_remote
)
740 say
"Synchronizing submodule url for '$name'"
741 git config remote.
"$remote".url
"$url"
747 # This loop parses the command line arguments to find the
748 # subcommand name to dispatch. Parsing of the subcommand specific
749 # options are primarily done by the subcommand implementations.
750 # Subcommand specific options such as --branch and --cached are
751 # parsed here as well, for backward compatibility.
753 while test $# != 0 && test -z "$command"
756 add | foreach | init | update | status | summary | sync
)
786 # No command word defaults to "status"
787 test -n "$command" ||
command=status
789 # "-b branch" is accepted only by "add"
790 if test -n "$branch" && test "$command" != add
795 # "--cached" is accepted only by "status" and "summary"
796 if test -n "$cached" && test "$command" != status
-a "$command" != summary