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 die
"$(eval_gettext "remote
(\
$remote) does not have a url defined
in .git
/config
")"
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?
104 re
=$
(printf '%s\n' "$1" |
sed -e 's/[].[^$\\*]/\\&/g')
105 name
=$
( git config
-f .gitmodules
--get-regexp '^submodule\..*\.path$' |
106 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
108 die
"$(eval_gettext "No submodule mapping found
in .gitmodules
for path
'\$path'")"
115 # Prior to calling, cmd_update checks that a possibly existing
116 # path is not a git repository.
117 # Likewise, cmd_add checks that path does not exist at all,
118 # since it is the location of a new submodule.
126 if test -n "$reference"
128 git-clone
"$reference" -n "$url" "$path"
130 git-clone
-n "$url" "$path"
132 die
"$(eval_gettext "Clone of
'\$url' into submodule path
'\$path' failed
")"
136 # Add a new submodule to the working tree, .gitmodules and the index
140 # optional branch is stored in global branch variable
144 # parse $args after "submodule ... add".
149 case "$2" in '') usage
;; esac
160 case "$2" in '') usage
;; esac
161 reference
="--reference=$2"
185 if test -z "$path"; then
186 path
=$
(echo "$repo" |
187 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
190 if test -z "$repo" -o -z "$path"; then
194 # assure repo is absolute or relative to parent
197 # dereference source url relative to parent's url
198 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
205 die
"$(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
210 # multiple //; leading ./; /./; /../; trailing /
211 path
=$
(printf '%s/\n' "$path" |
221 git ls-files
--error-unmatch "$path" > /dev
/null
2>&1 &&
222 die
"$(eval_gettext "'\$path' already exists
in the index
")"
224 if test -z "$force" && ! git add
--dry-run --ignore-missing "$path" > /dev
/null
2>&1
227 The following path is ignored by one of your .gitignore files:
229 Use -f if you really want to add it.
234 # perhaps the path exists and is already a git repo, else clone it
237 if test -d "$path"/.git
-o -f "$path"/.git
239 eval_gettext
"Adding existing repo at '\$path' to the index"; echo
241 die
"$(eval_gettext "'\$path' already exists and is not a valid git repo
")"
246 url
=$
(resolve_relative_url
"$repo") ||
exit
252 git config submodule.
"$path".url
"$url"
255 module_clone
"$path" "$realrepo" "$reference" ||
exit
259 # ash fails to wordsplit ${branch:+-b "$branch"...}
261 '') git checkout
-f -q ;;
262 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
264 ) || die
"$(eval_gettext "Unable to checkout submodule
'\$path'")"
267 git add
$force "$path" ||
268 die
"$(eval_gettext "Failed to add submodule
'\$path'")"
270 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
271 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
272 git add
--force .gitmodules ||
273 die
"$(eval_gettext "Failed to register submodule
'\$path'")"
277 # Execute an arbitrary command sequence in each checked out
280 # $@ = command to execute
284 # parse $args after "submodule ... foreach".
307 while read mode sha1 stage path
309 if test -e "$path"/.git
311 say
"$(eval_gettext "Entering
'\$prefix\$path'")"
312 name
=$
(module_name
"$path")
314 prefix
="$prefix$path/"
318 if test -n "$recursive"
320 cmd_foreach
"--recursive" "$@"
323 die
"$(eval_gettext "Stopping
at '\$path'; script returned non-zero status.
")"
329 # Register submodules in .git/config
331 # $@ = requested paths (default to all)
335 # parse $args after "submodule ... init".
357 while read mode sha1 stage path
359 # Skip already registered paths
360 name
=$
(module_name
"$path") ||
exit
361 url
=$
(git config submodule.
"$name".url
)
362 test -z "$url" ||
continue
364 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
366 die
"$(eval_gettext "No url found
for submodule path
'\$path' in .gitmodules
")"
368 # Possibly a url relative to parent
371 url
=$
(resolve_relative_url
"$url") ||
exit
375 git config submodule.
"$name".url
"$url" ||
376 die
"$(eval_gettext "Failed to register url
for submodule path
'\$path'")"
378 upd
="$(git config -f .gitmodules submodule."$name".update)"
380 git config submodule.
"$name".update
"$upd" ||
381 die
"$(eval_gettext "Failed to register update mode
for submodule path
'\$path'")"
383 say
"$(eval_gettext "Submodule
'\$name' (\
$url) registered
for path
'\$path'")"
388 # Update each submodule path to correct revision, using clone and checkout as needed
390 # $@ = requested paths (default to all)
394 # parse $args after "submodule ... update".
415 case "$2" in '') usage
;; esac
416 reference
="--reference=$2"
417 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
440 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
446 cmd_init
"--" "$@" ||
return
451 while read mode sha1 stage path
455 echo >&2 "Skipping unmerged submodule $path"
458 name
=$
(module_name
"$path") ||
exit
459 url
=$
(git config submodule.
"$name".url
)
460 update_module
=$
(git config submodule.
"$name".update
)
463 # Only mention uninitialized submodules when its
464 # path have been specified
466 say
"$(eval_gettext "Submodule path
'\$path' not initialized
467 Maybe you want to use
'update --init'?
")"
471 if ! test -d "$path"/.git
-o -f "$path"/.git
473 module_clone
"$path" "$url" "$reference"||
exit
474 cloned_modules
="$cloned_modules;$name"
477 subsha1
=$
(clear_local_git_env
; cd "$path" &&
478 git rev-parse
--verify HEAD
) ||
479 die
"$(eval_gettext "Unable to
find current revision
in submodule path
'\$path'")"
482 if ! test -z "$update"
484 update_module
=$update
487 if test "$subsha1" != "$sha1"
490 # If we don't already have a -f flag and the submodule has never been checked out
491 if test -z "$subsha1" -a -z "$force"
496 if test -z "$nofetch"
498 # Run fetch only if $sha1 isn't present or it
499 # is not reachable from a ref.
500 (clear_local_git_env
; cd "$path" &&
501 ((rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
502 test -z "$rev") || git-fetch
)) ||
503 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$path'")"
506 # Is this something we just cloned?
507 case ";$cloned_modules;" in
509 # then there is no local change to integrate
513 case "$update_module" in
516 die_msg
="$(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$path'")"
517 say_msg
="$(eval_gettext "Submodule path
'\$path': rebased into
'\$sha1'")"
521 die_msg
="$(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$path'")"
522 say_msg
="$(eval_gettext "Submodule path
'\$path': merged
in '\$sha1'")"
525 command="git checkout $subforce -q"
526 die_msg
="$(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$path'")"
527 say_msg
="$(eval_gettext "Submodule path
'\$path': checked out
'\$sha1'")"
531 (clear_local_git_env
; cd "$path" && $command "$sha1") || die
$die_msg
535 if test -n "$recursive"
537 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags") ||
538 die
"$(eval_gettext "Failed to recurse into submodule path
'\$path'")"
547 git describe
"$2" 2>/dev
/null ||
548 git describe
--tags "$2" 2>/dev
/null ||
549 git describe
--contains "$2" 2>/dev
/null ||
550 git describe
--all --always "$2"
553 test -z "$revname" || revname
=" ($revname)"
556 # Show commit summary for submodules in index or working tree
558 # If '--cached' is given, show summary between index and given commit,
559 # or between working tree and given commit
561 # $@ = [commit (default 'HEAD'),] requested paths (default all)
568 # parse $args after "submodule ... summary".
582 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
604 test $summary_limit = 0 && return
606 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
610 elif test -z "$1" -o "$1" = "HEAD"
612 # before the first commit: compare with an empty tree
613 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
614 test -z "$1" ||
shift
622 die
"$(gettext -- "--cached cannot be used with
--files")"
628 # Get modified modules cared by user
629 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
630 sane_egrep
'^:([0-7]* )?160000' |
631 while read mod_src mod_dst sha1_src sha1_dst status name
633 # Always show modules deleted or type-changed (blob<->module)
634 test $status = D
-o $status = T
&& echo "$name" && continue
635 # Also show added or modified modules which are checked out
636 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
641 test -z "$modules" && return
643 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
644 sane_egrep
'^:([0-7]* )?160000' |
646 while read mod_src mod_dst sha1_src sha1_dst status name
648 if test -z "$cached" &&
649 test $sha1_dst = 0000000000000000000000000000000000000000
653 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
655 100644 |
100755 |
120000)
656 sha1_dst
=$
(git hash-object
$name)
663 eval_gettext
"unexpected mode \$mod_dst" &&
672 test $mod_src = 160000 &&
673 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
676 test $mod_dst = 160000 &&
677 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
681 case "$missing_src,$missing_dst" in
683 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commit \$sha1_src")"
686 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \
$sha1_dst")"
689 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commits \$sha1_src and \$sha1_dst")"
694 if test $mod_src = 160000 -a $mod_dst = 160000
696 range="$sha1_src...$sha1_dst"
697 elif test $mod_src = 160000
703 GIT_DIR="$name/.git" \
704 git rev-list --first-parent $range -- | wc -l
706 total_commits=" ($(($total_commits + 0)))"
710 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
711 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
714 blob="$(gettext "blob")"
715 submodule="$(gettext "submodule")"
716 if test $mod_dst = 160000
718 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
720 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
723 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
727 # Don't give error msg
for modification whose dst is not submodule
728 # i.e. deleted or changed to blob
729 test $mod_dst = 160000 && echo "$errmsg"
731 if test $mod_src = 160000 -a $mod_dst = 160000
734 test $summary_limit -gt 0 && limit
="-$summary_limit"
735 GIT_DIR
="$name/.git" \
736 git log
$limit --pretty='format: %m %s' \
737 --first-parent $sha1_src...
$sha1_dst
738 elif test $mod_dst = 160000
740 GIT_DIR
="$name/.git" \
741 git log
--pretty='format: > %s' -1 $sha1_dst
743 GIT_DIR
="$name/.git" \
744 git log
--pretty='format: < %s' -1 $sha1_src
750 if test -n "$for_status"; then
751 if [ -n "$files" ]; then
752 status_msg
="$(gettext "# Submodules changed but not updated:")"
754 status_msg
="$(gettext "# Submodule changes to be committed:")"
756 status_sed
=$
(sed -e 's|^|# |' -e 's|^# $|#|')
767 # List all submodules, prefixed with:
768 # - submodule not initialized
769 # + different revision checked out
771 # If --cached was specified the revision in the index will be printed
772 # instead of the currently checked out revision.
774 # $@ = requested paths (default to all)
778 # parse $args after "submodule ... status".
803 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
808 while read mode sha1 stage path
810 name
=$
(module_name
"$path") ||
exit
811 url
=$
(git config submodule.
"$name".url
)
812 displaypath
="$prefix$path"
815 say
"U$sha1 $displaypath"
818 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
820 say
"-$sha1 $displaypath"
823 set_name_rev
"$path" "$sha1"
824 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
826 say
" $sha1 $displaypath$revname"
830 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
831 set_name_rev
"$path" "$sha1"
833 say
"+$sha1 $displaypath$revname"
836 if test -n "$recursive"
839 prefix
="$displaypath/"
842 eval cmd_status
"$orig_args"
844 die
"$(eval_gettext "Failed to recurse into submodule path
'\$path'")"
849 # Sync remote urls for submodules
850 # This makes the value for remote.$remote.url match the value
851 # specified in .gitmodules.
876 while read mode sha1 stage path
878 name
=$
(module_name
"$path")
879 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
881 # Possibly a url relative to parent
884 url
=$
(resolve_relative_url
"$url") ||
exit
888 say
"$(eval_gettext "Synchronizing submodule url
for '\$name'")"
889 git config submodule.
"$name".url
"$url"
891 if test -e "$path"/.git
896 remote
=$
(get_default_remote
)
897 git config remote.
"$remote".url
"$url"
903 # This loop parses the command line arguments to find the
904 # subcommand name to dispatch. Parsing of the subcommand specific
905 # options are primarily done by the subcommand implementations.
906 # Subcommand specific options such as --branch and --cached are
907 # parsed here as well, for backward compatibility.
909 while test $# != 0 && test -z "$command"
912 add | foreach | init | update | status | summary | sync
)
942 # No command word defaults to "status"
943 test -n "$command" ||
command=status
945 # "-b branch" is accepted only by "add"
946 if test -n "$branch" && test "$command" != add
951 # "--cached" is accepted only by "status" and "summary"
952 if test -n "$cached" && test "$command" != status
-a "$command" != summary