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 remoteurl
=$
(pwd) # the repository is its own authoritative upstream
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
"$(modulepath=$path eval_gettext "No submodule mapping found
in .gitmodules
for path
'\$modulepath'")"
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 "$GIT_QUIET"
133 name
=$
(module_name
"$path" 2>/dev
/null
)
134 test -n "$name" || name
="$path"
135 base_name
=$
(dirname "$name")
137 gitdir
=$
(git rev-parse
--git-dir)
138 gitdir_base
="$gitdir/modules/$base_name"
139 gitdir
="$gitdir/modules/$name"
144 rm -f "$gitdir/index"
146 mkdir
-p "$gitdir_base"
147 git clone
$quiet -n ${reference:+"$reference"} \
148 --separate-git-dir "$gitdir" "$url" "$path" ||
149 die
"$(eval_gettext "Clone of
'\$url' into submodule path
'\$modulepath' failed
")"
152 a
=$
(cd "$gitdir" && pwd)/
153 b
=$
(cd "$path" && pwd)/
154 # normalize Windows-style absolute paths to POSIX-style absolute paths
155 case $a in [a-zA-Z
]:/*) a
=/${a%%:*}${a#*:} ;; esac
156 case $b in [a-zA-Z
]:/*) b
=/${b%%:*}${b#*:} ;; esac
157 # Remove all common leading directories after a sanity check
158 if test "${a#$b}" != "$a" ||
test "${b#$a}" != "$b"; then
159 die
"$(eval_gettext "Gitdir
'\$a' is part of the submodule path
'\$b' or vice versa
")"
161 while test "${a%%/*}" = "${b%%/*}"
166 # Now chop off the trailing '/'s that were added in the beginning
170 rel
=$
(echo $b |
sed -e 's|[^/]*|..|g')
171 echo "gitdir: $rel/$a" >"$path/.git"
173 rel
=$
(echo $a |
sed -e 's|[^/]*|..|g')
174 (clear_local_git_env
; cd "$path" && GIT_WORK_TREE
=. git config core.worktree
"$rel/$b")
178 # Add a new submodule to the working tree, .gitmodules and the index
182 # optional branch is stored in global branch variable
186 # parse $args after "submodule ... add".
191 case "$2" in '') usage
;; esac
202 case "$2" in '') usage
;; esac
203 reference
="--reference=$2"
227 if test -z "$path"; then
228 path
=$
(echo "$repo" |
229 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
232 if test -z "$repo" -o -z "$path"; then
236 # assure repo is absolute or relative to parent
239 # dereference source url relative to parent's url
240 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
247 die
"$(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
252 # multiple //; leading ./; /./; /../; trailing /
253 path
=$
(printf '%s/\n' "$path" |
263 git ls-files
--error-unmatch "$path" > /dev
/null
2>&1 &&
264 die
"$(modulepath=$path eval_gettext "'\$modulepath' already exists
in the index
")"
266 if test -z "$force" && ! git add
--dry-run --ignore-missing "$path" > /dev
/null
2>&1
269 The following path is ignored by one of your .gitignore files:
270 $(modulepath=$path eval_gettextln "\$modulepath")
271 Use -f if you really want to add it.
276 # perhaps the path exists and is already a git repo, else clone it
279 if test -d "$path"/.git
-o -f "$path"/.git
281 modulepath
=$path eval_gettextln
"Adding existing repo at '\$modulepath' to the index"
283 die
"$(modulepath=$path eval_gettext "'\$modulepath' already exists and is not a valid git repo
")"
288 module_clone
"$path" "$realrepo" "$reference" ||
exit
292 # ash fails to wordsplit ${branch:+-b "$branch"...}
294 '') git checkout
-f -q ;;
295 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
297 ) || die
"$(modulepath=$path eval_gettext "Unable to checkout submodule
'\$modulepath'")"
299 git config submodule.
"$path".url
"$realrepo"
301 git add
$force "$path" ||
302 die
"$(modulepath=$path eval_gettext "Failed to add submodule
'\$modulepath'")"
304 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
305 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
306 git add
--force .gitmodules ||
307 die
"$(modulepath=$path eval_gettext "Failed to register submodule
'\$modulepath'")"
311 # Execute an arbitrary command sequence in each checked out
314 # $@ = command to execute
318 # parse $args after "submodule ... foreach".
340 # dup stdin so that it can be restored when running the external
341 # command in the subshell (and a recursive call to this function)
345 while read mode sha1 stage path
347 if test -e "$path"/.git
349 say
"$(modulepath=$path eval_gettext "Entering
'\$prefix\$modulepath'")"
350 name
=$
(module_name
"$path")
352 prefix
="$prefix$path/"
356 if test -n "$recursive"
358 cmd_foreach
"--recursive" "$@"
361 die
"$(modulepath=$path eval_gettext "Stopping
at '\$modulepath'; script returned non-zero status.
")"
367 # Register submodules in .git/config
369 # $@ = requested paths (default to all)
373 # parse $args after "submodule ... init".
395 while read mode sha1 stage path
397 # Skip already registered paths
398 name
=$
(module_name
"$path") ||
exit
399 if test -z "$(git config "submodule.
$name.url
")"
401 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
403 die
"$(modulepath=$path eval_gettext "No url found
for submodule path
'\$modulepath' in .gitmodules
")"
405 # Possibly a url relative to parent
408 url
=$
(resolve_relative_url
"$url") ||
exit
411 git config submodule.
"$name".url
"$url" ||
412 die
"$(modulepath=$path eval_gettext "Failed to register url
for submodule path
'\$modulepath'")"
415 # Copy "update" setting when it is not set yet
416 upd
="$(git config -f .gitmodules submodule."$name".update)"
418 test -n "$(git config submodule."$name".update)" ||
419 git config submodule.
"$name".update
"$upd" ||
420 die
"$(modulepath=$path eval_gettext "Failed to register update mode
for submodule path
'\$modulepath'")"
422 say
"$(modulepath=$path eval_gettext "Submodule
'\$name' (\
$url) registered
for path
'\$modulepath'")"
427 # Update each submodule path to correct revision, using clone and checkout as needed
429 # $@ = requested paths (default to all)
433 # parse $args after "submodule ... update".
454 case "$2" in '') usage
;; esac
455 reference
="--reference=$2"
456 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
482 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
488 cmd_init
"--" "$@" ||
return
494 while read mode sha1 stage path
498 echo >&2 "Skipping unmerged submodule $path"
501 name
=$
(module_name
"$path") ||
exit
502 url
=$
(git config submodule.
"$name".url
)
503 if ! test -z "$update"
505 update_module
=$update
507 update_module
=$
(git config submodule.
"$name".update
)
510 if test "$update_module" = "none"
512 echo "Skipping submodule '$path'"
518 # Only mention uninitialized submodules when its
519 # path have been specified
521 say
"$(modulepath=$path eval_gettext "Submodule path
'\$modulepath' not initialized
522 Maybe you want to use
'update --init'?
")"
526 if ! test -d "$path"/.git
-o -f "$path"/.git
528 module_clone
"$path" "$url" "$reference"||
exit
529 cloned_modules
="$cloned_modules;$name"
532 subsha1
=$
(clear_local_git_env
; cd "$path" &&
533 git rev-parse
--verify HEAD
) ||
534 die
"$(modulepath=$path eval_gettext "Unable to
find current revision
in submodule path
'\$modulepath'")"
537 if test "$subsha1" != "$sha1"
540 # If we don't already have a -f flag and the submodule has never been checked out
541 if test -z "$subsha1" -a -z "$force"
546 if test -z "$nofetch"
548 # Run fetch only if $sha1 isn't present or it
549 # is not reachable from a ref.
550 (clear_local_git_env
; cd "$path" &&
551 ( (rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
552 test -z "$rev") || git-fetch
)) ||
553 die
"$(modulepath=$path eval_gettext "Unable to fetch
in submodule path
'\$modulepath'")"
556 # Is this something we just cloned?
557 case ";$cloned_modules;" in
559 # then there is no local change to integrate
564 case "$update_module" in
567 die_msg
="$(modulepath=$path eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$modulepath'")"
568 say_msg
="$(modulepath=$path eval_gettext "Submodule path
'\$modulepath': rebased into
'\$sha1'")"
569 must_die_on_failure
=yes
573 die_msg
="$(modulepath=$path eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$modulepath'")"
574 say_msg
="$(modulepath=$path eval_gettext "Submodule path
'\$modulepath': merged
in '\$sha1'")"
575 must_die_on_failure
=yes
578 command="git checkout $subforce -q"
579 die_msg
="$(modulepath=$path eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$modulepath'")"
580 say_msg
="$(modulepath=$path eval_gettext "Submodule path
'\$modulepath': checked out
'\$sha1'")"
584 if (clear_local_git_env
; cd "$path" && $command "$sha1")
587 elif test -n "$must_die_on_failure"
589 die_with_status
2 "$die_msg"
591 err
="${err};$die_msg"
596 if test -n "$recursive"
598 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags")
602 die_msg
="$(modulepath=$path eval_gettext "Failed to recurse into submodule path
'\$modulepath'")"
605 err
="${err};$die_msg"
608 die_with_status
$res "$die_msg"
635 git describe
"$2" 2>/dev
/null ||
636 git describe
--tags "$2" 2>/dev
/null ||
637 git describe
--contains "$2" 2>/dev
/null ||
638 git describe
--all --always "$2"
641 test -z "$revname" || revname
=" ($revname)"
644 # Show commit summary for submodules in index or working tree
646 # If '--cached' is given, show summary between index and given commit,
647 # or between working tree and given commit
649 # $@ = [commit (default 'HEAD'),] requested paths (default all)
656 # parse $args after "submodule ... summary".
670 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
692 test $summary_limit = 0 && return
694 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
698 elif test -z "$1" -o "$1" = "HEAD"
700 # before the first commit: compare with an empty tree
701 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
702 test -z "$1" ||
shift
710 die
"$(gettext -- "--cached cannot be used with
--files")"
716 # Get modified modules cared by user
717 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
718 sane_egrep
'^:([0-7]* )?160000' |
719 while read mod_src mod_dst sha1_src sha1_dst status name
721 # Always show modules deleted or type-changed (blob<->module)
722 test $status = D
-o $status = T
&& echo "$name" && continue
723 # Also show added or modified modules which are checked out
724 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
729 test -z "$modules" && return
731 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
732 sane_egrep
'^:([0-7]* )?160000' |
734 while read mod_src mod_dst sha1_src sha1_dst status name
736 if test -z "$cached" &&
737 test $sha1_dst = 0000000000000000000000000000000000000000
741 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
743 100644 |
100755 |
120000)
744 sha1_dst
=$
(git hash-object
$name)
750 eval_gettextln
"unexpected mode \$mod_dst" >&2
757 test $mod_src = 160000 &&
758 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
761 test $mod_dst = 160000 &&
762 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
766 case "$missing_src,$missing_dst" in
768 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commit \$sha1_src")"
771 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \
$sha1_dst")"
774 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commits \$sha1_src and \$sha1_dst")"
779 if test $mod_src = 160000 -a $mod_dst = 160000
781 range="$sha1_src...$sha1_dst"
782 elif test $mod_src = 160000
788 GIT_DIR="$name/.git" \
789 git rev-list --first-parent $range -- | wc -l
791 total_commits=" ($(($total_commits + 0)))"
795 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
796 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
799 blob="$(gettext "blob")"
800 submodule="$(gettext "submodule")"
801 if test $mod_dst = 160000
803 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
805 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
808 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
812 # Don't give error msg
for modification whose dst is not submodule
813 # i.e. deleted or changed to blob
814 test $mod_dst = 160000 && echo "$errmsg"
816 if test $mod_src = 160000 -a $mod_dst = 160000
819 test $summary_limit -gt 0 && limit
="-$summary_limit"
820 GIT_DIR
="$name/.git" \
821 git log
$limit --pretty='format: %m %s' \
822 --first-parent $sha1_src...
$sha1_dst
823 elif test $mod_dst = 160000
825 GIT_DIR
="$name/.git" \
826 git log
--pretty='format: > %s' -1 $sha1_dst
828 GIT_DIR
="$name/.git" \
829 git log
--pretty='format: < %s' -1 $sha1_src
835 if test -n "$for_status"; then
836 if [ -n "$files" ]; then
837 status_msg
="$(gettextln "# Submodules changed but not updated:")"
839 status_msg
="$(gettextln "# Submodule changes to be committed:")"
841 status_sed
=$
(sed -e 's|^|# |' -e 's|^# $|#|')
852 # List all submodules, prefixed with:
853 # - submodule not initialized
854 # + different revision checked out
856 # If --cached was specified the revision in the index will be printed
857 # instead of the currently checked out revision.
859 # $@ = requested paths (default to all)
863 # parse $args after "submodule ... status".
888 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
893 while read mode sha1 stage path
895 name
=$
(module_name
"$path") ||
exit
896 url
=$
(git config submodule.
"$name".url
)
897 displaypath
="$prefix$path"
900 say
"U$sha1 $displaypath"
903 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
905 say
"-$sha1 $displaypath"
908 set_name_rev
"$path" "$sha1"
909 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
911 say
" $sha1 $displaypath$revname"
915 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
916 set_name_rev
"$path" "$sha1"
918 say
"+$sha1 $displaypath$revname"
921 if test -n "$recursive"
924 prefix
="$displaypath/"
927 eval cmd_status
"$orig_args"
929 die
"$(modulepath=$path eval_gettext "Failed to recurse into submodule path
'\$modulepath'")"
934 # Sync remote urls for submodules
935 # This makes the value for remote.$remote.url match the value
936 # specified in .gitmodules.
961 while read mode sha1 stage path
963 name
=$
(module_name
"$path")
964 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
966 # Possibly a url relative to parent
969 url
=$
(resolve_relative_url
"$url") ||
exit
973 if git config
"submodule.$name.url" >/dev
/null
2>/dev
/null
975 say
"$(eval_gettext "Synchronizing submodule url
for '\$name'")"
976 git config submodule.
"$name".url
"$url"
978 if test -e "$path"/.git
983 remote
=$
(get_default_remote
)
984 git config remote.
"$remote".url
"$url"
991 # This loop parses the command line arguments to find the
992 # subcommand name to dispatch. Parsing of the subcommand specific
993 # options are primarily done by the subcommand implementations.
994 # Subcommand specific options such as --branch and --cached are
995 # parsed here as well, for backward compatibility.
997 while test $# != 0 && test -z "$command"
1000 add | foreach | init | update | status | summary | sync
)
1030 # No command word defaults to "status"
1031 test -n "$command" ||
command=status
1033 # "-b branch" is accepted only by "add"
1034 if test -n "$branch" && test "$command" != add
1039 # "--cached" is accepted only by "status" and "summary"
1040 if test -n "$cached" && test "$command" != status
-a "$command" != summary