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