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
"$(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 "$GIT_QUIET"
131 if test -n "$reference"
133 git-clone
$quiet "$reference" -n "$url" "$path"
135 git-clone
$quiet -n "$url" "$path"
137 die
"$(eval_gettext "Clone of
'\$url' into submodule path
'\$path' failed
")"
141 # Add a new submodule to the working tree, .gitmodules and the index
145 # optional branch is stored in global branch variable
149 # parse $args after "submodule ... add".
154 case "$2" in '') usage
;; esac
165 case "$2" in '') usage
;; esac
166 reference
="--reference=$2"
190 if test -z "$path"; then
191 path
=$
(echo "$repo" |
192 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
195 if test -z "$repo" -o -z "$path"; then
199 # assure repo is absolute or relative to parent
202 # dereference source url relative to parent's url
203 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
210 die
"$(eval_gettext "repo URL
: '\$repo' must be absolute or begin with .
/|..
/")"
215 # multiple //; leading ./; /./; /../; trailing /
216 path
=$
(printf '%s/\n' "$path" |
226 git ls-files
--error-unmatch "$path" > /dev
/null
2>&1 &&
227 die
"$(eval_gettext "'\$path' already exists
in the index
")"
229 if test -z "$force" && ! git add
--dry-run --ignore-missing "$path" > /dev
/null
2>&1
232 The following path is ignored by one of your .gitignore files:
234 Use -f if you really want to add it.
239 # perhaps the path exists and is already a git repo, else clone it
242 if test -d "$path"/.git
-o -f "$path"/.git
244 eval_gettext
"Adding existing repo at '\$path' to the index"; echo
246 die
"$(eval_gettext "'\$path' already exists and is not a valid git repo
")"
251 module_clone
"$path" "$realrepo" "$reference" ||
exit
255 # ash fails to wordsplit ${branch:+-b "$branch"...}
257 '') git checkout
-f -q ;;
258 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
260 ) || die
"$(eval_gettext "Unable to checkout submodule
'\$path'")"
262 git config submodule.
"$path".url
"$realrepo"
264 git add
$force "$path" ||
265 die
"$(eval_gettext "Failed to add submodule
'\$path'")"
267 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
268 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
269 git add
--force .gitmodules ||
270 die
"$(eval_gettext "Failed to register submodule
'\$path'")"
274 # Execute an arbitrary command sequence in each checked out
277 # $@ = command to execute
281 # parse $args after "submodule ... foreach".
303 # dup stdin so that it can be restored when running the external
304 # command in the subshell (and a recursive call to this function)
308 while read mode sha1 stage path
310 if test -e "$path"/.git
312 say
"$(eval_gettext "Entering
'\$prefix\$path'")"
313 name
=$
(module_name
"$path")
315 prefix
="$prefix$path/"
319 if test -n "$recursive"
321 cmd_foreach
"--recursive" "$@"
324 die
"$(eval_gettext "Stopping
at '\$path'; script returned non-zero status.
")"
330 # Register submodules in .git/config
332 # $@ = requested paths (default to all)
336 # parse $args after "submodule ... init".
358 while read mode sha1 stage path
360 # Skip already registered paths
361 name
=$
(module_name
"$path") ||
exit
362 if test -z "$(git config "submodule.
$name.url
")"
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
374 git config submodule.
"$name".url
"$url" ||
375 die
"$(eval_gettext "Failed to register url
for submodule path
'\$path'")"
378 # Copy "update" setting when it is not set yet
379 upd
="$(git config -f .gitmodules submodule."$name".update)"
381 test -n "$(git config submodule."$name".update)" ||
382 git config submodule.
"$name".update
"$upd" ||
383 die
"$(eval_gettext "Failed to register update mode
for submodule path
'\$path'")"
385 say
"$(eval_gettext "Submodule
'\$name' (\
$url) registered
for path
'\$path'")"
390 # Update each submodule path to correct revision, using clone and checkout as needed
392 # $@ = requested paths (default to all)
396 # parse $args after "submodule ... update".
417 case "$2" in '') usage
;; esac
418 reference
="--reference=$2"
419 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
442 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
448 cmd_init
"--" "$@" ||
return
454 while read mode sha1 stage path
458 echo >&2 "Skipping unmerged submodule $path"
461 name
=$
(module_name
"$path") ||
exit
462 url
=$
(git config submodule.
"$name".url
)
463 update_module
=$
(git config submodule.
"$name".update
)
466 # Only mention uninitialized submodules when its
467 # path have been specified
469 say
"$(eval_gettext "Submodule path
'\$path' not initialized
470 Maybe you want to use
'update --init'?
")"
474 if ! test -d "$path"/.git
-o -f "$path"/.git
476 module_clone
"$path" "$url" "$reference"||
exit
477 cloned_modules
="$cloned_modules;$name"
480 subsha1
=$
(clear_local_git_env
; cd "$path" &&
481 git rev-parse
--verify HEAD
) ||
482 die
"$(eval_gettext "Unable to
find current revision
in submodule path
'\$path'")"
485 if ! test -z "$update"
487 update_module
=$update
490 if test "$subsha1" != "$sha1"
493 # If we don't already have a -f flag and the submodule has never been checked out
494 if test -z "$subsha1" -a -z "$force"
499 if test -z "$nofetch"
501 # Run fetch only if $sha1 isn't present or it
502 # is not reachable from a ref.
503 (clear_local_git_env
; cd "$path" &&
504 ( (rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
505 test -z "$rev") || git-fetch
)) ||
506 die
"$(eval_gettext "Unable to fetch
in submodule path
'\$path'")"
509 # Is this something we just cloned?
510 case ";$cloned_modules;" in
512 # then there is no local change to integrate
517 case "$update_module" in
520 die_msg
="$(eval_gettext "Unable to rebase
'\$sha1' in submodule path
'\$path'")"
521 say_msg
="$(eval_gettext "Submodule path
'\$path': rebased into
'\$sha1'")"
522 must_die_on_failure
=yes
526 die_msg
="$(eval_gettext "Unable to merge
'\$sha1' in submodule path
'\$path'")"
527 say_msg
="$(eval_gettext "Submodule path
'\$path': merged
in '\$sha1'")"
528 must_die_on_failure
=yes
531 command="git checkout $subforce -q"
532 die_msg
="$(eval_gettext "Unable to checkout
'\$sha1' in submodule path
'\$path'")"
533 say_msg
="$(eval_gettext "Submodule path
'\$path': checked out
'\$sha1'")"
537 if (clear_local_git_env
; cd "$path" && $command "$sha1")
540 elif test -n "$must_die_on_failure"
542 die_with_status
2 "$die_msg"
544 err
="${err};$die_msg"
549 if test -n "$recursive"
551 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags")
555 die_msg
="$(eval_gettext "Failed to recurse into submodule path
'\$path'")"
558 err
="${err};$die_msg"
561 die_with_status
$res "$die_msg"
588 git describe
"$2" 2>/dev
/null ||
589 git describe
--tags "$2" 2>/dev
/null ||
590 git describe
--contains "$2" 2>/dev
/null ||
591 git describe
--all --always "$2"
594 test -z "$revname" || revname
=" ($revname)"
597 # Show commit summary for submodules in index or working tree
599 # If '--cached' is given, show summary between index and given commit,
600 # or between working tree and given commit
602 # $@ = [commit (default 'HEAD'),] requested paths (default all)
609 # parse $args after "submodule ... summary".
623 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
645 test $summary_limit = 0 && return
647 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
651 elif test -z "$1" -o "$1" = "HEAD"
653 # before the first commit: compare with an empty tree
654 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
655 test -z "$1" ||
shift
663 die
"$(gettext -- "--cached cannot be used with
--files")"
669 # Get modified modules cared by user
670 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
671 sane_egrep
'^:([0-7]* )?160000' |
672 while read mod_src mod_dst sha1_src sha1_dst status name
674 # Always show modules deleted or type-changed (blob<->module)
675 test $status = D
-o $status = T
&& echo "$name" && continue
676 # Also show added or modified modules which are checked out
677 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
682 test -z "$modules" && return
684 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
685 sane_egrep
'^:([0-7]* )?160000' |
687 while read mod_src mod_dst sha1_src sha1_dst status name
689 if test -z "$cached" &&
690 test $sha1_dst = 0000000000000000000000000000000000000000
694 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
696 100644 |
100755 |
120000)
697 sha1_dst
=$
(git hash-object
$name)
704 eval_gettext
"unexpected mode \$mod_dst" &&
713 test $mod_src = 160000 &&
714 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
717 test $mod_dst = 160000 &&
718 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
722 case "$missing_src,$missing_dst" in
724 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commit \$sha1_src")"
727 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \
$sha1_dst")"
730 errmsg
="$(eval_gettext " Warn
: \
$name doesn
't contain commits \$sha1_src and \$sha1_dst")"
735 if test $mod_src = 160000 -a $mod_dst = 160000
737 range="$sha1_src...$sha1_dst"
738 elif test $mod_src = 160000
744 GIT_DIR="$name/.git" \
745 git rev-list --first-parent $range -- | wc -l
747 total_commits=" ($(($total_commits + 0)))"
751 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
752 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
755 blob="$(gettext "blob")"
756 submodule="$(gettext "submodule")"
757 if test $mod_dst = 160000
759 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
761 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
764 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
768 # Don't give error msg
for modification whose dst is not submodule
769 # i.e. deleted or changed to blob
770 test $mod_dst = 160000 && echo "$errmsg"
772 if test $mod_src = 160000 -a $mod_dst = 160000
775 test $summary_limit -gt 0 && limit
="-$summary_limit"
776 GIT_DIR
="$name/.git" \
777 git log
$limit --pretty='format: %m %s' \
778 --first-parent $sha1_src...
$sha1_dst
779 elif test $mod_dst = 160000
781 GIT_DIR
="$name/.git" \
782 git log
--pretty='format: > %s' -1 $sha1_dst
784 GIT_DIR
="$name/.git" \
785 git log
--pretty='format: < %s' -1 $sha1_src
791 if test -n "$for_status"; then
792 if [ -n "$files" ]; then
793 status_msg
="$(gettext "# Submodules changed but not updated:")"
795 status_msg
="$(gettext "# Submodule changes to be committed:")"
797 status_sed
=$
(sed -e 's|^|# |' -e 's|^# $|#|')
808 # List all submodules, prefixed with:
809 # - submodule not initialized
810 # + different revision checked out
812 # If --cached was specified the revision in the index will be printed
813 # instead of the currently checked out revision.
815 # $@ = requested paths (default to all)
819 # parse $args after "submodule ... status".
844 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
849 while read mode sha1 stage path
851 name
=$
(module_name
"$path") ||
exit
852 url
=$
(git config submodule.
"$name".url
)
853 displaypath
="$prefix$path"
856 say
"U$sha1 $displaypath"
859 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
861 say
"-$sha1 $displaypath"
864 set_name_rev
"$path" "$sha1"
865 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
867 say
" $sha1 $displaypath$revname"
871 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
872 set_name_rev
"$path" "$sha1"
874 say
"+$sha1 $displaypath$revname"
877 if test -n "$recursive"
880 prefix
="$displaypath/"
883 eval cmd_status
"$orig_args"
885 die
"$(eval_gettext "Failed to recurse into submodule path
'\$path'")"
890 # Sync remote urls for submodules
891 # This makes the value for remote.$remote.url match the value
892 # specified in .gitmodules.
917 while read mode sha1 stage path
919 name
=$
(module_name
"$path")
920 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
922 # Possibly a url relative to parent
925 url
=$
(resolve_relative_url
"$url") ||
exit
929 if git config
"submodule.$name.url" >/dev
/null
2>/dev
/null
931 say
"$(eval_gettext "Synchronizing submodule url
for '\$name'")"
932 git config submodule.
"$name".url
"$url"
934 if test -e "$path"/.git
939 remote
=$
(get_default_remote
)
940 git config remote.
"$remote".url
"$url"
947 # This loop parses the command line arguments to find the
948 # subcommand name to dispatch. Parsing of the subcommand specific
949 # options are primarily done by the subcommand implementations.
950 # Subcommand specific options such as --branch and --cached are
951 # parsed here as well, for backward compatibility.
953 while test $# != 0 && test -z "$command"
956 add | foreach | init | update | status | summary | sync
)
986 # No command word defaults to "status"
987 test -n "$command" ||
command=status
989 # "-b branch" is accepted only by "add"
990 if test -n "$branch" && test "$command" != add
995 # "--cached" is accepted only by "status" and "summary"
996 if test -n "$cached" && test "$command" != status
-a "$command" != summary