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 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"
243 module_clone
"$path" "$realrepo" "$reference" ||
exit
247 # ash fails to wordsplit ${branch:+-b "$branch"...}
249 '') git checkout
-f -q ;;
250 ?
*) git checkout
-f -q -B "$branch" "origin/$branch" ;;
252 ) || die
"Unable to checkout submodule '$path'"
254 git config submodule.
"$path".url
"$realrepo"
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".
295 # dup stdin so that it can be restored when running the external
296 # command in the subshell (and a recursive call to this function)
300 while read mode sha1 stage path
302 if test -e "$path"/.git
304 say
"Entering '$prefix$path'"
305 name
=$
(module_name
"$path")
307 prefix
="$prefix$path/"
311 if test -n "$recursive"
313 cmd_foreach
"--recursive" "$@"
316 die
"Stopping at '$path'; script returned non-zero status."
322 # Register submodules in .git/config
324 # $@ = requested paths (default to all)
328 # parse $args after "submodule ... init".
350 while read mode sha1 stage path
352 # Skip already registered paths
353 name
=$
(module_name
"$path") ||
exit
354 if test -z "$(git config "submodule.
$name.url
")"
356 url
=$
(git config
-f .gitmodules submodule.
"$name".url
)
358 die
"No url found for submodule path '$path' in .gitmodules"
360 # Possibly a url relative to parent
363 url
=$
(resolve_relative_url
"$url") ||
exit
366 git config submodule.
"$name".url
"$url" ||
367 die
"Failed to register url for submodule path '$path'"
370 # Copy "update" setting when it is not set yet
371 upd
="$(git config -f .gitmodules submodule."$name".update)"
373 test -n "$(git config submodule."$name".update)" ||
374 git config submodule.
"$name".update
"$upd" ||
375 die
"Failed to register update mode for submodule path '$path'"
377 say
"Submodule '$name' ($url) registered for path '$path'"
382 # Update each submodule path to correct revision, using clone and checkout as needed
384 # $@ = requested paths (default to all)
388 # parse $args after "submodule ... update".
409 case "$2" in '') usage
;; esac
410 reference
="--reference=$2"
411 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
434 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
440 cmd_init
"--" "$@" ||
return
445 while read mode sha1 stage path
449 echo >&2 "Skipping unmerged submodule $path"
452 name
=$
(module_name
"$path") ||
exit
453 url
=$
(git config submodule.
"$name".url
)
454 update_module
=$
(git config submodule.
"$name".update
)
457 # Only mention uninitialized submodules when its
458 # path have been specified
460 say
"Submodule path '$path' not initialized" &&
461 say
"Maybe you want to use 'update --init'?"
465 if ! test -d "$path"/.git
-o -f "$path"/.git
467 module_clone
"$path" "$url" "$reference"||
exit
468 cloned_modules
="$cloned_modules;$name"
471 subsha1
=$
(clear_local_git_env
; cd "$path" &&
472 git rev-parse
--verify HEAD
) ||
473 die
"Unable to find current revision in submodule path '$path'"
476 if ! test -z "$update"
478 update_module
=$update
481 if test "$subsha1" != "$sha1"
484 # If we don't already have a -f flag and the submodule has never been checked out
485 if test -z "$subsha1" -a -z "$force"
490 if test -z "$nofetch"
492 # Run fetch only if $sha1 isn't present or it
493 # is not reachable from a ref.
494 (clear_local_git_env
; cd "$path" &&
495 ( (rev=$
(git rev-list
-n 1 $sha1 --not --all 2>/dev
/null
) &&
496 test -z "$rev") || git-fetch
)) ||
497 die
"Unable to fetch in submodule path '$path'"
500 # Is this something we just cloned?
501 case ";$cloned_modules;" in
503 # then there is no local change to integrate
507 case "$update_module" in
519 command="git checkout $subforce -q"
525 (clear_local_git_env
; cd "$path" && $command "$sha1") ||
526 die
"Unable to $action '$sha1' in submodule path '$path'"
527 say
"Submodule path '$path': $msg '$sha1'"
530 if test -n "$recursive"
532 (clear_local_git_env
; cd "$path" && eval cmd_update
"$orig_flags") ||
533 die
"Failed to recurse into submodule path '$path'"
542 git describe
"$2" 2>/dev
/null ||
543 git describe
--tags "$2" 2>/dev
/null ||
544 git describe
--contains "$2" 2>/dev
/null ||
545 git describe
--all --always "$2"
548 test -z "$revname" || revname
=" ($revname)"
551 # Show commit summary for submodules in index or working tree
553 # If '--cached' is given, show summary between index and given commit,
554 # or between working tree and given commit
556 # $@ = [commit (default 'HEAD'),] requested paths (default all)
563 # parse $args after "submodule ... summary".
577 if summary_limit
=$
(($2 + 0)) 2>/dev
/null
&& test "$summary_limit" = "$2"
599 test $summary_limit = 0 && return
601 if rev=$
(git rev-parse
-q --verify --default HEAD
${1+"$1"})
605 elif test -z "$1" -o "$1" = "HEAD"
607 # before the first commit: compare with an empty tree
608 head=$
(git hash-object
-w -t tree
--stdin </dev
/null
)
609 test -z "$1" ||
shift
617 die
"--cached cannot be used with --files"
623 # Get modified modules cared by user
624 modules
=$
(git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- "$@" |
625 sane_egrep
'^:([0-7]* )?160000' |
626 while read mod_src mod_dst sha1_src sha1_dst status name
628 # Always show modules deleted or type-changed (blob<->module)
629 test $status = D
-o $status = T
&& echo "$name" && continue
630 # Also show added or modified modules which are checked out
631 GIT_DIR
="$name/.git" git-rev-parse
--git-dir >/dev
/null
2>&1 &&
636 test -z "$modules" && return
638 git
$diff_cmd $cached --ignore-submodules=dirty
--raw $head -- $modules |
639 sane_egrep
'^:([0-7]* )?160000' |
641 while read mod_src mod_dst sha1_src sha1_dst status name
643 if test -z "$cached" &&
644 test $sha1_dst = 0000000000000000000000000000000000000000
648 sha1_dst
=$
(GIT_DIR
="$name/.git" git rev-parse HEAD
)
650 100644 |
100755 |
120000)
651 sha1_dst
=$
(git hash-object
$name)
657 echo >&2 "unexpected mode $mod_dst"
664 test $mod_src = 160000 &&
665 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_src^
0 >/dev
/null
&&
668 test $mod_dst = 160000 &&
669 ! GIT_DIR
="$name/.git" git-rev-parse
-q --verify $sha1_dst^
0 >/dev
/null
&&
673 case "$missing_src,$missing_dst" in
675 errmsg
=" Warn: $name doesn't contain commit $sha1_src"
678 errmsg
=" Warn: $name doesn't contain commit $sha1_dst"
681 errmsg
=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
686 if test $mod_src = 160000 -a $mod_dst = 160000
688 range
="$sha1_src...$sha1_dst"
689 elif test $mod_src = 160000
695 GIT_DIR
="$name/.git" \
696 git rev-list
--first-parent $range -- |
wc -l
698 total_commits
=" ($(($total_commits + 0)))"
702 sha1_abbr_src
=$
(echo $sha1_src | cut
-c1-7)
703 sha1_abbr_dst
=$
(echo $sha1_dst | cut
-c1-7)
706 if test $mod_dst = 160000
708 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
710 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
713 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
717 # Don't give error msg for modification whose dst is not submodule
718 # i.e. deleted or changed to blob
719 test $mod_dst = 160000 && echo "$errmsg"
721 if test $mod_src = 160000 -a $mod_dst = 160000
724 test $summary_limit -gt 0 && limit
="-$summary_limit"
725 GIT_DIR
="$name/.git" \
726 git log
$limit --pretty='format: %m %s' \
727 --first-parent $sha1_src...
$sha1_dst
728 elif test $mod_dst = 160000
730 GIT_DIR
="$name/.git" \
731 git log
--pretty='format: > %s' -1 $sha1_dst
733 GIT_DIR
="$name/.git" \
734 git log
--pretty='format: < %s' -1 $sha1_src
740 if test -n "$for_status"; then
741 if [ -n "$files" ]; then
742 echo "# Submodules changed but not updated:"
744 echo "# Submodule changes to be committed:"
747 sed -e 's|^|# |' -e 's|^# $|#|'
753 # List all submodules, prefixed with:
754 # - submodule not initialized
755 # + different revision checked out
757 # If --cached was specified the revision in the index will be printed
758 # instead of the currently checked out revision.
760 # $@ = requested paths (default to all)
764 # parse $args after "submodule ... status".
789 orig_flags
="$orig_flags $(git rev-parse --sq-quote "$1")"
794 while read mode sha1 stage path
796 name
=$
(module_name
"$path") ||
exit
797 url
=$
(git config submodule.
"$name".url
)
798 displaypath
="$prefix$path"
801 say
"U$sha1 $displaypath"
804 if test -z "$url" ||
! test -d "$path"/.git
-o -f "$path"/.git
806 say
"-$sha1 $displaypath"
809 set_name_rev
"$path" "$sha1"
810 if git diff-files
--ignore-submodules=dirty
--quiet -- "$path"
812 say
" $sha1 $displaypath$revname"
816 sha1
=$
(clear_local_git_env
; cd "$path" && git rev-parse
--verify HEAD
)
817 set_name_rev
"$path" "$sha1"
819 say
"+$sha1 $displaypath$revname"
822 if test -n "$recursive"
825 prefix
="$displaypath/"
828 eval cmd_status
"$orig_args"
830 die
"Failed to recurse into submodule path '$path'"
835 # Sync remote urls for submodules
836 # This makes the value for remote.$remote.url match the value
837 # specified in .gitmodules.
862 while read mode sha1 stage path
864 name
=$
(module_name
"$path")
865 url
=$
(git config
-f .gitmodules
--get submodule.
"$name".url
)
867 # Possibly a url relative to parent
870 url
=$
(resolve_relative_url
"$url") ||
exit
874 if git config
"submodule.$name.url" >/dev
/null
2>/dev
/null
876 say
"Synchronizing submodule url for '$name'"
877 git config submodule.
"$name".url
"$url"
879 if test -e "$path"/.git
884 remote
=$
(get_default_remote
)
885 git config remote.
"$remote".url
"$url"
892 # This loop parses the command line arguments to find the
893 # subcommand name to dispatch. Parsing of the subcommand specific
894 # options are primarily done by the subcommand implementations.
895 # Subcommand specific options such as --branch and --cached are
896 # parsed here as well, for backward compatibility.
898 while test $# != 0 && test -z "$command"
901 add | foreach | init | update | status | summary | sync
)
931 # No command word defaults to "status"
932 test -n "$command" ||
command=status
934 # "-b branch" is accepted only by "add"
935 if test -n "$branch" && test "$command" != add
940 # "--cached" is accepted only by "status" and "summary"
941 if test -n "$cached" && test "$command" != status
-a "$command" != summary