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
226 echo >&2 "The following path is ignored by one of your .gitignore files:" &&
228 echo >&2 "Use -f if you really want to add it."
232 # perhaps the path exists and is already a git repo, else clone it
235 if test -d "$path"/.git
-o -f "$path"/.git
237 eval_gettext
"Adding existing repo at '\$path' to the index"; echo
239 die
"$(eval_gettext "'\$path' already exists and is not a valid git repo
")"
244 url
=$
(resolve_relative_url
"$repo") ||
exit
250 git config submodule.
"$path".url
"$url"
253 module_clone
"$path" "$realrepo" "$reference" ||
exit
257 # ash fails to wordsplit ${branch:+-b "$branch"...}
259 '') git checkout
-f -q ;;
260 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
262 ) || die
"$(eval_gettext "Unable to checkout submodule
'\$path'")"
265 git add
$force "$path" ||
266 die
"$(eval_gettext "Failed to add submodule
'\$path'")"
268 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
269 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
270 git add
--force .gitmodules ||
271 die
"$(eval_gettext "Failed to register submodule
'\$path'")"
275 # Execute an arbitrary command sequence in each checked out
278 # $@ = command to execute
282 # parse $args after "submodule ... foreach".
305 while read mode sha1 stage path
307 if test -e "$path"/.git
309 say
"$(eval_gettext "Entering
'\$prefix\$path'")"
310 name
=$
(module_name
"$path")
312 prefix
="$prefix$path/"
316 if test -n "$recursive"
318 cmd_foreach
"--recursive" "$@"
321 die
"$(eval_gettext "Stopping
at '\$path'; script returned non-zero status.
")"
327 # Register submodules in .git/config
329 # $@ = requested paths (default to all)
333 # parse $args after "submodule ... init".
355 while read mode sha1 stage path
357 # Skip already registered paths
358 name
=$
(module_name
"$path") ||
exit
359 url
=$
(git config submodule.
"$name".url
)
360 test -z "$url" ||
continue
362 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
364 die
"$(eval_gettext "No url found
for submodule path
'\$path' in .gitmodules
")"
366 # Possibly a url relative to parent
369 url
=$
(resolve_relative_url
"$url") ||
exit
373 git config submodule.
"$name".url
"$url" ||
374 die
"$(eval_gettext "Failed to register url
for submodule path
'\$path'")"
376 upd
="$(git config -f .gitmodules submodule."$name".update)"
378 git config submodule.
"$name".update
"$upd" ||
379 die
"$(eval_gettext "Failed to register update mode
for submodule path
'\$path'")"
381 say
"$(eval_gettext "Submodule
'\$name' (\
$url) registered
for path
'\$path'")"
386 # Update each submodule path to correct revision, using clone and checkout as needed
388 # $@ = requested paths (default to all)
392 # parse $args after "submodule ... update".
413 case "$2" in '') usage
;; esac
414 reference
="--reference=$2"
415 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
438 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
444 cmd_init
"--" "$@" ||
return
449 while read mode sha1 stage path
453 echo >&2 "Skipping unmerged submodule $path"
456 name
=$
(module_name
"$path") ||
exit
457 url
=$
(git config submodule.
"$name".url
)
458 update_module
=$
(git config submodule.
"$name".update
)
461 # Only mention uninitialized submodules when its
462 # path have been specified
464 say
"Submodule path '$path' not initialized" &&
465 say
"Maybe you want to use 'update --init'?"
469 if ! test -d "$path"/.git
-o -f "$path"/.git
471 module_clone
"$path" "$url" "$reference"||
exit
472 cloned_modules
="$cloned_modules;$name"
475 subsha1
=$
(clear_local_git_env
; cd "$path" &&
476 git rev-parse
--verify HEAD
) ||
477 die
"$(eval_gettext "Unable to
find current revision
in submodule path
'\$path'")"
480 if ! test -z "$update"
482 update_module
=$update
485 if test "$subsha1" != "$sha1"
488 # If we don't already have a -f flag and the submodule has never been checked out
489 if test -z "$subsha1" -a -z "$force"
494 if test -z "$nofetch"
496 # Run fetch only if $sha1 isn't present or it
497 # is not reachable from a ref.
498 (clear_local_git_env
; cd "$path" &&
499 ((rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
500 test -z "$rev") || git-fetch
)) ||
501 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$path'")"
504 # Is this something we just cloned?
505 case ";$cloned_modules;" in
507 # then there is no local change to integrate
511 case "$update_module" in
514 die_msg
="$(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$path'")"
515 say_msg
="$(eval_gettext "Submodule path
'\$path': rebased into
'\$sha1'")"
519 die_msg
="$(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$path'")"
520 say_msg
="$(eval_gettext "Submodule path
'\$path': merged
in '\$sha1'")"
523 command="git checkout $subforce -q"
524 die_msg
="$(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$path'")"
525 say_msg
="$(eval_gettext "Submodule path
'\$path': checked out
'\$sha1'")"
529 (clear_local_git_env
; cd "$path" && $command "$sha1") || die
$die_msg
533 if test -n "$recursive"
535 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags") ||
536 die
"$(eval_gettext "Failed to recurse into submodule path
'\$path'")"
545 git describe
"$2" 2>/dev
/null ||
546 git describe
--tags "$2" 2>/dev
/null ||
547 git describe
--contains "$2" 2>/dev
/null ||
548 git describe
--all --always "$2"
551 test -z "$revname" || revname
=" ($revname)"
554 # Show commit summary for submodules in index or working tree
556 # If '--cached' is given, show summary between index and given commit,
557 # or between working tree and given commit
559 # $@ = [commit (default 'HEAD'),] requested paths (default all)
566 # parse $args after "submodule ... summary".
580 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
602 test $summary_limit = 0 && return
604 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
608 elif test -z "$1" -o "$1" = "HEAD"
610 # before the first commit: compare with an empty tree
611 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
612 test -z "$1" ||
shift
620 die
"$(gettext -- "--cached cannot be used with
--files")"
626 # Get modified modules cared by user
627 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
628 sane_egrep
'^:([0-7]* )?160000' |
629 while read mod_src mod_dst sha1_src sha1_dst status name
631 # Always show modules deleted or type-changed (blob<->module)
632 test $status = D
-o $status = T
&& echo "$name" && continue
633 # Also show added or modified modules which are checked out
634 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
639 test -z "$modules" && return
641 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
642 sane_egrep
'^:([0-7]* )?160000' |
644 while read mod_src mod_dst sha1_src sha1_dst status name
646 if test -z "$cached" &&
647 test $sha1_dst = 0000000000000000000000000000000000000000
651 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
653 100644 |
100755 |
120000)
654 sha1_dst
=$
(git hash-object
$name)
661 eval_gettext
"unexpected mode \$mod_dst" &&
670 test $mod_src = 160000 &&
671 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
674 test $mod_dst = 160000 &&
675 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
679 case "$missing_src,$missing_dst" in
681 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commit \$sha1_src")"
684 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \
$sha1_dst")"
687 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commits \$sha1_src and \$sha1_dst")"
692 if test $mod_src = 160000 -a $mod_dst = 160000
694 range="$sha1_src...$sha1_dst"
695 elif test $mod_src = 160000
701 GIT_DIR="$name/.git" \
702 git rev-list --first-parent $range -- | wc -l
704 total_commits=" ($(($total_commits + 0)))"
708 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
709 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
712 if test $mod_dst = 160000
714 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
716 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
719 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
723 # Don't give error msg
for modification whose dst is not submodule
724 # i.e. deleted or changed to blob
725 test $mod_dst = 160000 && echo "$errmsg"
727 if test $mod_src = 160000 -a $mod_dst = 160000
730 test $summary_limit -gt 0 && limit
="-$summary_limit"
731 GIT_DIR
="$name/.git" \
732 git log
$limit --pretty='format: %m %s' \
733 --first-parent $sha1_src...
$sha1_dst
734 elif test $mod_dst = 160000
736 GIT_DIR
="$name/.git" \
737 git log
--pretty='format: > %s' -1 $sha1_dst
739 GIT_DIR
="$name/.git" \
740 git log
--pretty='format: < %s' -1 $sha1_src
746 if test -n "$for_status"; then
747 if [ -n "$files" ]; then
748 gettext "# Submodules changed but not updated:"; echo
750 gettext "# Submodule changes to be committed:"; echo
753 sed -e 's|^|# |' -e 's|^# $|#|'
759 # List all submodules, prefixed with:
760 # - submodule not initialized
761 # + different revision checked out
763 # If --cached was specified the revision in the index will be printed
764 # instead of the currently checked out revision.
766 # $@ = requested paths (default to all)
770 # parse $args after "submodule ... status".
795 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
800 while read mode sha1 stage path
802 name
=$
(module_name
"$path") ||
exit
803 url
=$
(git config submodule.
"$name".url
)
804 displaypath
="$prefix$path"
807 say
"U$sha1 $displaypath"
810 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
812 say
"-$sha1 $displaypath"
815 set_name_rev
"$path" "$sha1"
816 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
818 say
" $sha1 $displaypath$revname"
822 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
823 set_name_rev
"$path" "$sha1"
825 say
"+$sha1 $displaypath$revname"
828 if test -n "$recursive"
831 prefix
="$displaypath/"
834 eval cmd_status
"$orig_args"
836 die
"$(eval_gettext "Failed to recurse into submodule path
'\$path'")"
841 # Sync remote urls for submodules
842 # This makes the value for remote.$remote.url match the value
843 # specified in .gitmodules.
868 while read mode sha1 stage path
870 name
=$
(module_name
"$path")
871 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
873 # Possibly a url relative to parent
876 url
=$
(resolve_relative_url
"$url") ||
exit
880 say
"$(eval_gettext "Synchronizing submodule url
for '\$name'")"
881 git config submodule.
"$name".url
"$url"
883 if test -e "$path"/.git
888 remote
=$
(get_default_remote
)
889 git config remote.
"$remote".url
"$url"
895 # This loop parses the command line arguments to find the
896 # subcommand name to dispatch. Parsing of the subcommand specific
897 # options are primarily done by the subcommand implementations.
898 # Subcommand specific options such as --branch and --cached are
899 # parsed here as well, for backward compatibility.
901 while test $# != 0 && test -z "$command"
904 add | foreach | init | update | status | summary | sync
)
934 # No command word defaults to "status"
935 test -n "$command" ||
command=status
937 # "-b branch" is accepted only by "add"
938 if test -n "$branch" && test "$command" != add
943 # "--cached" is accepted only by "status" and "summary"
944 if test -n "$cached" && test "$command" != status
-a "$command" != summary