config: Give error message when not changing a multivar
[git/dscho.git] / git-submodule.sh
blobbf110e9cb77a0e9930c427408e18d323db2c8916
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-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 -- "$@" |
76 perl -e '
77 my %unmerged = ();
78 my ($null_sha1) = ("0" x 40);
79 while (<STDIN>) {
80 chomp;
81 my ($mode, $sha1, $stage, $path) =
82 /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
83 next unless $mode eq "160000";
84 if ($stage ne "0") {
85 if (!$unmerged{$path}++) {
86 print "$mode $null_sha1 U\t$path\n";
88 next;
90 print "$_\n";
96 # Map submodule path to submodule name
98 # $1 = path
100 module_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' )
106 test -z "$name" &&
107 die "No submodule mapping found in .gitmodules for path '$path'"
108 echo "$name"
112 # Clone a submodule
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.
119 module_clone()
121 path=$1
122 url=$2
123 reference="$3"
125 if test -n "$reference"
126 then
127 git-clone "$reference" -n "$url" "$path"
128 else
129 git-clone -n "$url" "$path"
130 fi ||
131 die "Clone of '$url' into submodule path '$path' failed"
135 # Add a new submodule to the working tree, .gitmodules and the index
137 # $@ = repo path
139 # optional branch is stored in global branch variable
141 cmd_add()
143 # parse $args after "submodule ... add".
144 while test $# -ne 0
146 case "$1" in
147 -b | --branch)
148 case "$2" in '') usage ;; esac
149 branch=$2
150 shift
152 -f | --force)
153 force=$1
155 -q|--quiet)
156 GIT_QUIET=1
158 --reference)
159 case "$2" in '') usage ;; esac
160 reference="--reference=$2"
161 shift
163 --reference=*)
164 reference="$1"
165 shift
168 shift
169 break
172 usage
175 break
177 esac
178 shift
179 done
181 repo=$1
182 path=$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
190 usage
193 # assure repo is absolute or relative to parent
194 case "$repo" in
195 ./*|../*)
196 # dereference source url relative to parent's url
197 realrepo=$(resolve_relative_url "$repo") || exit
199 *:*|/*)
200 # absolute url
201 realrepo=$repo
204 die "repo URL: '$repo' must be absolute or begin with ./|../"
206 esac
208 # normalize path:
209 # multiple //; leading ./; /./; /../; trailing /
210 path=$(printf '%s/\n' "$path" |
211 sed -e '
212 s|//*|/|g
213 s|^\(\./\)*||
214 s|/\./|/|g
215 :start
216 s|\([^/]*\)/\.\./||
217 tstart
218 s|/*$||
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
224 then
225 echo >&2 "The following path is ignored by one of your .gitignore files:" &&
226 echo >&2 $path &&
227 echo >&2 "Use -f if you really want to add it."
228 exit 1
231 # perhaps the path exists and is already a git repo, else clone it
232 if test -e "$path"
233 then
234 if test -d "$path"/.git -o -f "$path"/.git
235 then
236 echo "Adding existing repo at '$path' to the index"
237 else
238 die "'$path' already exists and is not a valid git repo"
241 case "$repo" in
242 ./*|../*)
243 url=$(resolve_relative_url "$repo") || exit
246 url="$repo"
248 esac
249 git config submodule."$path".url "$url"
250 else
252 module_clone "$path" "$realrepo" "$reference" || exit
254 clear_local_git_env
255 cd "$path" &&
256 # ash fails to wordsplit ${branch:+-b "$branch"...}
257 case "$branch" in
258 '') git checkout -f -q ;;
259 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
260 esac
261 ) || die "Unable to checkout submodule '$path'"
264 git add $force "$path" ||
265 die "Failed to add submodule '$path'"
267 git config -f .gitmodules submodule."$path".path "$path" &&
268 git config -f .gitmodules submodule."$path".url "$repo" &&
269 git add --force .gitmodules ||
270 die "Failed to register submodule '$path'"
274 # Execute an arbitrary command sequence in each checked out
275 # submodule
277 # $@ = command to execute
279 cmd_foreach()
281 # parse $args after "submodule ... foreach".
282 while test $# -ne 0
284 case "$1" in
285 -q|--quiet)
286 GIT_QUIET=1
288 --recursive)
289 recursive=1
292 usage
295 break
297 esac
298 shift
299 done
301 toplevel=$(pwd)
303 module_list |
304 while read mode sha1 stage path
306 if test -e "$path"/.git
307 then
308 say "Entering '$prefix$path'"
309 name=$(module_name "$path")
311 prefix="$prefix$path/"
312 clear_local_git_env
313 cd "$path" &&
314 eval "$@" &&
315 if test -n "$recursive"
316 then
317 cmd_foreach "--recursive" "$@"
319 ) ||
320 die "Stopping at '$path'; script returned non-zero status."
322 done
326 # Register submodules in .git/config
328 # $@ = requested paths (default to all)
330 cmd_init()
332 # parse $args after "submodule ... init".
333 while test $# -ne 0
335 case "$1" in
336 -q|--quiet)
337 GIT_QUIET=1
340 shift
341 break
344 usage
347 break
349 esac
350 shift
351 done
353 module_list "$@" |
354 while read mode sha1 stage path
356 # Skip already registered paths
357 name=$(module_name "$path") || exit
358 url=$(git config submodule."$name".url)
359 test -z "$url" || continue
361 url=$(git config -f .gitmodules submodule."$name".url)
362 test -z "$url" &&
363 die "No url found for submodule path '$path' in .gitmodules"
365 # Possibly a url relative to parent
366 case "$url" in
367 ./*|../*)
368 url=$(resolve_relative_url "$url") || exit
370 esac
372 git config submodule."$name".url "$url" ||
373 die "Failed to register url for submodule path '$path'"
375 upd="$(git config -f .gitmodules submodule."$name".update)"
376 test -z "$upd" ||
377 git config submodule."$name".update "$upd" ||
378 die "Failed to register update mode for submodule path '$path'"
380 say "Submodule '$name' ($url) registered for path '$path'"
381 done
385 # Update each submodule path to correct revision, using clone and checkout as needed
387 # $@ = requested paths (default to all)
389 cmd_update()
391 # parse $args after "submodule ... update".
392 orig_flags=
393 while test $# -ne 0
395 case "$1" in
396 -q|--quiet)
397 GIT_QUIET=1
399 -i|--init)
400 init=1
402 -N|--no-fetch)
403 nofetch=1
405 -f|--force)
406 force=$1
408 -r|--rebase)
409 update="rebase"
411 --reference)
412 case "$2" in '') usage ;; esac
413 reference="--reference=$2"
414 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
415 shift
417 --reference=*)
418 reference="$1"
420 -m|--merge)
421 update="merge"
423 --recursive)
424 recursive=1
427 shift
428 break
431 usage
434 break
436 esac
437 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
438 shift
439 done
441 if test -n "$init"
442 then
443 cmd_init "--" "$@" || return
446 cloned_modules=
447 module_list "$@" |
448 while read mode sha1 stage path
450 if test "$stage" = U
451 then
452 echo >&2 "Skipping unmerged submodule $path"
453 continue
455 name=$(module_name "$path") || exit
456 url=$(git config submodule."$name".url)
457 update_module=$(git config submodule."$name".update)
458 if test -z "$url"
459 then
460 # Only mention uninitialized submodules when its
461 # path have been specified
462 test "$#" != "0" &&
463 say "Submodule path '$path' not initialized" &&
464 say "Maybe you want to use 'update --init'?"
465 continue
468 if ! test -d "$path"/.git -o -f "$path"/.git
469 then
470 module_clone "$path" "$url" "$reference"|| exit
471 cloned_modules="$cloned_modules;$name"
472 subsha1=
473 else
474 subsha1=$(clear_local_git_env; cd "$path" &&
475 git rev-parse --verify HEAD) ||
476 die "Unable to find current revision in submodule path '$path'"
479 if ! test -z "$update"
480 then
481 update_module=$update
484 if test "$subsha1" != "$sha1"
485 then
486 subforce=$force
487 # If we don't already have a -f flag and the submodule has never been checked out
488 if test -z "$subsha1" -a -z "$force"
489 then
490 subforce="-f"
493 if test -z "$nofetch"
494 then
495 # Run fetch only if $sha1 isn't present or it
496 # is not reachable from a ref.
497 (clear_local_git_env; cd "$path" &&
498 ((rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
499 test -z "$rev") || git-fetch)) ||
500 die "Unable to fetch in submodule path '$path'"
503 # Is this something we just cloned?
504 case ";$cloned_modules;" in
505 *";$name;"*)
506 # then there is no local change to integrate
507 update_module= ;;
508 esac
510 case "$update_module" in
511 rebase)
512 command="git rebase"
513 action="rebase"
514 msg="rebased onto"
516 merge)
517 command="git merge"
518 action="merge"
519 msg="merged in"
522 command="git checkout $subforce -q"
523 action="checkout"
524 msg="checked out"
526 esac
528 (clear_local_git_env; cd "$path" && $command "$sha1") ||
529 die "Unable to $action '$sha1' in submodule path '$path'"
530 say "Submodule path '$path': $msg '$sha1'"
533 if test -n "$recursive"
534 then
535 (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") ||
536 die "Failed to recurse into submodule path '$path'"
538 done
541 set_name_rev () {
542 revname=$( (
543 clear_local_git_env
544 cd "$1" && {
545 git describe "$2" 2>/dev/null ||
546 git describe --tags "$2" 2>/dev/null ||
547 git describe --contains "$2" 2>/dev/null ||
548 git describe --all --always "$2"
551 test -z "$revname" || revname=" ($revname)"
554 # Show commit summary for submodules in index or working tree
556 # If '--cached' is given, show summary between index and given commit,
557 # or between working tree and given commit
559 # $@ = [commit (default 'HEAD'),] requested paths (default all)
561 cmd_summary() {
562 summary_limit=-1
563 for_status=
564 diff_cmd=diff-index
566 # parse $args after "submodule ... summary".
567 while test $# -ne 0
569 case "$1" in
570 --cached)
571 cached="$1"
573 --files)
574 files="$1"
576 --for-status)
577 for_status="$1"
579 -n|--summary-limit)
580 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
581 then
583 else
584 usage
586 shift
589 shift
590 break
593 usage
596 break
598 esac
599 shift
600 done
602 test $summary_limit = 0 && return
604 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
605 then
606 head=$rev
607 test $# = 0 || shift
608 elif test -z "$1" -o "$1" = "HEAD"
609 then
610 # before the first commit: compare with an empty tree
611 head=$(git hash-object -w -t tree --stdin </dev/null)
612 test -z "$1" || shift
613 else
614 head="HEAD"
617 if [ -n "$files" ]
618 then
619 test -n "$cached" &&
620 die "--cached cannot be used with --files"
621 diff_cmd=diff-files
622 head=
625 cd_to_toplevel
626 # Get modified modules cared by user
627 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
628 sane_egrep '^:([0-7]* )?160000' |
629 while read mod_src mod_dst sha1_src sha1_dst status name
631 # Always show modules deleted or type-changed (blob<->module)
632 test $status = D -o $status = T && echo "$name" && continue
633 # Also show added or modified modules which are checked out
634 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
635 echo "$name"
636 done
639 test -z "$modules" && return
641 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
642 sane_egrep '^:([0-7]* )?160000' |
643 cut -c2- |
644 while read mod_src mod_dst sha1_src sha1_dst status name
646 if test -z "$cached" &&
647 test $sha1_dst = 0000000000000000000000000000000000000000
648 then
649 case "$mod_dst" in
650 160000)
651 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
653 100644 | 100755 | 120000)
654 sha1_dst=$(git hash-object $name)
656 000000)
657 ;; # removed
659 # unexpected type
660 echo >&2 "unexpected mode $mod_dst"
661 continue ;;
662 esac
664 missing_src=
665 missing_dst=
667 test $mod_src = 160000 &&
668 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
669 missing_src=t
671 test $mod_dst = 160000 &&
672 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
673 missing_dst=t
675 total_commits=
676 case "$missing_src,$missing_dst" in
678 errmsg=" Warn: $name doesn't contain commit $sha1_src"
681 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
683 t,t)
684 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
687 errmsg=
688 total_commits=$(
689 if test $mod_src = 160000 -a $mod_dst = 160000
690 then
691 range="$sha1_src...$sha1_dst"
692 elif test $mod_src = 160000
693 then
694 range=$sha1_src
695 else
696 range=$sha1_dst
698 GIT_DIR="$name/.git" \
699 git rev-list --first-parent $range -- | wc -l
701 total_commits=" ($(($total_commits + 0)))"
703 esac
705 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
706 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
707 if test $status = T
708 then
709 if test $mod_dst = 160000
710 then
711 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
712 else
713 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
715 else
716 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
718 if test -n "$errmsg"
719 then
720 # Don't give error msg for modification whose dst is not submodule
721 # i.e. deleted or changed to blob
722 test $mod_dst = 160000 && echo "$errmsg"
723 else
724 if test $mod_src = 160000 -a $mod_dst = 160000
725 then
726 limit=
727 test $summary_limit -gt 0 && limit="-$summary_limit"
728 GIT_DIR="$name/.git" \
729 git log $limit --pretty='format: %m %s' \
730 --first-parent $sha1_src...$sha1_dst
731 elif test $mod_dst = 160000
732 then
733 GIT_DIR="$name/.git" \
734 git log --pretty='format: > %s' -1 $sha1_dst
735 else
736 GIT_DIR="$name/.git" \
737 git log --pretty='format: < %s' -1 $sha1_src
739 echo
741 echo
742 done |
743 if test -n "$for_status"; then
744 if [ -n "$files" ]; then
745 echo "# Submodules changed but not updated:"
746 else
747 echo "# Submodule changes to be committed:"
749 echo "#"
750 sed -e 's|^|# |' -e 's|^# $|#|'
751 else
756 # List all submodules, prefixed with:
757 # - submodule not initialized
758 # + different revision checked out
760 # If --cached was specified the revision in the index will be printed
761 # instead of the currently checked out revision.
763 # $@ = requested paths (default to all)
765 cmd_status()
767 # parse $args after "submodule ... status".
768 orig_flags=
769 while test $# -ne 0
771 case "$1" in
772 -q|--quiet)
773 GIT_QUIET=1
775 --cached)
776 cached=1
778 --recursive)
779 recursive=1
782 shift
783 break
786 usage
789 break
791 esac
792 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
793 shift
794 done
796 module_list "$@" |
797 while read mode sha1 stage path
799 name=$(module_name "$path") || exit
800 url=$(git config submodule."$name".url)
801 displaypath="$prefix$path"
802 if test "$stage" = U
803 then
804 say "U$sha1 $displaypath"
805 continue
807 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
808 then
809 say "-$sha1 $displaypath"
810 continue;
812 set_name_rev "$path" "$sha1"
813 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
814 then
815 say " $sha1 $displaypath$revname"
816 else
817 if test -z "$cached"
818 then
819 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
820 set_name_rev "$path" "$sha1"
822 say "+$sha1 $displaypath$revname"
825 if test -n "$recursive"
826 then
828 prefix="$displaypath/"
829 clear_local_git_env
830 cd "$path" &&
831 eval cmd_status "$orig_args"
832 ) ||
833 die "Failed to recurse into submodule path '$path'"
835 done
838 # Sync remote urls for submodules
839 # This makes the value for remote.$remote.url match the value
840 # specified in .gitmodules.
842 cmd_sync()
844 while test $# -ne 0
846 case "$1" in
847 -q|--quiet)
848 GIT_QUIET=1
849 shift
852 shift
853 break
856 usage
859 break
861 esac
862 done
863 cd_to_toplevel
864 module_list "$@" |
865 while read mode sha1 stage path
867 name=$(module_name "$path")
868 url=$(git config -f .gitmodules --get submodule."$name".url)
870 # Possibly a url relative to parent
871 case "$url" in
872 ./*|../*)
873 url=$(resolve_relative_url "$url") || exit
875 esac
877 say "Synchronizing submodule url for '$name'"
878 git config submodule."$name".url "$url"
880 if test -e "$path"/.git
881 then
883 clear_local_git_env
884 cd "$path"
885 remote=$(get_default_remote)
886 git config remote."$remote".url "$url"
889 done
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"
900 case "$1" in
901 add | foreach | init | update | status | summary | sync)
902 command=$1
904 -q|--quiet)
905 GIT_QUIET=1
907 -b|--branch)
908 case "$2" in
910 usage
912 esac
913 branch="$2"; shift
915 --cached)
916 cached="$1"
919 break
922 usage
925 break
927 esac
928 shift
929 done
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
936 then
937 usage
940 # "--cached" is accepted only by "status" and "summary"
941 if test -n "$cached" && test "$command" != status -a "$command" != summary
942 then
943 usage
946 "cmd_$command" "$@"