1#!/bin/sh
2#
3# git-submodules.sh: add, init, update or list git submodules
4#
5# Copyright (c) 2007 Lars Hjemli
6dashless=$(basename "$0" | sed -e 's/-/ /')
8USAGE="[--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>...]"
15OPTIONS_SPEC=
16. git-sh-setup
17. git-parse-remote
18require_work_tree
19command=
21branch=
22force=
23reference=
24cached=
25recursive=
26init=
27files=
28nofetch=
29update=
30prefix=
31# Resolve relative url by appending to parent's url
33resolve_relative_url ()
34{
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"
38 url="$1"
39 remoteurl=${remoteurl%/}
40 sep=/
41 while test -n "$url"
42 do
43 case "$url" in
44 ../*)
45 url="${url#../}"
46 case "$remoteurl" in
47 */*)
48 remoteurl="${remoteurl%/*}"
49 ;;
50 *:*)
51 remoteurl="${remoteurl%:*}"
52 sep=:
53 ;;
54 *)
55 die "cannot strip one component off url '$remoteurl'"
56 ;;
57 esac
58 ;;
59 ./*)
60 url="${url#./}"
61 ;;
62 *)
63 break;;
64 esac
65 done
66 echo "$remoteurl$sep${url%/}"
67}
68#
70# Get submodule info for registered submodules
71# $@ = path to limit submodule list
72#
73module_list()
74{
75 git ls-files --error-unmatch --stage -- "$@" | sane_grep '^160000 '
76}
77#
79# Map submodule path to submodule name
80#
81# $1 = path
82#
83module_name()
84{
85 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
86 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
87 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
88 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
89 test -z "$name" &&
90 die "No submodule mapping found in .gitmodules for path '$path'"
91 echo "$name"
92}
93#
95# Clone a submodule
96#
97# Prior to calling, cmd_update checks that a possibly existing
98# path is not a git repository.
99# Likewise, cmd_add checks that path does not exist at all,
100# since it is the location of a new submodule.
101#
102module_clone()
103{
104 path=$1
105 url=$2
106 reference="$3"
107 if test -n "$reference"
109 then
110 git-clone "$reference" -n "$url" "$path"
111 else
112 git-clone -n "$url" "$path"
113 fi ||
114 die "Clone of '$url' into submodule path '$path' failed"
115}
116#
118# Add a new submodule to the working tree, .gitmodules and the index
119#
120# $@ = repo path
121#
122# optional branch is stored in global branch variable
123#
124cmd_add()
125{
126 # parse $args after "submodule ... add".
127 while test $# -ne 0
128 do
129 case "$1" in
130 -b | --branch)
131 case "$2" in '') usage ;; esac
132 branch=$2
133 shift
134 ;;
135 -f | --force)
136 force=$1
137 ;;
138 -q|--quiet)
139 GIT_QUIET=1
140 ;;
141 --reference)
142 case "$2" in '') usage ;; esac
143 reference="--reference=$2"
144 shift
145 ;;
146 --reference=*)
147 reference="$1"
148 shift
149 ;;
150 --)
151 shift
152 break
153 ;;
154 -*)
155 usage
156 ;;
157 *)
158 break
159 ;;
160 esac
161 shift
162 done
163 repo=$1
165 path=$2
166 if test -z "$path"; then
168 path=$(echo "$repo" |
169 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
170 fi
171 if test -z "$repo" -o -z "$path"; then
173 usage
174 fi
175 # assure repo is absolute or relative to parent
177 case "$repo" in
178 ./*|../*)
179 # dereference source url relative to parent's url
180 realrepo=$(resolve_relative_url "$repo") || exit
181 ;;
182 *:*|/*)
183 # absolute url
184 realrepo=$repo
185 ;;
186 *)
187 die "repo URL: '$repo' must be absolute or begin with ./|../"
188 ;;
189 esac
190 # normalize path:
192 # multiple //; leading ./; /./; /../; trailing /
193 path=$(printf '%s/\n' "$path" |
194 sed -e '
195 s|//*|/|g
196 s|^\(\./\)*||
197 s|/\./|/|g
198 :start
199 s|\([^/]*\)/\.\./||
200 tstart
201 s|/*$||
202 ')
203 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
204 die "'$path' already exists in the index"
205 if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
207 then
208 echo >&2 "The following path is ignored by one of your .gitignore files:" &&
209 echo >&2 $path &&
210 echo >&2 "Use -f if you really want to add it."
211 exit 1
212 fi
213 # perhaps the path exists and is already a git repo, else clone it
215 if test -e "$path"
216 then
217 if test -d "$path"/.git -o -f "$path"/.git
218 then
219 echo "Adding existing repo at '$path' to the index"
220 else
221 die "'$path' already exists and is not a valid git repo"
222 fi
223 case "$repo" in
225 ./*|../*)
226 url=$(resolve_relative_url "$repo") || exit
227 ;;
228 *)
229 url="$repo"
230 ;;
231 esac
232 git config submodule."$path".url "$url"
233 else
234 module_clone "$path" "$realrepo" "$reference" || exit
236 (
237 clear_local_git_env
238 cd "$path" &&
239 # ash fails to wordsplit ${branch:+-b "$branch"...}
240 case "$branch" in
241 '') git checkout -f -q ;;
242 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
243 esac
244 ) || die "Unable to checkout submodule '$path'"
245 fi
246 git add $force "$path" ||
248 die "Failed to add submodule '$path'"
249 git config -f .gitmodules submodule."$path".path "$path" &&
251 git config -f .gitmodules submodule."$path".url "$repo" &&
252 git add --force .gitmodules ||
253 die "Failed to register submodule '$path'"
254}
255#
257# Execute an arbitrary command sequence in each checked out
258# submodule
259#
260# $@ = command to execute
261#
262cmd_foreach()
263{
264 # parse $args after "submodule ... foreach".
265 while test $# -ne 0
266 do
267 case "$1" in
268 -q|--quiet)
269 GIT_QUIET=1
270 ;;
271 --recursive)
272 recursive=1
273 ;;
274 -*)
275 usage
276 ;;
277 *)
278 break
279 ;;
280 esac
281 shift
282 done
283 toplevel=$(pwd)
285 module_list |
287 while read mode sha1 stage path
288 do
289 if test -e "$path"/.git
290 then
291 say "Entering '$prefix$path'"
292 name=$(module_name "$path")
293 (
294 prefix="$prefix$path/"
295 clear_local_git_env
296 cd "$path" &&
297 eval "$@" &&
298 if test -n "$recursive"
299 then
300 cmd_foreach "--recursive" "$@"
301 fi
302 ) ||
303 die "Stopping at '$path'; script returned non-zero status."
304 fi
305 done
306}
307#
309# Register submodules in .git/config
310#
311# $@ = requested paths (default to all)
312#
313cmd_init()
314{
315 # parse $args after "submodule ... init".
316 while test $# -ne 0
317 do
318 case "$1" in
319 -q|--quiet)
320 GIT_QUIET=1
321 ;;
322 --)
323 shift
324 break
325 ;;
326 -*)
327 usage
328 ;;
329 *)
330 break
331 ;;
332 esac
333 shift
334 done
335 module_list "$@" |
337 while read mode sha1 stage path
338 do
339 # Skip already registered paths
340 name=$(module_name "$path") || exit
341 url=$(git config submodule."$name".url)
342 test -z "$url" || continue
343 url=$(git config -f .gitmodules submodule."$name".url)
345 test -z "$url" &&
346 die "No url found for submodule path '$path' in .gitmodules"
347 # Possibly a url relative to parent
349 case "$url" in
350 ./*|../*)
351 url=$(resolve_relative_url "$url") || exit
352 ;;
353 esac
354 git config submodule."$name".url "$url" ||
356 die "Failed to register url for submodule path '$path'"
357 upd="$(git config -f .gitmodules submodule."$name".update)"
359 test -z "$upd" ||
360 git config submodule."$name".update "$upd" ||
361 die "Failed to register update mode for submodule path '$path'"
362 say "Submodule '$name' ($url) registered for path '$path'"
364 done
365}
366#
368# Update each submodule path to correct revision, using clone and checkout as needed
369#
370# $@ = requested paths (default to all)
371#
372cmd_update()
373{
374 # parse $args after "submodule ... update".
375 orig_flags=
376 while test $# -ne 0
377 do
378 case "$1" in
379 -q|--quiet)
380 GIT_QUIET=1
381 ;;
382 -i|--init)
383 init=1
384 ;;
385 -N|--no-fetch)
386 nofetch=1
387 ;;
388 -f|--force)
389 force=$1
390 ;;
391 -r|--rebase)
392 update="rebase"
393 ;;
394 --reference)
395 case "$2" in '') usage ;; esac
396 reference="--reference=$2"
397 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
398 shift
399 ;;
400 --reference=*)
401 reference="$1"
402 ;;
403 -m|--merge)
404 update="merge"
405 ;;
406 --recursive)
407 recursive=1
408 ;;
409 --)
410 shift
411 break
412 ;;
413 -*)
414 usage
415 ;;
416 *)
417 break
418 ;;
419 esac
420 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
421 shift
422 done
423 if test -n "$init"
425 then
426 cmd_init "--" "$@" || return
427 fi
428 cloned_modules=
430 module_list "$@" |
431 while read mode sha1 stage path
432 do
433 name=$(module_name "$path") || exit
434 url=$(git config submodule."$name".url)
435 update_module=$(git config submodule."$name".update)
436 if test -z "$url"
437 then
438 # Only mention uninitialized submodules when its
439 # path have been specified
440 test "$#" != "0" &&
441 say "Submodule path '$path' not initialized" &&
442 say "Maybe you want to use 'update --init'?"
443 continue
444 fi
445 if ! test -d "$path"/.git -o -f "$path"/.git
447 then
448 module_clone "$path" "$url" "$reference"|| exit
449 cloned_modules="$cloned_modules;$name"
450 subsha1=
451 else
452 subsha1=$(clear_local_git_env; cd "$path" &&
453 git rev-parse --verify HEAD) ||
454 die "Unable to find current revision in submodule path '$path'"
455 fi
456 if ! test -z "$update"
458 then
459 update_module=$update
460 fi
461 if test "$subsha1" != "$sha1"
463 then
464 subforce=$force
465 # If we don't already have a -f flag and the submodule has never been checked out
466 if test -z "$subsha1" -a -z "$force"
467 then
468 subforce="-f"
469 fi
470 if test -z "$nofetch"
472 then
473 (clear_local_git_env; cd "$path" &&
474 git-fetch) ||
475 die "Unable to fetch in submodule path '$path'"
476 fi
477 # Is this something we just cloned?
479 case ";$cloned_modules;" in
480 *";$name;"*)
481 # then there is no local change to integrate
482 update_module= ;;
483 esac
484 case "$update_module" in
486 rebase)
487 command="git rebase"
488 action="rebase"
489 msg="rebased onto"
490 ;;
491 merge)
492 command="git merge"
493 action="merge"
494 msg="merged in"
495 ;;
496 *)
497 command="git checkout $subforce -q"
498 action="checkout"
499 msg="checked out"
500 ;;
501 esac
502 (clear_local_git_env; cd "$path" && $command "$sha1") ||
504 die "Unable to $action '$sha1' in submodule path '$path'"
505 say "Submodule path '$path': $msg '$sha1'"
506 fi
507 if test -n "$recursive"
509 then
510 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") ||
511 die "Failed to recurse into submodule path '$path'"
512 fi
513 done
514}
515set_name_rev () {
517 revname=$( (
518 clear_local_git_env
519 cd "$1" && {
520 git describe "$2" 2>/dev/null ||
521 git describe --tags "$2" 2>/dev/null ||
522 git describe --contains "$2" 2>/dev/null ||
523 git describe --all --always "$2"
524 }
525 ) )
526 test -z "$revname" || revname=" ($revname)"
527}
528#
529# Show commit summary for submodules in index or working tree
530#
531# If '--cached' is given, show summary between index and given commit,
532# or between working tree and given commit
533#
534# $@ = [commit (default 'HEAD'),] requested paths (default all)
535#
536cmd_summary() {
537 summary_limit=-1
538 for_status=
539 diff_cmd=diff-index
540 # parse $args after "submodule ... summary".
542 while test $# -ne 0
543 do
544 case "$1" in
545 --cached)
546 cached="$1"
547 ;;
548 --files)
549 files="$1"
550 ;;
551 --for-status)
552 for_status="$1"
553 ;;
554 -n|--summary-limit)
555 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
556 then
557 :
558 else
559 usage
560 fi
561 shift
562 ;;
563 --)
564 shift
565 break
566 ;;
567 -*)
568 usage
569 ;;
570 *)
571 break
572 ;;
573 esac
574 shift
575 done
576 test $summary_limit = 0 && return
578 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
580 then
581 head=$rev
582 test $# = 0 || shift
583 elif test -z "$1" -o "$1" = "HEAD"
584 then
585 # before the first commit: compare with an empty tree
586 head=$(git hash-object -w -t tree --stdin </dev/null)
587 test -z "$1" || shift
588 else
589 head="HEAD"
590 fi
591 if [ -n "$files" ]
593 then
594 test -n "$cached" &&
595 die "--cached cannot be used with --files"
596 diff_cmd=diff-files
597 head=
598 fi
599 cd_to_toplevel
601 # Get modified modules cared by user
602 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
603 sane_egrep '^:([0-7]* )?160000' |
604 while read mod_src mod_dst sha1_src sha1_dst status name
605 do
606 # Always show modules deleted or type-changed (blob<->module)
607 test $status = D -o $status = T && echo "$name" && continue
608 # Also show added or modified modules which are checked out
609 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
610 echo "$name"
611 done
612 )
613 test -z "$modules" && return
615 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
617 sane_egrep '^:([0-7]* )?160000' |
618 cut -c2- |
619 while read mod_src mod_dst sha1_src sha1_dst status name
620 do
621 if test -z "$cached" &&
622 test $sha1_dst = 0000000000000000000000000000000000000000
623 then
624 case "$mod_dst" in
625 160000)
626 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
627 ;;
628 100644 | 100755 | 120000)
629 sha1_dst=$(git hash-object $name)
630 ;;
631 000000)
632 ;; # removed
633 *)
634 # unexpected type
635 echo >&2 "unexpected mode $mod_dst"
636 continue ;;
637 esac
638 fi
639 missing_src=
640 missing_dst=
641 test $mod_src = 160000 &&
643 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
644 missing_src=t
645 test $mod_dst = 160000 &&
647 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
648 missing_dst=t
649 total_commits=
651 case "$missing_src,$missing_dst" in
652 t,)
653 errmsg=" Warn: $name doesn't contain commit $sha1_src"
654 ;;
655 ,t)
656 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
657 ;;
658 t,t)
659 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
660 ;;
661 *)
662 errmsg=
663 total_commits=$(
664 if test $mod_src = 160000 -a $mod_dst = 160000
665 then
666 range="$sha1_src...$sha1_dst"
667 elif test $mod_src = 160000
668 then
669 range=$sha1_src
670 else
671 range=$sha1_dst
672 fi
673 GIT_DIR="$name/.git" \
674 git rev-list --first-parent $range -- | wc -l
675 )
676 total_commits=" ($(($total_commits + 0)))"
677 ;;
678 esac
679 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
681 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
682 if test $status = T
683 then
684 if test $mod_dst = 160000
685 then
686 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
687 else
688 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
689 fi
690 else
691 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
692 fi
693 if test -n "$errmsg"
694 then
695 # Don't give error msg for modification whose dst is not submodule
696 # i.e. deleted or changed to blob
697 test $mod_dst = 160000 && echo "$errmsg"
698 else
699 if test $mod_src = 160000 -a $mod_dst = 160000
700 then
701 limit=
702 test $summary_limit -gt 0 && limit="-$summary_limit"
703 GIT_DIR="$name/.git" \
704 git log $limit --pretty='format: %m %s' \
705 --first-parent $sha1_src...$sha1_dst
706 elif test $mod_dst = 160000
707 then
708 GIT_DIR="$name/.git" \
709 git log --pretty='format: > %s' -1 $sha1_dst
710 else
711 GIT_DIR="$name/.git" \
712 git log --pretty='format: < %s' -1 $sha1_src
713 fi
714 echo
715 fi
716 echo
717 done |
718 if test -n "$for_status"; then
719 if [ -n "$files" ]; then
720 echo "# Submodules changed but not updated:"
721 else
722 echo "# Submodule changes to be committed:"
723 fi
724 echo "#"
725 sed -e 's|^|# |' -e 's|^# $|#|'
726 else
727 cat
728 fi
729}
730#
731# List all submodules, prefixed with:
732# - submodule not initialized
733# + different revision checked out
734#
735# If --cached was specified the revision in the index will be printed
736# instead of the currently checked out revision.
737#
738# $@ = requested paths (default to all)
739#
740cmd_status()
741{
742 # parse $args after "submodule ... status".
743 orig_flags=
744 while test $# -ne 0
745 do
746 case "$1" in
747 -q|--quiet)
748 GIT_QUIET=1
749 ;;
750 --cached)
751 cached=1
752 ;;
753 --recursive)
754 recursive=1
755 ;;
756 --)
757 shift
758 break
759 ;;
760 -*)
761 usage
762 ;;
763 *)
764 break
765 ;;
766 esac
767 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
768 shift
769 done
770 module_list "$@" |
772 while read mode sha1 stage path
773 do
774 name=$(module_name "$path") || exit
775 url=$(git config submodule."$name".url)
776 displaypath="$prefix$path"
777 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
778 then
779 say "-$sha1 $displaypath"
780 continue;
781 fi
782 set_name_rev "$path" "$sha1"
783 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
784 then
785 say " $sha1 $displaypath$revname"
786 else
787 if test -z "$cached"
788 then
789 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
790 set_name_rev "$path" "$sha1"
791 fi
792 say "+$sha1 $displaypath$revname"
793 fi
794 if test -n "$recursive"
796 then
797 (
798 prefix="$displaypath/"
799 clear_local_git_env
800 cd "$path" &&
801 eval cmd_status "$orig_args"
802 ) ||
803 die "Failed to recurse into submodule path '$path'"
804 fi
805 done
806}
807#
808# Sync remote urls for submodules
809# This makes the value for remote.$remote.url match the value
810# specified in .gitmodules.
811#
812cmd_sync()
813{
814 while test $# -ne 0
815 do
816 case "$1" in
817 -q|--quiet)
818 GIT_QUIET=1
819 shift
820 ;;
821 --)
822 shift
823 break
824 ;;
825 -*)
826 usage
827 ;;
828 *)
829 break
830 ;;
831 esac
832 done
833 cd_to_toplevel
834 module_list "$@" |
835 while read mode sha1 stage path
836 do
837 name=$(module_name "$path")
838 url=$(git config -f .gitmodules --get submodule."$name".url)
839 # Possibly a url relative to parent
841 case "$url" in
842 ./*|../*)
843 url=$(resolve_relative_url "$url") || exit
844 ;;
845 esac
846 say "Synchronizing submodule url for '$name'"
848 git config submodule."$name".url "$url"
849 if test -e "$path"/.git
851 then
852 (
853 clear_local_git_env
854 cd "$path"
855 remote=$(get_default_remote)
856 git config remote."$remote".url "$url"
857 )
858 fi
859 done
860}
861# This loop parses the command line arguments to find the
863# subcommand name to dispatch. Parsing of the subcommand specific
864# options are primarily done by the subcommand implementations.
865# Subcommand specific options such as --branch and --cached are
866# parsed here as well, for backward compatibility.
867while test $# != 0 && test -z "$command"
869do
870 case "$1" in
871 add | foreach | init | update | status | summary | sync)
872 command=$1
873 ;;
874 -q|--quiet)
875 GIT_QUIET=1
876 ;;
877 -b|--branch)
878 case "$2" in
879 '')
880 usage
881 ;;
882 esac
883 branch="$2"; shift
884 ;;
885 --cached)
886 cached="$1"
887 ;;
888 --)
889 break
890 ;;
891 -*)
892 usage
893 ;;
894 *)
895 break
896 ;;
897 esac
898 shift
899done
900# No command word defaults to "status"
902test -n "$command" || command=status
903# "-b branch" is accepted only by "add"
905if test -n "$branch" && test "$command" != add
906then
907 usage
908fi
909# "--cached" is accepted only by "status" and "summary"
911if test -n "$cached" && test "$command" != status -a "$command" != summary
912then
913 usage
914fi
915"cmd_$command" "$@"