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] [--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 remoteurl
=$
(pwd) # the repository is its own authoritative upstream
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 -- "$@" |
78 my ($null_sha1) = ("0" x 40);
81 my ($mode, $sha1, $stage, $path) =
82 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
83 next unless $mode eq "160000";
85 if (!$unmerged{$path}++) {
86 print "$mode $null_sha1 U\t$path\n";
96 # Map submodule path to submodule name
102 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
103 re
=$
(printf '%s\n' "$1" |
sed -e 's/[].[^$\\*]/\\&/g')
104 name
=$
( git config
-f .gitmodules
--get-regexp '^submodule\..*\.path$' |
105 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
107 die
"No submodule mapping found in .gitmodules for path '$path'"
114 # Prior to calling, cmd_update checks that a possibly existing
115 # path is not a git repository.
116 # Likewise, cmd_add checks that path does not exist at all,
117 # since it is the location of a new submodule.
125 if test -n "$reference"
127 git-clone
"$reference" -n "$url" "$path"
129 git-clone
-n "$url" "$path"
131 die
"Clone of '$url' into submodule path '$path' failed"
135 # Add a new submodule to the working tree, .gitmodules and the index
139 # optional branch is stored in global branch variable
143 # parse $args after "submodule ... add".
148 case "$2" in '') usage
;; esac
159 case "$2" in '') usage
;; esac
160 reference
="--reference=$2"
184 if test -z "$path"; then
185 path
=$
(echo "$repo" |
186 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
189 if test -z "$repo" -o -z "$path"; then
193 # assure repo is absolute or relative to parent
196 # dereference source url relative to parent's url
197 realrepo
=$
(resolve_relative_url
"$repo") ||
exit
204 die
"repo URL: '$repo' must be absolute or begin with ./|../"
209 # multiple //; leading ./; /./; /../; trailing /
210 path
=$
(printf '%s/\n' "$path" |
220 git ls-files
--error-unmatch "$path" > /dev
/null
2>&1 &&
221 die
"'$path' already exists in the index"
223 if test -z "$force" && ! git add
--dry-run --ignore-missing "$path" > /dev
/null
2>&1
225 echo >&2 "The following path is ignored by one of your .gitignore files:" &&
227 echo >&2 "Use -f if you really want to add it."
231 # perhaps the path exists and is already a git repo, else clone it
234 if test -d "$path"/.git
-o -f "$path"/.git
236 echo "Adding existing repo at '$path' to the index"
238 die
"'$path' already exists and is not a valid git repo"
241 git config submodule.
"$path".url
"$realrepo"
244 module_clone
"$path" "$realrepo" "$reference" ||
exit
248 # ash fails to wordsplit ${branch:+-b "$branch"...}
250 '') git checkout
-f -q ;;
251 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
253 ) || die
"Unable to checkout submodule '$path'"
256 git add
$force "$path" ||
257 die
"Failed to add submodule '$path'"
259 git config
-f .gitmodules submodule.
"$path".path
"$path" &&
260 git config
-f .gitmodules submodule.
"$path".url
"$repo" &&
261 git add
--force .gitmodules ||
262 die
"Failed to register submodule '$path'"
266 # Execute an arbitrary command sequence in each checked out
269 # $@ = command to execute
273 # parse $args after "submodule ... foreach".
296 while read mode sha1 stage path
298 if test -e "$path"/.git
300 say
"Entering '$prefix$path'"
301 name
=$
(module_name
"$path")
303 prefix
="$prefix$path/"
307 if test -n "$recursive"
309 cmd_foreach
"--recursive" "$@"
312 die
"Stopping at '$path'; script returned non-zero status."
318 # Register submodules in .git/config
320 # $@ = requested paths (default to all)
324 # parse $args after "submodule ... init".
346 while read mode sha1 stage path
348 # Skip already registered paths
349 name
=$
(module_name
"$path") ||
exit
350 url
=$
(git config submodule.
"$name".url
)
351 test -z "$url" ||
continue
353 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
355 die
"No url found for submodule path '$path' in .gitmodules"
357 # Possibly a url relative to parent
360 url
=$
(resolve_relative_url
"$url") ||
exit
364 git config submodule.
"$name".url
"$url" ||
365 die
"Failed to register url for submodule path '$path'"
367 upd
="$(git config -f .gitmodules submodule."$name".update)"
369 git config submodule.
"$name".update
"$upd" ||
370 die
"Failed to register update mode for submodule path '$path'"
372 say
"Submodule '$name' ($url) registered for path '$path'"
377 # Update each submodule path to correct revision, using clone and checkout as needed
379 # $@ = requested paths (default to all)
383 # parse $args after "submodule ... update".
401 case "$2" in '') usage
;; esac
402 reference
="--reference=$2"
403 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
426 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
432 cmd_init
"--" "$@" ||
return
437 while read mode sha1 stage path
441 echo >&2 "Skipping unmerged submodule $path"
444 name
=$
(module_name
"$path") ||
exit
445 url
=$
(git config submodule.
"$name".url
)
446 update_module
=$
(git config submodule.
"$name".update
)
449 # Only mention uninitialized submodules when its
450 # path have been specified
452 say
"Submodule path '$path' not initialized" &&
453 say
"Maybe you want to use 'update --init'?"
457 if ! test -d "$path"/.git
-o -f "$path"/.git
459 module_clone
"$path" "$url" "$reference"||
exit
460 cloned_modules
="$cloned_modules;$name"
463 subsha1
=$
(clear_local_git_env
; cd "$path" &&
464 git rev-parse
--verify HEAD
) ||
465 die
"Unable to find current revision in submodule path '$path'"
468 if ! test -z "$update"
470 update_module
=$update
473 if test "$subsha1" != "$sha1"
476 if test -z "$subsha1"
481 if test -z "$nofetch"
483 # Run fetch only if $sha1 isn't present or it
484 # is not reachable from a ref.
485 (clear_local_git_env
; cd "$path" &&
486 ( (rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
487 test -z "$rev") || git-fetch
)) ||
488 die
"Unable to fetch in submodule path '$path'"
491 # Is this something we just cloned?
492 case ";$cloned_modules;" in
494 # then there is no local change to integrate
498 case "$update_module" in
510 command="git checkout $force -q"
516 (clear_local_git_env
; cd "$path" && $command "$sha1") ||
517 die
"Unable to $action '$sha1' in submodule path '$path'"
518 say
"Submodule path '$path': $msg '$sha1'"
521 if test -n "$recursive"
523 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags") ||
524 die
"Failed to recurse into submodule path '$path'"
533 git describe
"$2" 2>/dev
/null ||
534 git describe
--tags "$2" 2>/dev
/null ||
535 git describe
--contains "$2" 2>/dev
/null ||
536 git describe
--all --always "$2"
539 test -z "$revname" || revname
=" ($revname)"
542 # Show commit summary for submodules in index or working tree
544 # If '--cached' is given, show summary between index and given commit,
545 # or between working tree and given commit
547 # $@ = [commit (default 'HEAD'),] requested paths (default all)
554 # parse $args after "submodule ... summary".
568 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
590 test $summary_limit = 0 && return
592 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
596 elif test -z "$1" -o "$1" = "HEAD"
598 # before the first commit: compare with an empty tree
599 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
600 test -z "$1" ||
shift
608 die
"--cached cannot be used with --files"
614 # Get modified modules cared by user
615 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
616 sane_egrep
'^:([0-7]* )?160000' |
617 while read mod_src mod_dst sha1_src sha1_dst status name
619 # Always show modules deleted or type-changed (blob<->module)
620 test $status = D
-o $status = T
&& echo "$name" && continue
621 # Also show added or modified modules which are checked out
622 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
627 test -z "$modules" && return
629 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
630 sane_egrep
'^:([0-7]* )?160000' |
632 while read mod_src mod_dst sha1_src sha1_dst status name
634 if test -z "$cached" &&
635 test $sha1_dst = 0000000000000000000000000000000000000000
639 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
641 100644 |
100755 |
120000)
642 sha1_dst
=$
(git hash-object
$name)
648 echo >&2 "unexpected mode $mod_dst"
655 test $mod_src = 160000 &&
656 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
659 test $mod_dst = 160000 &&
660 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
664 case "$missing_src,$missing_dst" in
666 errmsg
=" Warn: $name doesn't contain commit $sha1_src"
669 errmsg
=" Warn: $name doesn't contain commit $sha1_dst"
672 errmsg
=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
677 if test $mod_src = 160000 -a $mod_dst = 160000
679 range
="$sha1_src...$sha1_dst"
680 elif test $mod_src = 160000
686 GIT_DIR
="$name/.git" \
687 git rev-list
--first-parent $range -- |
wc -l
689 total_commits
=" ($(($total_commits + 0)))"
693 sha1_abbr_src
=$
(echo $sha1_src | cut
-c1-7)
694 sha1_abbr_dst
=$
(echo $sha1_dst | cut
-c1-7)
697 if test $mod_dst = 160000
699 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
701 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
704 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
708 # Don't give error msg for modification whose dst is not submodule
709 # i.e. deleted or changed to blob
710 test $mod_dst = 160000 && echo "$errmsg"
712 if test $mod_src = 160000 -a $mod_dst = 160000
715 test $summary_limit -gt 0 && limit
="-$summary_limit"
716 GIT_DIR
="$name/.git" \
717 git log
$limit --pretty='format: %m %s' \
718 --first-parent $sha1_src...
$sha1_dst
719 elif test $mod_dst = 160000
721 GIT_DIR
="$name/.git" \
722 git log
--pretty='format: > %s' -1 $sha1_dst
724 GIT_DIR
="$name/.git" \
725 git log
--pretty='format: < %s' -1 $sha1_src
731 if test -n "$for_status"; then
732 if [ -n "$files" ]; then
733 echo "# Submodules changed but not updated:"
735 echo "# Submodule changes to be committed:"
738 sed -e 's|^|# |' -e 's|^# $|#|'
744 # List all submodules, prefixed with:
745 # - submodule not initialized
746 # + different revision checked out
748 # If --cached was specified the revision in the index will be printed
749 # instead of the currently checked out revision.
751 # $@ = requested paths (default to all)
755 # parse $args after "submodule ... status".
780 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
785 while read mode sha1 stage path
787 name
=$
(module_name
"$path") ||
exit
788 url
=$
(git config submodule.
"$name".url
)
789 displaypath
="$prefix$path"
792 say
"U$sha1 $displaypath"
795 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
797 say
"-$sha1 $displaypath"
800 set_name_rev
"$path" "$sha1"
801 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
803 say
" $sha1 $displaypath$revname"
807 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
808 set_name_rev
"$path" "$sha1"
810 say
"+$sha1 $displaypath$revname"
813 if test -n "$recursive"
816 prefix
="$displaypath/"
819 eval cmd_status
"$orig_args"
821 die
"Failed to recurse into submodule path '$path'"
826 # Sync remote urls for submodules
827 # This makes the value for remote.$remote.url match the value
828 # specified in .gitmodules.
853 while read mode sha1 stage path
855 name
=$
(module_name
"$path")
856 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
858 # Possibly a url relative to parent
861 url
=$
(resolve_relative_url
"$url") ||
exit
865 say
"Synchronizing submodule url for '$name'"
866 git config submodule.
"$name".url
"$url"
868 if test -e "$path"/.git
873 remote
=$
(get_default_remote
)
874 git config remote.
"$remote".url
"$url"
880 # This loop parses the command line arguments to find the
881 # subcommand name to dispatch. Parsing of the subcommand specific
882 # options are primarily done by the subcommand implementations.
883 # Subcommand specific options such as --branch and --cached are
884 # parsed here as well, for backward compatibility.
886 while test $# != 0 && test -z "$command"
889 add | foreach | init | update | status | summary | sync
)
919 # No command word defaults to "status"
920 test -n "$command" ||
command=status
922 # "-b branch" is accepted only by "add"
923 if test -n "$branch" && test "$command" != add
928 # "--cached" is accepted only by "status" and "summary"
929 if test -n "$cached" && test "$command" != status
-a "$command" != summary