Merge branch 'maint'
[git/mingw.git] / git-submodule.sh
blob3daa0c834cad1ed402376adf535c73e1c06172e4
1 #!/bin/sh
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>...]"
15 OPTIONS_SPEC=
16 . git-sh-setup
17 . git-sh-i18n
18 . git-parse-remote
19 require_work_tree
21 command=
22 branch=
23 force=
24 reference=
25 cached=
26 recursive=
27 init=
28 files=
29 nofetch=
30 update=
31 prefix=
33 # Resolve relative url by appending to parent's url
34 resolve_relative_url ()
36 remote=$(get_default_remote)
37 remoteurl=$(git config "remote.$remote.url") ||
38 die "$(eval_gettext "remote (\$remote) does not have a url defined in .git/config")"
39 url="$1"
40 remoteurl=${remoteurl%/}
41 sep=/
42 while test -n "$url"
44 case "$url" in
45 ../*)
46 url="${url#../}"
47 case "$remoteurl" in
48 */*)
49 remoteurl="${remoteurl%/*}"
51 *:*)
52 remoteurl="${remoteurl%:*}"
53 sep=:
56 die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
58 esac
60 ./*)
61 url="${url#./}"
64 break;;
65 esac
66 done
67 echo "$remoteurl$sep${url%/}"
71 # Get submodule info for registered submodules
72 # $@ = path to limit submodule list
74 module_list()
76 git ls-files --error-unmatch --stage -- "$@" |
77 perl -e '
78 my %unmerged = ();
79 my ($null_sha1) = ("0" x 40);
80 while (<STDIN>) {
81 chomp;
82 my ($mode, $sha1, $stage, $path) =
83 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
84 next unless $mode eq "160000";
85 if ($stage ne "0") {
86 if (!$unmerged{$path}++) {
87 print "$mode $null_sha1 U\t$path\n";
89 next;
91 print "$_\n";
97 # Map submodule path to submodule name
99 # $1 = path
101 module_name()
103 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
104 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
105 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
106 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
107 test -z "$name" &&
108 die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$path'")"
109 echo "$name"
113 # Clone a submodule
115 # Prior to calling, cmd_update checks that a possibly existing
116 # path is not a git repository.
117 # Likewise, cmd_add checks that path does not exist at all,
118 # since it is the location of a new submodule.
120 module_clone()
122 path=$1
123 url=$2
124 reference="$3"
126 if test -n "$reference"
127 then
128 git-clone "$reference" -n "$url" "$path"
129 else
130 git-clone -n "$url" "$path"
131 fi ||
132 die "$(eval_gettext "Clone of '\$url' into submodule path '\$path' failed")"
136 # Add a new submodule to the working tree, .gitmodules and the index
138 # $@ = repo path
140 # optional branch is stored in global branch variable
142 cmd_add()
144 # parse $args after "submodule ... add".
145 while test $# -ne 0
147 case "$1" in
148 -b | --branch)
149 case "$2" in '') usage ;; esac
150 branch=$2
151 shift
153 -f | --force)
154 force=$1
156 -q|--quiet)
157 GIT_QUIET=1
159 --reference)
160 case "$2" in '') usage ;; esac
161 reference="--reference=$2"
162 shift
164 --reference=*)
165 reference="$1"
166 shift
169 shift
170 break
173 usage
176 break
178 esac
179 shift
180 done
182 repo=$1
183 path=$2
185 if test -z "$path"; then
186 path=$(echo "$repo" |
187 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
190 if test -z "$repo" -o -z "$path"; then
191 usage
194 # assure repo is absolute or relative to parent
195 case "$repo" in
196 ./*|../*)
197 # dereference source url relative to parent's url
198 realrepo=$(resolve_relative_url "$repo") || exit
200 *:*|/*)
201 # absolute url
202 realrepo=$repo
205 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
207 esac
209 # normalize path:
210 # multiple //; leading ./; /./; /../; trailing /
211 path=$(printf '%s/\n' "$path" |
212 sed -e '
213 s|//*|/|g
214 s|^\(\./\)*||
215 s|/\./|/|g
216 :start
217 s|\([^/]*\)/\.\./||
218 tstart
219 s|/*$||
221 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
222 die "$(eval_gettext "'\$path' already exists in the index")"
224 if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
225 then
227 eval_gettext "The following path is ignored by one of your .gitignore files:
228 \$path
229 Use -f if you really want to add it." &&
230 echo
231 ) >&2
232 exit 1
235 # perhaps the path exists and is already a git repo, else clone it
236 if test -e "$path"
237 then
238 if test -d "$path"/.git -o -f "$path"/.git
239 then
240 eval_gettext "Adding existing repo at '\$path' to the index"; echo
241 else
242 die "$(eval_gettext "'\$path' already exists and is not a valid git repo")"
245 case "$repo" in
246 ./*|../*)
247 url=$(resolve_relative_url "$repo") || exit
250 url="$repo"
252 esac
253 else
255 module_clone "$path" "$realrepo" "$reference" || exit
257 clear_local_git_env
258 cd "$path" &&
259 # ash fails to wordsplit ${branch:+-b "$branch"...}
260 case "$branch" in
261 '') git checkout -f -q ;;
262 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
263 esac
264 ) || die "$(eval_gettext "Unable to checkout submodule '\$path'")"
266 git config submodule."$path".url "$url"
268 git add $force "$path" ||
269 die "$(eval_gettext "Failed to add submodule '\$path'")"
271 git config -f .gitmodules submodule."$path".path "$path" &&
272 git config -f .gitmodules submodule."$path".url "$repo" &&
273 git add --force .gitmodules ||
274 die "$(eval_gettext "Failed to register submodule '\$path'")"
278 # Execute an arbitrary command sequence in each checked out
279 # submodule
281 # $@ = command to execute
283 cmd_foreach()
285 # parse $args after "submodule ... foreach".
286 while test $# -ne 0
288 case "$1" in
289 -q|--quiet)
290 GIT_QUIET=1
292 --recursive)
293 recursive=1
296 usage
299 break
301 esac
302 shift
303 done
305 toplevel=$(pwd)
307 # dup stdin so that it can be restored when running the external
308 # command in the subshell (and a recursive call to this function)
309 exec 3<&0
311 module_list |
312 while read mode sha1 stage path
314 if test -e "$path"/.git
315 then
316 say "$(eval_gettext "Entering '\$prefix\$path'")"
317 name=$(module_name "$path")
319 prefix="$prefix$path/"
320 clear_local_git_env
321 cd "$path" &&
322 eval "$@" &&
323 if test -n "$recursive"
324 then
325 cmd_foreach "--recursive" "$@"
327 ) <&3 3<&- ||
328 die "$(eval_gettext "Stopping at '\$path'; script returned non-zero status.")"
330 done
334 # Register submodules in .git/config
336 # $@ = requested paths (default to all)
338 cmd_init()
340 # parse $args after "submodule ... init".
341 while test $# -ne 0
343 case "$1" in
344 -q|--quiet)
345 GIT_QUIET=1
348 shift
349 break
352 usage
355 break
357 esac
358 shift
359 done
361 module_list "$@" |
362 while read mode sha1 stage path
364 # Skip already registered paths
365 name=$(module_name "$path") || exit
366 if test -z "$(git config "submodule.$name.url")"
367 then
368 url=$(git config -f .gitmodules submodule."$name".url)
369 test -z "$url" &&
370 die "$(eval_gettext "No url found for submodule path '\$path' in .gitmodules")"
372 # Possibly a url relative to parent
373 case "$url" in
374 ./*|../*)
375 url=$(resolve_relative_url "$url") || exit
377 esac
378 git config submodule."$name".url "$url" ||
379 die "$(eval_gettext "Failed to register url for submodule path '\$path'")"
382 # Copy "update" setting when it is not set yet
383 upd="$(git config -f .gitmodules submodule."$name".update)"
384 test -z "$upd" ||
385 test -n "$(git config submodule."$name".update)" ||
386 git config submodule."$name".update "$upd" ||
387 die "$(eval_gettext "Failed to register update mode for submodule path '\$path'")"
389 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$path'")"
390 done
394 # Update each submodule path to correct revision, using clone and checkout as needed
396 # $@ = requested paths (default to all)
398 cmd_update()
400 # parse $args after "submodule ... update".
401 orig_flags=
402 while test $# -ne 0
404 case "$1" in
405 -q|--quiet)
406 GIT_QUIET=1
408 -i|--init)
409 init=1
411 -N|--no-fetch)
412 nofetch=1
414 -f|--force)
415 force=$1
417 -r|--rebase)
418 update="rebase"
420 --reference)
421 case "$2" in '') usage ;; esac
422 reference="--reference=$2"
423 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
424 shift
426 --reference=*)
427 reference="$1"
429 -m|--merge)
430 update="merge"
432 --recursive)
433 recursive=1
436 shift
437 break
440 usage
443 break
445 esac
446 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
447 shift
448 done
450 if test -n "$init"
451 then
452 cmd_init "--" "$@" || return
455 cloned_modules=
456 module_list "$@" | {
457 err=
458 while read mode sha1 stage path
460 if test "$stage" = U
461 then
462 echo >&2 "Skipping unmerged submodule $path"
463 continue
465 name=$(module_name "$path") || exit
466 url=$(git config submodule."$name".url)
467 update_module=$(git config submodule."$name".update)
468 if test -z "$url"
469 then
470 # Only mention uninitialized submodules when its
471 # path have been specified
472 test "$#" != "0" &&
473 say "$(eval_gettext "Submodule path '\$path' not initialized
474 Maybe you want to use 'update --init'?")"
475 continue
478 if ! test -d "$path"/.git -o -f "$path"/.git
479 then
480 module_clone "$path" "$url" "$reference"|| exit
481 cloned_modules="$cloned_modules;$name"
482 subsha1=
483 else
484 subsha1=$(clear_local_git_env; cd "$path" &&
485 git rev-parse --verify HEAD) ||
486 die "$(eval_gettext "Unable to find current revision in submodule path '\$path'")"
489 if ! test -z "$update"
490 then
491 update_module=$update
494 if test "$subsha1" != "$sha1"
495 then
496 subforce=$force
497 # If we don't already have a -f flag and the submodule has never been checked out
498 if test -z "$subsha1" -a -z "$force"
499 then
500 subforce="-f"
503 if test -z "$nofetch"
504 then
505 # Run fetch only if $sha1 isn't present or it
506 # is not reachable from a ref.
507 (clear_local_git_env; cd "$path" &&
508 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
509 test -z "$rev") || git-fetch)) ||
510 die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
513 # Is this something we just cloned?
514 case ";$cloned_modules;" in
515 *";$name;"*)
516 # then there is no local change to integrate
517 update_module= ;;
518 esac
520 must_die_on_failure=
521 case "$update_module" in
522 rebase)
523 command="git rebase"
524 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$path'")"
525 say_msg="$(eval_gettext "Submodule path '\$path': rebased into '\$sha1'")"
526 must_die_on_failure=yes
528 merge)
529 command="git merge"
530 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$path'")"
531 say_msg="$(eval_gettext "Submodule path '\$path': merged in '\$sha1'")"
532 must_die_on_failure=yes
535 command="git checkout $subforce -q"
536 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$path'")"
537 say_msg="$(eval_gettext "Submodule path '\$path': checked out '\$sha1'")"
539 esac
541 if (clear_local_git_env; cd "$path" && $command "$sha1")
542 then
543 say "$say_msg"
544 elif test -n "$must_die_on_failure"
545 then
546 die_with_status 2 "$die_msg"
547 else
548 err="${err};$die_msg"
549 continue
553 if test -n "$recursive"
554 then
555 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags")
556 res=$?
557 if test $res -gt 0
558 then
559 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$path'")"
560 if test $res -eq 1
561 then
562 err="${err};$die_msg"
563 continue
564 else
565 die_with_status $res "$die_msg"
569 done
571 if test -n "$err"
572 then
573 OIFS=$IFS
574 IFS=';'
575 for e in $err
577 if test -n "$e"
578 then
579 echo >&2 "$e"
581 done
582 IFS=$OIFS
583 exit 1
588 set_name_rev () {
589 revname=$( (
590 clear_local_git_env
591 cd "$1" && {
592 git describe "$2" 2>/dev/null ||
593 git describe --tags "$2" 2>/dev/null ||
594 git describe --contains "$2" 2>/dev/null ||
595 git describe --all --always "$2"
598 test -z "$revname" || revname=" ($revname)"
601 # Show commit summary for submodules in index or working tree
603 # If '--cached' is given, show summary between index and given commit,
604 # or between working tree and given commit
606 # $@ = [commit (default 'HEAD'),] requested paths (default all)
608 cmd_summary() {
609 summary_limit=-1
610 for_status=
611 diff_cmd=diff-index
613 # parse $args after "submodule ... summary".
614 while test $# -ne 0
616 case "$1" in
617 --cached)
618 cached="$1"
620 --files)
621 files="$1"
623 --for-status)
624 for_status="$1"
626 -n|--summary-limit)
627 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
628 then
630 else
631 usage
633 shift
636 shift
637 break
640 usage
643 break
645 esac
646 shift
647 done
649 test $summary_limit = 0 && return
651 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
652 then
653 head=$rev
654 test $# = 0 || shift
655 elif test -z "$1" -o "$1" = "HEAD"
656 then
657 # before the first commit: compare with an empty tree
658 head=$(git hash-object -w -t tree --stdin </dev/null)
659 test -z "$1" || shift
660 else
661 head="HEAD"
664 if [ -n "$files" ]
665 then
666 test -n "$cached" &&
667 die "$(gettext -- "--cached cannot be used with --files")"
668 diff_cmd=diff-files
669 head=
672 cd_to_toplevel
673 # Get modified modules cared by user
674 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
675 sane_egrep '^:([0-7]* )?160000' |
676 while read mod_src mod_dst sha1_src sha1_dst status name
678 # Always show modules deleted or type-changed (blob<->module)
679 test $status = D -o $status = T && echo "$name" && continue
680 # Also show added or modified modules which are checked out
681 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
682 echo "$name"
683 done
686 test -z "$modules" && return
688 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
689 sane_egrep '^:([0-7]* )?160000' |
690 cut -c2- |
691 while read mod_src mod_dst sha1_src sha1_dst status name
693 if test -z "$cached" &&
694 test $sha1_dst = 0000000000000000000000000000000000000000
695 then
696 case "$mod_dst" in
697 160000)
698 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
700 100644 | 100755 | 120000)
701 sha1_dst=$(git hash-object $name)
703 000000)
704 ;; # removed
706 # unexpected type
708 eval_gettext "unexpected mode \$mod_dst" &&
709 echo
710 ) >&2
711 continue ;;
712 esac
714 missing_src=
715 missing_dst=
717 test $mod_src = 160000 &&
718 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
719 missing_src=t
721 test $mod_dst = 160000 &&
722 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
723 missing_dst=t
725 total_commits=
726 case "$missing_src,$missing_dst" in
728 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_src")"
731 errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_dst")"
733 t,t)
734 errmsg="$(eval_gettext " Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
737 errmsg=
738 total_commits=$(
739 if test $mod_src = 160000 -a $mod_dst = 160000
740 then
741 range="$sha1_src...$sha1_dst"
742 elif test $mod_src = 160000
743 then
744 range=$sha1_src
745 else
746 range=$sha1_dst
748 GIT_DIR="$name/.git" \
749 git rev-list --first-parent $range -- | wc -l
751 total_commits=" ($(($total_commits + 0)))"
753 esac
755 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
756 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
757 if test $status = T
758 then
759 blob="$(gettext "blob")"
760 submodule="$(gettext "submodule")"
761 if test $mod_dst = 160000
762 then
763 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
764 else
765 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
767 else
768 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
770 if test -n "$errmsg"
771 then
772 # Don't give error msg for modification whose dst is not submodule
773 # i.e. deleted or changed to blob
774 test $mod_dst = 160000 && echo "$errmsg"
775 else
776 if test $mod_src = 160000 -a $mod_dst = 160000
777 then
778 limit=
779 test $summary_limit -gt 0 && limit="-$summary_limit"
780 GIT_DIR="$name/.git" \
781 git log $limit --pretty='format: %m %s' \
782 --first-parent $sha1_src...$sha1_dst
783 elif test $mod_dst = 160000
784 then
785 GIT_DIR="$name/.git" \
786 git log --pretty='format: > %s' -1 $sha1_dst
787 else
788 GIT_DIR="$name/.git" \
789 git log --pretty='format: < %s' -1 $sha1_src
791 echo
793 echo
794 done |
795 if test -n "$for_status"; then
796 if [ -n "$files" ]; then
797 gettext "# Submodules changed but not updated:"; echo
798 else
799 gettext "# Submodule changes to be committed:"; echo
801 echo "#"
802 sed -e 's|^|# |' -e 's|^# $|#|'
803 else
808 # List all submodules, prefixed with:
809 # - submodule not initialized
810 # + different revision checked out
812 # If --cached was specified the revision in the index will be printed
813 # instead of the currently checked out revision.
815 # $@ = requested paths (default to all)
817 cmd_status()
819 # parse $args after "submodule ... status".
820 orig_flags=
821 while test $# -ne 0
823 case "$1" in
824 -q|--quiet)
825 GIT_QUIET=1
827 --cached)
828 cached=1
830 --recursive)
831 recursive=1
834 shift
835 break
838 usage
841 break
843 esac
844 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
845 shift
846 done
848 module_list "$@" |
849 while read mode sha1 stage path
851 name=$(module_name "$path") || exit
852 url=$(git config submodule."$name".url)
853 displaypath="$prefix$path"
854 if test "$stage" = U
855 then
856 say "U$sha1 $displaypath"
857 continue
859 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
860 then
861 say "-$sha1 $displaypath"
862 continue;
864 set_name_rev "$path" "$sha1"
865 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
866 then
867 say " $sha1 $displaypath$revname"
868 else
869 if test -z "$cached"
870 then
871 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
872 set_name_rev "$path" "$sha1"
874 say "+$sha1 $displaypath$revname"
877 if test -n "$recursive"
878 then
880 prefix="$displaypath/"
881 clear_local_git_env
882 cd "$path" &&
883 eval cmd_status "$orig_args"
884 ) ||
885 die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
887 done
890 # Sync remote urls for submodules
891 # This makes the value for remote.$remote.url match the value
892 # specified in .gitmodules.
894 cmd_sync()
896 while test $# -ne 0
898 case "$1" in
899 -q|--quiet)
900 GIT_QUIET=1
901 shift
904 shift
905 break
908 usage
911 break
913 esac
914 done
915 cd_to_toplevel
916 module_list "$@" |
917 while read mode sha1 stage path
919 name=$(module_name "$path")
920 url=$(git config -f .gitmodules --get submodule."$name".url)
922 # Possibly a url relative to parent
923 case "$url" in
924 ./*|../*)
925 url=$(resolve_relative_url "$url") || exit
927 esac
929 if git config "submodule.$name.url" >/dev/null 2>/dev/null
930 then
931 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
932 git config submodule."$name".url "$url"
934 if test -e "$path"/.git
935 then
937 clear_local_git_env
938 cd "$path"
939 remote=$(get_default_remote)
940 git config remote."$remote".url "$url"
944 done
947 # This loop parses the command line arguments to find the
948 # subcommand name to dispatch. Parsing of the subcommand specific
949 # options are primarily done by the subcommand implementations.
950 # Subcommand specific options such as --branch and --cached are
951 # parsed here as well, for backward compatibility.
953 while test $# != 0 && test -z "$command"
955 case "$1" in
956 add | foreach | init | update | status | summary | sync)
957 command=$1
959 -q|--quiet)
960 GIT_QUIET=1
962 -b|--branch)
963 case "$2" in
965 usage
967 esac
968 branch="$2"; shift
970 --cached)
971 cached="$1"
974 break
977 usage
980 break
982 esac
983 shift
984 done
986 # No command word defaults to "status"
987 test -n "$command" || command=status
989 # "-b branch" is accepted only by "add"
990 if test -n "$branch" && test "$command" != add
991 then
992 usage
995 # "--cached" is accepted only by "status" and "summary"
996 if test -n "$cached" && test "$command" != status -a "$command" != summary
997 then
998 usage
1001 "cmd_$command" "$@"