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>...]"
32 # Resolve relative url by appending to parent's url
33 resolve_relative_url
()
35 remote
=$
(get_default_remote
)
36 remoteurl
=$
(git config
"remote.$remote.url") ||
37 die
"remote ($remote) does not have a url defined in .git/config"
39 remoteurl
=${remoteurl%/}
48 remoteurl
="${remoteurl%/*}"
51 remoteurl
="${remoteurl%:*}"
55 die
"cannot strip one component off url '$remoteurl'"
66 echo "$remoteurl$sep${url%/}"
70 # Get submodule info for registered submodules
71 # $@ = path to limit submodule list
75 git ls-files
--error-unmatch --stage -- "$@" | sane_grep
'^160000 '
79 # Map submodule path to submodule name
85 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
86 re
=$
(printf '%s\n' "$1" |
sed -e 's/[].[^$\\*]/\\&/g')
87 name
=$
( git config
-f .gitmodules
--get-regexp '^submodule\..*\.path$' |
88 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
90 die
"No submodule mapping found in .gitmodules for path '$path'"
97 # Prior to calling, cmd_update checks that a possibly existing
98 # path is not a git repository.
99 # Likewise, cmd_add checks that path does not exist at all,
100 # since it is the location of a new submodule.
108 if test -n "$reference"
110 git-clone
"$reference" -n "$url" "$path"
112 git-clone
-n "$url" "$path"
114 die
"Clone of '$url' into submodule path '$path' failed"
118 # Add a new submodule to the working tree, .gitmodules and the index
122 # optional branch is stored in global branch variable
126 # parse $args after "submodule ... add".
131 case "$2" in '') usage
;; esac
142 case "$2" in '') usage
;; esac
143 reference
="--reference=$2"
167 if test -z "$path"; then
168 path
=$
(echo "$repo" |
169 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
172 if test -z "$repo" -o -z "$path"; then
176 # assure repo is absolute or relative to parent
179 # dereference source url relative to parent's url
180 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
187 die
"repo URL: '$repo' must be absolute or begin with ./|../"
192 # multiple //; leading ./; /./; /../; trailing /
193 path
=$
(printf '%s/\n' "$path" |
203 git ls-files
--error-unmatch "$path" > /dev
/null
2>&1 &&
204 die
"'$path' already exists in the index"
206 if test -z "$force" && ! git add
--dry-run --ignore-missing "$path" > /dev
/null
2>&1
208 echo >&2 "The following path is ignored by one of your .gitignore files:" &&
210 echo >&2 "Use -f if you really want to add it."
214 # perhaps the path exists and is already a git repo, else clone it
217 if test -d "$path"/.git
-o -f "$path"/.git
219 echo "Adding existing repo at '$path' to the index"
221 die
"'$path' already exists and is not a valid git repo"
226 url
=$
(resolve_relative_url
"$repo") ||
exit
232 git config submodule.
"$path".url
"$url"
235 module_clone
"$path" "$realrepo" "$reference" ||
exit
239 # ash fails to wordsplit ${branch:+-b "$branch"...}
241 '') git checkout
-f -q ;;
242 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
244 ) || die
"Unable to checkout submodule '$path'"
247 git add
$force "$path" ||
248 die
"Failed to add submodule '$path'"
250 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
251 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
252 git add
--force .gitmodules ||
253 die
"Failed to register submodule '$path'"
257 # Execute an arbitrary command sequence in each checked out
260 # $@ = command to execute
264 # parse $args after "submodule ... foreach".
287 while read mode sha1 stage path
289 if test -e "$path"/.git
291 say
"Entering '$prefix$path'"
292 name
=$
(module_name
"$path")
294 prefix
="$prefix$path/"
298 if test -n "$recursive"
300 cmd_foreach
"--recursive" "$@"
303 die
"Stopping at '$path'; script returned non-zero status."
309 # Register submodules in .git/config
311 # $@ = requested paths (default to all)
315 # parse $args after "submodule ... init".
337 while read mode sha1 stage path
339 # Skip already registered paths
340 name
=$
(module_name
"$path") ||
exit
341 url
=$
(git config submodule.
"$name".url
)
342 test -z "$url" ||
continue
344 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
346 die
"No url found for submodule path '$path' in .gitmodules"
348 # Possibly a url relative to parent
351 url
=$
(resolve_relative_url
"$url") ||
exit
355 git config submodule.
"$name".url
"$url" ||
356 die
"Failed to register url for submodule path '$path'"
358 upd
="$(git config -f .gitmodules submodule."$name".update)"
360 git config submodule.
"$name".update
"$upd" ||
361 die
"Failed to register update mode for submodule path '$path'"
363 say
"Submodule '$name' ($url) registered for path '$path'"
368 # Update each submodule path to correct revision, using clone and checkout as needed
370 # $@ = requested paths (default to all)
374 # parse $args after "submodule ... update".
395 case "$2" in '') usage
;; esac
396 reference
="--reference=$2"
397 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
420 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
426 cmd_init
"--" "$@" ||
return
431 while read mode sha1 stage path
433 name
=$
(module_name
"$path") ||
exit
434 url
=$
(git config submodule.
"$name".url
)
435 update_module
=$
(git config submodule.
"$name".update
)
438 # Only mention uninitialized submodules when its
439 # path have been specified
441 say
"Submodule path '$path' not initialized" &&
442 say
"Maybe you want to use 'update --init'?"
446 if ! test -d "$path"/.git
-o -f "$path"/.git
448 module_clone
"$path" "$url" "$reference"||
exit
449 cloned_modules
="$cloned_modules;$name"
452 subsha1
=$
(clear_local_git_env
; cd "$path" &&
453 git rev-parse
--verify HEAD
) ||
454 die
"Unable to find current revision in submodule path '$path'"
457 if ! test -z "$update"
459 update_module
=$update
462 if test "$subsha1" != "$sha1"
465 # If we don't already have a -f flag and the submodule has never been checked out
466 if test -z "$subsha1" -a -z "$force"
471 if test -z "$nofetch"
473 (clear_local_git_env
; cd "$path" &&
475 die
"Unable to fetch in submodule path '$path'"
478 # Is this something we just cloned?
479 case ";$cloned_modules;" in
481 # then there is no local change to integrate
485 case "$update_module" in
497 command="git checkout $subforce -q"
503 (clear_local_git_env
; cd "$path" && $command "$sha1") ||
504 die
"Unable to $action '$sha1' in submodule path '$path'"
505 say
"Submodule path '$path': $msg '$sha1'"
508 if test -n "$recursive"
510 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags") ||
511 die
"Failed to recurse into submodule path '$path'"
520 git describe
"$2" 2>/dev
/null ||
521 git describe
--tags "$2" 2>/dev
/null ||
522 git describe
--contains "$2" 2>/dev
/null ||
523 git describe
--all --always "$2"
526 test -z "$revname" || revname
=" ($revname)"
529 # Show commit summary for submodules in index or working tree
531 # If '--cached' is given, show summary between index and given commit,
532 # or between working tree and given commit
534 # $@ = [commit (default 'HEAD'),] requested paths (default all)
541 # parse $args after "submodule ... summary".
555 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
577 test $summary_limit = 0 && return
579 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
583 elif test -z "$1" -o "$1" = "HEAD"
585 # before the first commit: compare with an empty tree
586 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
587 test -z "$1" ||
shift
595 die
"--cached cannot be used with --files"
601 # Get modified modules cared by user
602 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
603 sane_egrep
'^:([0-7]* )?160000' |
604 while read mod_src mod_dst sha1_src sha1_dst status name
606 # Always show modules deleted or type-changed (blob<->module)
607 test $status = D
-o $status = T
&& echo "$name" && continue
608 # Also show added or modified modules which are checked out
609 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
614 test -z "$modules" && return
616 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
617 sane_egrep
'^:([0-7]* )?160000' |
619 while read mod_src mod_dst sha1_src sha1_dst status name
621 if test -z "$cached" &&
622 test $sha1_dst = 0000000000000000000000000000000000000000
626 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
628 100644 |
100755 |
120000)
629 sha1_dst
=$
(git hash-object
$name)
635 echo >&2 "unexpected mode $mod_dst"
642 test $mod_src = 160000 &&
643 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
646 test $mod_dst = 160000 &&
647 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
651 case "$missing_src,$missing_dst" in
653 errmsg
=" Warn: $name doesn't contain commit $sha1_src"
656 errmsg
=" Warn: $name doesn't contain commit $sha1_dst"
659 errmsg
=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
664 if test $mod_src = 160000 -a $mod_dst = 160000
666 range
="$sha1_src...$sha1_dst"
667 elif test $mod_src = 160000
673 GIT_DIR
="$name/.git" \
674 git rev-list
--first-parent $range -- |
wc -l
676 total_commits
=" ($(($total_commits + 0)))"
680 sha1_abbr_src
=$
(echo $sha1_src | cut
-c1-7)
681 sha1_abbr_dst
=$
(echo $sha1_dst | cut
-c1-7)
684 if test $mod_dst = 160000
686 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
688 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
691 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
695 # Don't give error msg for modification whose dst is not submodule
696 # i.e. deleted or changed to blob
697 test $mod_dst = 160000 && echo "$errmsg"
699 if test $mod_src = 160000 -a $mod_dst = 160000
702 test $summary_limit -gt 0 && limit
="-$summary_limit"
703 GIT_DIR
="$name/.git" \
704 git log
$limit --pretty='format: %m %s' \
705 --first-parent $sha1_src...
$sha1_dst
706 elif test $mod_dst = 160000
708 GIT_DIR
="$name/.git" \
709 git log
--pretty='format: > %s' -1 $sha1_dst
711 GIT_DIR
="$name/.git" \
712 git log
--pretty='format: < %s' -1 $sha1_src
718 if test -n "$for_status"; then
719 if [ -n "$files" ]; then
720 echo "# Submodules changed but not updated:"
722 echo "# Submodule changes to be committed:"
725 sed -e 's|^|# |' -e 's|^# $|#|'
731 # List all submodules, prefixed with:
732 # - submodule not initialized
733 # + different revision checked out
735 # If --cached was specified the revision in the index will be printed
736 # instead of the currently checked out revision.
738 # $@ = requested paths (default to all)
742 # parse $args after "submodule ... status".
767 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
772 while read mode sha1 stage path
774 name
=$
(module_name
"$path") ||
exit
775 url
=$
(git config submodule.
"$name".url
)
776 displaypath
="$prefix$path"
777 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
779 say
"-$sha1 $displaypath"
782 set_name_rev
"$path" "$sha1"
783 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
785 say
" $sha1 $displaypath$revname"
789 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
790 set_name_rev
"$path" "$sha1"
792 say
"+$sha1 $displaypath$revname"
795 if test -n "$recursive"
798 prefix
="$displaypath/"
801 eval cmd_status
"$orig_args"
803 die
"Failed to recurse into submodule path '$path'"
808 # Sync remote urls for submodules
809 # This makes the value for remote.$remote.url match the value
810 # specified in .gitmodules.
835 while read mode sha1 stage path
837 name
=$
(module_name
"$path")
838 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
840 # Possibly a url relative to parent
843 url
=$
(resolve_relative_url
"$url") ||
exit
847 say
"Synchronizing submodule url for '$name'"
848 git config submodule.
"$name".url
"$url"
850 if test -e "$path"/.git
855 remote
=$
(get_default_remote
)
856 git config remote.
"$remote".url
"$url"
862 # This loop parses the command line arguments to find the
863 # subcommand name to dispatch. Parsing of the subcommand specific
864 # options are primarily done by the subcommand implementations.
865 # Subcommand specific options such as --branch and --cached are
866 # parsed here as well, for backward compatibility.
868 while test $# != 0 && test -z "$command"
871 add | foreach | init | update | status | summary | sync
)
901 # No command word defaults to "status"
902 test -n "$command" ||
command=status
904 # "-b branch" is accepted only by "add"
905 if test -n "$branch" && test "$command" != add
910 # "--cached" is accepted only by "status" and "summary"
911 if test -n "$cached" && test "$command" != status
-a "$command" != summary