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] [--reference <repository>] [--] <repository> <path>
9 or: $dashless [--quiet] status [--cached] [--] [<path>...]
10 or: $dashless [--quiet] init [--] [<path>...]
11 or: $dashless [--quiet] update [--init] [-N|--no-fetch] [--rebase] [--reference <repository>] [--merge] [--] [<path>...]
12 or: $dashless [--quiet] summary [--cached] [--summary-limit <n>] [commit] [--] [<path>...]
13 or: $dashless [--quiet] foreach [--recursive] <command>
14 or: $dashless [--quiet] sync [--] [<path>...]"
28 # Resolve relative url by appending to parent's url
29 resolve_relative_url
()
31 remote
=$
(get_default_remote
)
32 remoteurl
=$
(git config
"remote.$remote.url") ||
33 die
"remote ($remote) does not have a url defined in .git/config"
35 remoteurl
=${remoteurl%/}
41 remoteurl
="${remoteurl%/*}"
50 echo "$remoteurl/${url%/}"
54 # Get submodule info for registered submodules
55 # $@ = path to limit submodule list
59 git ls-files
--error-unmatch --stage -- "$@" |
grep '^160000 '
63 # Map submodule path to submodule name
69 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
70 re
=$
(printf '%s\n' "$1" |
sed -e 's/[].[^$\\*]/\\&/g')
71 name
=$
( git config
-f .gitmodules
--get-regexp '^submodule\..*\.path$' |
72 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
74 die
"No submodule mapping found in .gitmodules for path '$path'"
81 # Prior to calling, cmd_update checks that a possibly existing
82 # path is not a git repository.
83 # Likewise, cmd_add checks that path does not exist at all,
84 # since it is the location of a new submodule.
92 # If there already is a directory at the submodule path,
93 # expect it to be empty (since that is the default checkout
94 # action) and try to remove it.
95 # Note: if $path is a symlink to a directory the test will
96 # succeed but the rmdir will fail. We might want to fix this.
99 rmdir "$path" 2>/dev
/null ||
100 die
"Directory '$path' exist, but is neither empty nor a git repository"
104 die
"A file already exist at path '$path'"
106 if test -n "$reference"
108 git-clone
"$reference" -n "$url" "$path"
110 git-clone
-n "$url" "$path"
112 die
"Clone of '$url' into submodule path '$path' failed"
116 # Add a new submodule to the working tree, .gitmodules and the index
120 # optional branch is stored in global branch variable
124 # parse $args after "submodule ... add".
129 case "$2" in '') usage
;; esac
137 case "$2" in '') usage
;; esac
138 reference
="--reference=$2"
162 if test -z "$repo" -o -z "$path"; then
166 # assure repo is absolute or relative to parent
169 # dereference source url relative to parent's url
170 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
177 die
"repo URL: '$repo' must be absolute or begin with ./|../"
182 # multiple //; leading ./; /./; /../; trailing /
183 path
=$
(printf '%s/\n' "$path" |
193 git ls-files
--error-unmatch "$path" > /dev
/null
2>&1 &&
194 die
"'$path' already exists in the index"
196 # perhaps the path exists and is already a git repo, else clone it
199 if test -d "$path"/.git
-o -f "$path"/.git
201 echo "Adding existing repo at '$path' to the index"
203 die
"'$path' already exists and is not a valid git repo"
208 url
=$
(resolve_relative_url
"$repo") ||
exit
214 git config submodule.
"$path".url
"$url"
217 module_clone
"$path" "$realrepo" "$reference" ||
exit
221 # ash fails to wordsplit ${branch:+-b "$branch"...}
223 '') git checkout
-f -q ;;
224 ?
*) git checkout
-f -q -b "$branch" "origin/$branch" ;;
226 ) || die
"Unable to checkout submodule '$path'"
230 die
"Failed to add submodule '$path'"
232 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
233 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
234 git add .gitmodules ||
235 die
"Failed to register submodule '$path'"
239 # Execute an arbitrary command sequence in each checked out
242 # $@ = command to execute
246 # parse $args after "submodule ... foreach".
267 while read mode sha1 stage path
269 if test -e "$path"/.git
271 say
"Entering '$prefix$path'"
272 name
=$
(module_name
"$path")
274 prefix
="$prefix$path/"
278 if test -n "$recursive"
280 cmd_foreach
"--recursive" "$@"
283 die
"Stopping at '$path'; script returned non-zero status."
289 # Register submodules in .git/config
291 # $@ = requested paths (default to all)
295 # parse $args after "submodule ... init".
317 while read mode sha1 stage path
319 # Skip already registered paths
320 name
=$
(module_name
"$path") ||
exit
321 url
=$
(git config submodule.
"$name".url
)
322 test -z "$url" ||
continue
324 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
326 die
"No url found for submodule path '$path' in .gitmodules"
328 # Possibly a url relative to parent
331 url
=$
(resolve_relative_url
"$url") ||
exit
335 git config submodule.
"$name".url
"$url" ||
336 die
"Failed to register url for submodule path '$path'"
338 upd
="$(git config -f .gitmodules submodule."$name".update)"
340 git config submodule.
"$name".update
"$upd" ||
341 die
"Failed to register update mode for submodule path '$path'"
343 say
"Submodule '$name' ($url) registered for path '$path'"
348 # Update each submodule path to correct revision, using clone and checkout as needed
350 # $@ = requested paths (default to all)
354 # parse $args after "submodule ... update".
375 case "$2" in '') usage
;; esac
376 reference
="--reference=$2"
402 cmd_init
"--" "$@" ||
return
406 while read mode sha1 stage path
408 name
=$
(module_name
"$path") ||
exit
409 url
=$
(git config submodule.
"$name".url
)
410 update_module
=$
(git config submodule.
"$name".update
)
413 # Only mention uninitialized submodules when its
414 # path have been specified
416 say
"Submodule path '$path' not initialized" &&
417 say
"Maybe you want to use 'update --init'?"
421 if ! test -d "$path"/.git
-o -f "$path"/.git
423 module_clone
"$path" "$url" "$reference"||
exit
426 subsha1
=$
(unset GIT_DIR
; cd "$path" &&
427 git rev-parse
--verify HEAD
) ||
428 die
"Unable to find current revision in submodule path '$path'"
431 if ! test -z "$update"
433 update_module
=$update
436 if test "$subsha1" != "$sha1"
439 if test -z "$subsha1"
444 if test -z "$nofetch"
446 (unset GIT_DIR
; cd "$path" &&
448 die
"Unable to fetch in submodule path '$path'"
451 case "$update_module" in
463 command="git checkout $force -q"
469 (unset GIT_DIR
; cd "$path" && $command "$sha1") ||
470 die
"Unable to $action '$sha1' in submodule path '$path'"
471 say
"Submodule path '$path': $msg '$sha1'"
480 git describe
"$2" 2>/dev
/null ||
481 git describe
--tags "$2" 2>/dev
/null ||
482 git describe
--contains "$2" 2>/dev
/null ||
483 git describe
--all --always "$2"
486 test -z "$revname" || revname
=" ($revname)"
489 # Show commit summary for submodules in index or working tree
491 # If '--cached' is given, show summary between index and given commit,
492 # or between working tree and given commit
494 # $@ = [commit (default 'HEAD'),] requested paths (default all)
500 # parse $args after "submodule ... summary".
511 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
533 test $summary_limit = 0 && return
535 if rev=$
(git rev-parse
-q --verify "$1^0")
544 # Get modified modules cared by user
545 modules
=$
(git diff-index
$cached --raw $head -- "$@" |
546 egrep '^:([0-7]* )?160000' |
547 while read mod_src mod_dst sha1_src sha1_dst status name
549 # Always show modules deleted or type-changed (blob<->module)
550 test $status = D
-o $status = T
&& echo "$name" && continue
551 # Also show added or modified modules which are checked out
552 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
557 test -z "$modules" && return
559 git diff-index
$cached --raw $head -- $modules |
560 egrep '^:([0-7]* )?160000' |
562 while read mod_src mod_dst sha1_src sha1_dst status name
564 if test -z "$cached" &&
565 test $sha1_dst = 0000000000000000000000000000000000000000
569 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
571 100644 |
100755 |
120000)
572 sha1_dst
=$
(git hash-object
$name)
578 echo >&2 "unexpected mode $mod_dst"
585 test $mod_src = 160000 &&
586 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
589 test $mod_dst = 160000 &&
590 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
594 case "$missing_src,$missing_dst" in
596 errmsg
=" Warn: $name doesn't contain commit $sha1_src"
599 errmsg
=" Warn: $name doesn't contain commit $sha1_dst"
602 errmsg
=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
607 if test $mod_src = 160000 -a $mod_dst = 160000
609 range
="$sha1_src...$sha1_dst"
610 elif test $mod_src = 160000
616 GIT_DIR
="$name/.git" \
617 git log
--pretty=oneline
--first-parent $range |
wc -l
619 total_commits
=" ($(($total_commits + 0)))"
623 sha1_abbr_src
=$
(echo $sha1_src | cut
-c1-7)
624 sha1_abbr_dst
=$
(echo $sha1_dst | cut
-c1-7)
627 if test $mod_dst = 160000
629 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
631 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
634 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
638 # Don't give error msg for modification whose dst is not submodule
639 # i.e. deleted or changed to blob
640 test $mod_dst = 160000 && echo "$errmsg"
642 if test $mod_src = 160000 -a $mod_dst = 160000
645 test $summary_limit -gt 0 && limit
="-$summary_limit"
646 GIT_DIR
="$name/.git" \
647 git log
$limit --pretty='format: %m %s' \
648 --first-parent $sha1_src...
$sha1_dst
649 elif test $mod_dst = 160000
651 GIT_DIR
="$name/.git" \
652 git log
--pretty='format: > %s' -1 $sha1_dst
654 GIT_DIR
="$name/.git" \
655 git log
--pretty='format: < %s' -1 $sha1_src
661 if test -n "$for_status"; then
662 echo "# Modified submodules:"
664 sed -e 's|^|# |' -e 's|^# $|#|'
670 # List all submodules, prefixed with:
671 # - submodule not initialized
672 # + different revision checked out
674 # If --cached was specified the revision in the index will be printed
675 # instead of the currently checked out revision.
677 # $@ = requested paths (default to all)
681 # parse $args after "submodule ... status".
706 while read mode sha1 stage path
708 name
=$
(module_name
"$path") ||
exit
709 url
=$
(git config submodule.
"$name".url
)
710 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
715 set_name_rev
"$path" "$sha1"
716 if git diff-files
--quiet -- "$path"
718 say
" $sha1 $path$revname"
722 sha1
=$
(unset GIT_DIR
; cd "$path" && git rev-parse
--verify HEAD
)
723 set_name_rev
"$path" "$sha1"
725 say
"+$sha1 $path$revname"
730 # Sync remote urls for submodules
731 # This makes the value for remote.$remote.url match the value
732 # specified in .gitmodules.
757 while read mode sha1 stage path
759 name
=$
(module_name
"$path")
760 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
762 # Possibly a url relative to parent
765 url
=$
(resolve_relative_url
"$url") ||
exit
769 if test -e "$path"/.git
774 remote
=$
(get_default_remote
)
775 say
"Synchronizing submodule url for '$name'"
776 git config remote.
"$remote".url
"$url"
782 # This loop parses the command line arguments to find the
783 # subcommand name to dispatch. Parsing of the subcommand specific
784 # options are primarily done by the subcommand implementations.
785 # Subcommand specific options such as --branch and --cached are
786 # parsed here as well, for backward compatibility.
788 while test $# != 0 && test -z "$command"
791 add | foreach | init | update | status | summary | sync
)
821 # No command word defaults to "status"
822 test -n "$command" ||
command=status
824 # "-b branch" is accepted only by "add"
825 if test -n "$branch" && test "$command" != add
830 # "--cached" is accepted only by "status" and "summary"
831 if test -n "$cached" && test "$command" != status
-a "$command" != summary