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>...]"
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 die
"remote ($remote) does not have a url defined in .git/config"
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"
243 url
=$
(resolve_relative_url
"$repo") ||
exit
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
"Unable to checkout submodule '$path'"
262 git config submodule.
"$path".url
"$url"
264 git add
$force "$path" ||
265 die
"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
"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
"Entering '$prefix$path'"
313 name
=$
(module_name
"$path")
315 prefix
="$prefix$path/"
319 if test -n "$recursive"
321 cmd_foreach
"--recursive" "$@"
324 die
"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
"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
"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
"Failed to register update mode for submodule path '$path'"
385 say
"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
453 while read mode sha1 stage path
457 echo >&2 "Skipping unmerged submodule $path"
460 name
=$
(module_name
"$path") ||
exit
461 url
=$
(git config submodule.
"$name".url
)
462 update_module
=$
(git config submodule.
"$name".update
)
465 # Only mention uninitialized submodules when its
466 # path have been specified
468 say
"Submodule path '$path' not initialized" &&
469 say
"Maybe you want to use 'update --init'?"
473 if ! test -d "$path"/.git
-o -f "$path"/.git
475 module_clone
"$path" "$url" "$reference"||
exit
476 cloned_modules
="$cloned_modules;$name"
479 subsha1
=$
(clear_local_git_env
; cd "$path" &&
480 git rev-parse
--verify HEAD
) ||
481 die
"Unable to find current revision in submodule path '$path'"
484 if ! test -z "$update"
486 update_module
=$update
489 if test "$subsha1" != "$sha1"
492 # If we don't already have a -f flag and the submodule has never been checked out
493 if test -z "$subsha1" -a -z "$force"
498 if test -z "$nofetch"
500 # Run fetch only if $sha1 isn't present or it
501 # is not reachable from a ref.
502 (clear_local_git_env
; cd "$path" &&
503 ( (rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
504 test -z "$rev") || git-fetch
)) ||
505 die
"Unable to fetch in submodule path '$path'"
508 # Is this something we just cloned?
509 case ";$cloned_modules;" in
511 # then there is no local change to integrate
515 case "$update_module" in
527 command="git checkout $subforce -q"
533 (clear_local_git_env
; cd "$path" && $command "$sha1") ||
534 die
"Unable to $action '$sha1' in submodule path '$path'"
535 say
"Submodule path '$path': $msg '$sha1'"
538 if test -n "$recursive"
540 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags") ||
541 die
"Failed to recurse into submodule path '$path'"
550 git describe
"$2" 2>/dev
/null ||
551 git describe
--tags "$2" 2>/dev
/null ||
552 git describe
--contains "$2" 2>/dev
/null ||
553 git describe
--all --always "$2"
556 test -z "$revname" || revname
=" ($revname)"
559 # Show commit summary for submodules in index or working tree
561 # If '--cached' is given, show summary between index and given commit,
562 # or between working tree and given commit
564 # $@ = [commit (default 'HEAD'),] requested paths (default all)
571 # parse $args after "submodule ... summary".
585 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
607 test $summary_limit = 0 && return
609 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
613 elif test -z "$1" -o "$1" = "HEAD"
615 # before the first commit: compare with an empty tree
616 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
617 test -z "$1" ||
shift
625 die
"--cached cannot be used with --files"
631 # Get modified modules cared by user
632 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
633 sane_egrep
'^:([0-7]* )?160000' |
634 while read mod_src mod_dst sha1_src sha1_dst status name
636 # Always show modules deleted or type-changed (blob<->module)
637 test $status = D
-o $status = T
&& echo "$name" && continue
638 # Also show added or modified modules which are checked out
639 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
644 test -z "$modules" && return
646 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
647 sane_egrep
'^:([0-7]* )?160000' |
649 while read mod_src mod_dst sha1_src sha1_dst status name
651 if test -z "$cached" &&
652 test $sha1_dst = 0000000000000000000000000000000000000000
656 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
658 100644 |
100755 |
120000)
659 sha1_dst
=$
(git hash-object
$name)
665 echo >&2 "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
=" Warn: $name doesn't contain commit $sha1_src"
686 errmsg
=" Warn: $name doesn't contain commit $sha1_dst"
689 errmsg
=" 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 if test $mod_dst = 160000
716 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
718 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
721 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
725 # Don't give error msg for modification whose dst is not submodule
726 # i.e. deleted or changed to blob
727 test $mod_dst = 160000 && echo "$errmsg"
729 if test $mod_src = 160000 -a $mod_dst = 160000
732 test $summary_limit -gt 0 && limit
="-$summary_limit"
733 GIT_DIR
="$name/.git" \
734 git log
$limit --pretty='format: %m %s' \
735 --first-parent $sha1_src...
$sha1_dst
736 elif test $mod_dst = 160000
738 GIT_DIR
="$name/.git" \
739 git log
--pretty='format: > %s' -1 $sha1_dst
741 GIT_DIR
="$name/.git" \
742 git log
--pretty='format: < %s' -1 $sha1_src
748 if test -n "$for_status"; then
749 if [ -n "$files" ]; then
750 echo "# Submodules changed but not updated:"
752 echo "# Submodule changes to be committed:"
755 sed -e 's|^|# |' -e 's|^# $|#|'
761 # List all submodules, prefixed with:
762 # - submodule not initialized
763 # + different revision checked out
765 # If --cached was specified the revision in the index will be printed
766 # instead of the currently checked out revision.
768 # $@ = requested paths (default to all)
772 # parse $args after "submodule ... status".
797 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
802 while read mode sha1 stage path
804 name
=$
(module_name
"$path") ||
exit
805 url
=$
(git config submodule.
"$name".url
)
806 displaypath
="$prefix$path"
809 say
"U$sha1 $displaypath"
812 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
814 say
"-$sha1 $displaypath"
817 set_name_rev
"$path" "$sha1"
818 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
820 say
" $sha1 $displaypath$revname"
824 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
825 set_name_rev
"$path" "$sha1"
827 say
"+$sha1 $displaypath$revname"
830 if test -n "$recursive"
833 prefix
="$displaypath/"
836 eval cmd_status
"$orig_args"
838 die
"Failed to recurse into submodule path '$path'"
843 # Sync remote urls for submodules
844 # This makes the value for remote.$remote.url match the value
845 # specified in .gitmodules.
870 while read mode sha1 stage path
872 name
=$
(module_name
"$path")
873 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
875 # Possibly a url relative to parent
878 url
=$
(resolve_relative_url
"$url") ||
exit
882 if git config
"submodule.$name.url" >/dev
/null
2>/dev
/null
884 say
"Synchronizing submodule url for '$name'"
885 git config submodule.
"$name".url
"$url"
887 if test -e "$path"/.git
892 remote
=$
(get_default_remote
)
893 git config remote.
"$remote".url
"$url"
900 # This loop parses the command line arguments to find the
901 # subcommand name to dispatch. Parsing of the subcommand specific
902 # options are primarily done by the subcommand implementations.
903 # Subcommand specific options such as --branch and --cached are
904 # parsed here as well, for backward compatibility.
906 while test $# != 0 && test -z "$command"
909 add | foreach | init | update | status | summary | sync
)
939 # No command word defaults to "status"
940 test -n "$command" ||
command=status
942 # "-b branch" is accepted only by "add"
943 if test -n "$branch" && test "$command" != add
948 # "--cached" is accepted only by "status" and "summary"
949 if test -n "$cached" && test "$command" != status
-a "$command" != summary