mingw: do not hide bare repositories
[git/dscho.git] / git-submodule.sh
blobc16e2759af5f429accc4ed38340ce599472e2792
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] [--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-parse-remote
18 require_work_tree
20 command=
21 branch=
22 force=
23 reference=
24 cached=
25 recursive=
26 init=
27 files=
28 nofetch=
29 update=
30 prefix=
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"
38 url="$1"
39 remoteurl=${remoteurl%/}
40 sep=/
41 while test -n "$url"
43 case "$url" in
44 ../*)
45 url="${url#../}"
46 case "$remoteurl" in
47 */*)
48 remoteurl="${remoteurl%/*}"
50 *:*)
51 remoteurl="${remoteurl%:*}"
52 sep=:
55 die "cannot strip one component off url '$remoteurl'"
57 esac
59 ./*)
60 url="${url#./}"
63 break;;
64 esac
65 done
66 echo "$remoteurl$sep${url%/}"
70 # Get submodule info for registered submodules
71 # $@ = path to limit submodule list
73 module_list()
75 git ls-files --error-unmatch --stage -- "$@" | sane_grep '^160000 '
79 # Map submodule path to submodule name
81 # $1 = path
83 module_name()
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"
95 # Clone a submodule
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.
102 module_clone()
104 path=$1
105 url=$2
106 reference="$3"
108 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"
118 # Add a new submodule to the working tree, .gitmodules and the index
120 # $@ = repo path
122 # optional branch is stored in global branch variable
124 cmd_add()
126 # parse $args after "submodule ... add".
127 while test $# -ne 0
129 case "$1" in
130 -b | --branch)
131 case "$2" in '') usage ;; esac
132 branch=$2
133 shift
135 -f | --force)
136 force=$1
138 -q|--quiet)
139 GIT_QUIET=1
141 --reference)
142 case "$2" in '') usage ;; esac
143 reference="--reference=$2"
144 shift
146 --reference=*)
147 reference="$1"
148 shift
151 shift
152 break
155 usage
158 break
160 esac
161 shift
162 done
164 repo=$1
165 path=$2
167 if test -z "$path"; then
168 path=$(echo "$repo" |
169 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
172 if test -z "$repo" -o -z "$path"; then
173 usage
176 # 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
182 *:*|/*)
183 # absolute url
184 realrepo=$repo
187 die "repo URL: '$repo' must be absolute or begin with ./|../"
189 esac
191 # 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|/*$||
203 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
204 die "'$path' already exists in the index"
206 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
214 # 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"
224 case "$repo" in
225 ./*|../*)
226 url=$(resolve_relative_url "$repo") || exit
229 url="$repo"
231 esac
232 git config submodule."$path".url "$url"
233 else
235 module_clone "$path" "$realrepo" "$reference" || exit
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'"
247 git add $force "$path" ||
248 die "Failed to add submodule '$path'"
250 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'"
257 # Execute an arbitrary command sequence in each checked out
258 # submodule
260 # $@ = command to execute
262 cmd_foreach()
264 # parse $args after "submodule ... foreach".
265 while test $# -ne 0
267 case "$1" in
268 -q|--quiet)
269 GIT_QUIET=1
271 --recursive)
272 recursive=1
275 usage
278 break
280 esac
281 shift
282 done
284 toplevel=$(pwd)
286 module_list |
287 while read mode sha1 stage path
289 if test -e "$path"/.git
290 then
291 say "Entering '$prefix$path'"
292 name=$(module_name "$path")
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" "$@"
302 ) ||
303 die "Stopping at '$path'; script returned non-zero status."
305 done
309 # Register submodules in .git/config
311 # $@ = requested paths (default to all)
313 cmd_init()
315 # parse $args after "submodule ... init".
316 while test $# -ne 0
318 case "$1" in
319 -q|--quiet)
320 GIT_QUIET=1
323 shift
324 break
327 usage
330 break
332 esac
333 shift
334 done
336 module_list "$@" |
337 while read mode sha1 stage path
339 # Skip already registered paths
340 name=$(module_name "$path") || exit
341 url=$(git config submodule."$name".url)
342 test -z "$url" || continue
344 url=$(git config -f .gitmodules submodule."$name".url)
345 test -z "$url" &&
346 die "No url found for submodule path '$path' in .gitmodules"
348 # Possibly a url relative to parent
349 case "$url" in
350 ./*|../*)
351 url=$(resolve_relative_url "$url") || exit
353 esac
355 git config submodule."$name".url "$url" ||
356 die "Failed to register url for submodule path '$path'"
358 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'"
363 say "Submodule '$name' ($url) registered for path '$path'"
364 done
368 # Update each submodule path to correct revision, using clone and checkout as needed
370 # $@ = requested paths (default to all)
372 cmd_update()
374 # parse $args after "submodule ... update".
375 orig_flags=
376 while test $# -ne 0
378 case "$1" in
379 -q|--quiet)
380 GIT_QUIET=1
382 -i|--init)
383 init=1
385 -N|--no-fetch)
386 nofetch=1
388 -r|--rebase)
389 update="rebase"
391 --reference)
392 case "$2" in '') usage ;; esac
393 reference="--reference=$2"
394 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
395 shift
397 --reference=*)
398 reference="$1"
400 -m|--merge)
401 update="merge"
403 --recursive)
404 recursive=1
407 shift
408 break
411 usage
414 break
416 esac
417 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
418 shift
419 done
421 if test -n "$init"
422 then
423 cmd_init "--" "$@" || return
426 cloned_modules=
427 module_list "$@" |
428 while read mode sha1 stage path
430 name=$(module_name "$path") || exit
431 url=$(git config submodule."$name".url)
432 update_module=$(git config submodule."$name".update)
433 if test -z "$url"
434 then
435 # Only mention uninitialized submodules when its
436 # path have been specified
437 test "$#" != "0" &&
438 say "Submodule path '$path' not initialized" &&
439 say "Maybe you want to use 'update --init'?"
440 continue
443 if ! test -d "$path"/.git -o -f "$path"/.git
444 then
445 module_clone "$path" "$url" "$reference"|| exit
446 cloned_modules="$cloned_modules;$name"
447 subsha1=
448 else
449 subsha1=$(clear_local_git_env; cd "$path" &&
450 git rev-parse --verify HEAD) ||
451 die "Unable to find current revision in submodule path '$path'"
454 if ! test -z "$update"
455 then
456 update_module=$update
459 if test "$subsha1" != "$sha1"
460 then
461 force=
462 if test -z "$subsha1"
463 then
464 force="-f"
467 if test -z "$nofetch"
468 then
469 # Run fetch only if $sha1 isn't present or it
470 # is not reachable from a ref.
471 (clear_local_git_env; cd "$path" &&
472 ((rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
473 test -z "$rev") || git-fetch)) ||
474 die "Unable to fetch in submodule path '$path'"
477 # Is this something we just cloned?
478 case ";$cloned_modules;" in
479 *";$name;"*)
480 # then there is no local change to integrate
481 update_module= ;;
482 esac
484 case "$update_module" in
485 rebase)
486 command="git rebase"
487 action="rebase"
488 msg="rebased onto"
490 merge)
491 command="git merge"
492 action="merge"
493 msg="merged in"
496 command="git checkout $force -q"
497 action="checkout"
498 msg="checked out"
500 esac
502 (clear_local_git_env; cd "$path" && $command "$sha1") ||
503 die "Unable to $action '$sha1' in submodule path '$path'"
504 say "Submodule path '$path': $msg '$sha1'"
507 if test -n "$recursive"
508 then
509 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") ||
510 die "Failed to recurse into submodule path '$path'"
512 done
515 set_name_rev () {
516 revname=$( (
517 clear_local_git_env
518 cd "$1" && {
519 git describe "$2" 2>/dev/null ||
520 git describe --tags "$2" 2>/dev/null ||
521 git describe --contains "$2" 2>/dev/null ||
522 git describe --all --always "$2"
525 test -z "$revname" || revname=" ($revname)"
528 # Show commit summary for submodules in index or working tree
530 # If '--cached' is given, show summary between index and given commit,
531 # or between working tree and given commit
533 # $@ = [commit (default 'HEAD'),] requested paths (default all)
535 cmd_summary() {
536 summary_limit=-1
537 for_status=
538 diff_cmd=diff-index
540 # parse $args after "submodule ... summary".
541 while test $# -ne 0
543 case "$1" in
544 --cached)
545 cached="$1"
547 --files)
548 files="$1"
550 --for-status)
551 for_status="$1"
553 -n|--summary-limit)
554 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
555 then
557 else
558 usage
560 shift
563 shift
564 break
567 usage
570 break
572 esac
573 shift
574 done
576 test $summary_limit = 0 && return
578 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
579 then
580 head=$rev
581 test $# = 0 || shift
582 elif test -z "$1" -o "$1" = "HEAD"
583 then
584 # before the first commit: compare with an empty tree
585 head=$(git hash-object -w -t tree --stdin </dev/null)
586 test -z "$1" || shift
587 else
588 head="HEAD"
591 if [ -n "$files" ]
592 then
593 test -n "$cached" &&
594 die "--cached cannot be used with --files"
595 diff_cmd=diff-files
596 head=
599 cd_to_toplevel
600 # Get modified modules cared by user
601 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
602 sane_egrep '^:([0-7]* )?160000' |
603 while read mod_src mod_dst sha1_src sha1_dst status name
605 # Always show modules deleted or type-changed (blob<->module)
606 test $status = D -o $status = T && echo "$name" && continue
607 # Also show added or modified modules which are checked out
608 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
609 echo "$name"
610 done
613 test -z "$modules" && return
615 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
616 sane_egrep '^:([0-7]* )?160000' |
617 cut -c2- |
618 while read mod_src mod_dst sha1_src sha1_dst status name
620 if test -z "$cached" &&
621 test $sha1_dst = 0000000000000000000000000000000000000000
622 then
623 case "$mod_dst" in
624 160000)
625 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
627 100644 | 100755 | 120000)
628 sha1_dst=$(git hash-object $name)
630 000000)
631 ;; # removed
633 # unexpected type
634 echo >&2 "unexpected mode $mod_dst"
635 continue ;;
636 esac
638 missing_src=
639 missing_dst=
641 test $mod_src = 160000 &&
642 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
643 missing_src=t
645 test $mod_dst = 160000 &&
646 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
647 missing_dst=t
649 total_commits=
650 case "$missing_src,$missing_dst" in
652 errmsg=" Warn: $name doesn't contain commit $sha1_src"
655 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
657 t,t)
658 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
661 errmsg=
662 total_commits=$(
663 if test $mod_src = 160000 -a $mod_dst = 160000
664 then
665 range="$sha1_src...$sha1_dst"
666 elif test $mod_src = 160000
667 then
668 range=$sha1_src
669 else
670 range=$sha1_dst
672 GIT_DIR="$name/.git" \
673 git rev-list --first-parent $range -- | wc -l
675 total_commits=" ($(($total_commits + 0)))"
677 esac
679 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
680 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
681 if test $status = T
682 then
683 if test $mod_dst = 160000
684 then
685 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
686 else
687 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
689 else
690 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
692 if test -n "$errmsg"
693 then
694 # Don't give error msg for modification whose dst is not submodule
695 # i.e. deleted or changed to blob
696 test $mod_dst = 160000 && echo "$errmsg"
697 else
698 if test $mod_src = 160000 -a $mod_dst = 160000
699 then
700 limit=
701 test $summary_limit -gt 0 && limit="-$summary_limit"
702 GIT_DIR="$name/.git" \
703 git log $limit --pretty='format: %m %s' \
704 --first-parent $sha1_src...$sha1_dst
705 elif test $mod_dst = 160000
706 then
707 GIT_DIR="$name/.git" \
708 git log --pretty='format: > %s' -1 $sha1_dst
709 else
710 GIT_DIR="$name/.git" \
711 git log --pretty='format: < %s' -1 $sha1_src
713 echo
715 echo
716 done |
717 if test -n "$for_status"; then
718 if [ -n "$files" ]; then
719 echo "# Submodules changed but not updated:"
720 else
721 echo "# Submodule changes to be committed:"
723 echo "#"
724 sed -e 's|^|# |' -e 's|^# $|#|'
725 else
730 # List all submodules, prefixed with:
731 # - submodule not initialized
732 # + different revision checked out
734 # If --cached was specified the revision in the index will be printed
735 # instead of the currently checked out revision.
737 # $@ = requested paths (default to all)
739 cmd_status()
741 # parse $args after "submodule ... status".
742 orig_flags=
743 while test $# -ne 0
745 case "$1" in
746 -q|--quiet)
747 GIT_QUIET=1
749 --cached)
750 cached=1
752 --recursive)
753 recursive=1
756 shift
757 break
760 usage
763 break
765 esac
766 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
767 shift
768 done
770 module_list "$@" |
771 while read mode sha1 stage path
773 name=$(module_name "$path") || exit
774 url=$(git config submodule."$name".url)
775 displaypath="$prefix$path"
776 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
777 then
778 say "-$sha1 $displaypath"
779 continue;
781 set_name_rev "$path" "$sha1"
782 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
783 then
784 say " $sha1 $displaypath$revname"
785 else
786 if test -z "$cached"
787 then
788 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
789 set_name_rev "$path" "$sha1"
791 say "+$sha1 $displaypath$revname"
794 if test -n "$recursive"
795 then
797 prefix="$displaypath/"
798 clear_local_git_env
799 cd "$path" &&
800 eval cmd_status "$orig_args"
801 ) ||
802 die "Failed to recurse into submodule path '$path'"
804 done
807 # Sync remote urls for submodules
808 # This makes the value for remote.$remote.url match the value
809 # specified in .gitmodules.
811 cmd_sync()
813 while test $# -ne 0
815 case "$1" in
816 -q|--quiet)
817 GIT_QUIET=1
818 shift
821 shift
822 break
825 usage
828 break
830 esac
831 done
832 cd_to_toplevel
833 module_list "$@" |
834 while read mode sha1 stage path
836 name=$(module_name "$path")
837 url=$(git config -f .gitmodules --get submodule."$name".url)
839 # Possibly a url relative to parent
840 case "$url" in
841 ./*|../*)
842 url=$(resolve_relative_url "$url") || exit
844 esac
846 say "Synchronizing submodule url for '$name'"
847 git config submodule."$name".url "$url"
849 if test -e "$path"/.git
850 then
852 clear_local_git_env
853 cd "$path"
854 remote=$(get_default_remote)
855 git config remote."$remote".url "$url"
858 done
861 # This loop parses the command line arguments to find the
862 # subcommand name to dispatch. Parsing of the subcommand specific
863 # options are primarily done by the subcommand implementations.
864 # Subcommand specific options such as --branch and --cached are
865 # parsed here as well, for backward compatibility.
867 while test $# != 0 && test -z "$command"
869 case "$1" in
870 add | foreach | init | update | status | summary | sync)
871 command=$1
873 -q|--quiet)
874 GIT_QUIET=1
876 -b|--branch)
877 case "$2" in
879 usage
881 esac
882 branch="$2"; shift
884 --cached)
885 cached="$1"
888 break
891 usage
894 break
896 esac
897 shift
898 done
900 # No command word defaults to "status"
901 test -n "$command" || command=status
903 # "-b branch" is accepted only by "add"
904 if test -n "$branch" && test "$command" != add
905 then
906 usage
909 # "--cached" is accepted only by "status" and "summary"
910 if test -n "$cached" && test "$command" != status -a "$command" != summary
911 then
912 usage
915 "cmd_$command" "$@"