a6a82d25aa3617504e66ba49c6379df555f34437
1#!/bin/sh
2#
3# git-submodule.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] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
9 or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
10 or: $dashless [--quiet] init [--] [<path>...]
11 or: $dashless [--quiet] deinit [-f|--force] [--] <path>...
12 or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--reference <repository>] [--recursive] [--] [<path>...]
13 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
14 or: $dashless [--quiet] foreach [--recursive] <command>
15 or: $dashless [--quiet] sync [--recursive] [--] [<path>...]"
16OPTIONS_SPEC=
17SUBDIRECTORY_OK=Yes
18. git-sh-setup
19. git-sh-i18n
20. git-parse-remote
21require_work_tree
22wt_prefix=$(git rev-parse --show-prefix)
23cd_to_toplevel
24# Restrict ourselves to a vanilla subset of protocols; the URLs
26# we get are under control of a remote repository, and we do not
27# want them kicking off arbitrary git-remote-* programs.
28#
29# If the user has already specified a set of allowed protocols,
30# we assume they know what they're doing and use that instead.
31: ${GIT_ALLOW_PROTOCOL=file:git:http:https:ssh}
32export GIT_ALLOW_PROTOCOL
33command=
35branch=
36force=
37reference=
38cached=
39recursive=
40init=
41files=
42remote=
43nofetch=
44update=
45prefix=
46custom_name=
47depth=
48# The function takes at most 2 arguments. The first argument is the
50# URL that navigates to the submodule origin repo. When relative, this URL
51# is relative to the superproject origin URL repo. The second up_path
52# argument, if specified, is the relative path that navigates
53# from the submodule working tree to the superproject working tree.
54#
55# The output of the function is the origin URL of the submodule.
56#
57# The output will either be an absolute URL or filesystem path (if the
58# superproject origin URL is an absolute URL or filesystem path,
59# respectively) or a relative file system path (if the superproject
60# origin URL is a relative file system path).
61#
62# When the output is a relative file system path, the path is either
63# relative to the submodule working tree, if up_path is specified, or to
64# the superproject working tree otherwise.
65resolve_relative_url ()
66{
67 remote=$(get_default_remote)
68 remoteurl=$(git config "remote.$remote.url") ||
69 remoteurl=$(pwd) # the repository is its own authoritative upstream
70 url="$1"
71 remoteurl=${remoteurl%/}
72 sep=/
73 up_path="$2"
74 case "$remoteurl" in
76 *:*|/*)
77 is_relative=
78 ;;
79 ./*|../*)
80 is_relative=t
81 ;;
82 *)
83 is_relative=t
84 remoteurl="./$remoteurl"
85 ;;
86 esac
87 while test -n "$url"
89 do
90 case "$url" in
91 ../*)
92 url="${url#../}"
93 case "$remoteurl" in
94 */*)
95 remoteurl="${remoteurl%/*}"
96 ;;
97 *:*)
98 remoteurl="${remoteurl%:*}"
99 sep=:
100 ;;
101 *)
102 if test -z "$is_relative" || test "." = "$remoteurl"
103 then
104 die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
105 else
106 remoteurl=.
107 fi
108 ;;
109 esac
110 ;;
111 ./*)
112 url="${url#./}"
113 ;;
114 *)
115 break;;
116 esac
117 done
118 remoteurl="$remoteurl$sep${url%/}"
119 echo "${is_relative:+${up_path}}${remoteurl#./}"
120}
121# Resolve a path to be relative to another path. This is intended for
123# converting submodule paths when git-submodule is run in a subdirectory
124# and only handles paths where the directory separator is '/'.
125#
126# The output is the first argument as a path relative to the second argument,
127# which defaults to $wt_prefix if it is omitted.
128relative_path ()
129{
130 local target curdir result
131 target=$1
132 curdir=${2-$wt_prefix}
133 curdir=${curdir%/}
134 result=
135 while test -n "$curdir"
137 do
138 case "$target" in
139 "$curdir/"*)
140 target=${target#"$curdir"/}
141 break
142 ;;
143 esac
144 result="${result}../"
146 if test "$curdir" = "${curdir%/*}"
147 then
148 curdir=
149 else
150 curdir="${curdir%/*}"
151 fi
152 done
153 echo "$result$target"
155}
156die_if_unmatched ()
158{
159 if test "$1" = "#unmatched"
160 then
161 exit 1
162 fi
163}
164#
166# Print a submodule configuration setting
167#
168# $1 = submodule name
169# $2 = option name
170# $3 = default value
171#
172# Checks in the usual git-config places first (for overrides),
173# otherwise it falls back on .gitmodules. This allows you to
174# distribute project-wide defaults in .gitmodules, while still
175# customizing individual repositories if necessary. If the option is
176# not in .gitmodules either, print a default value.
177#
178get_submodule_config () {
179 name="$1"
180 option="$2"
181 default="$3"
182 value=$(git config submodule."$name"."$option")
183 if test -z "$value"
184 then
185 value=$(git config -f .gitmodules submodule."$name"."$option")
186 fi
187 printf '%s' "${value:-$default}"
188}
189isnumber()
191{
192 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
193}
194#
196# Add a new submodule to the working tree, .gitmodules and the index
197#
198# $@ = repo path
199#
200# optional branch is stored in global branch variable
201#
202cmd_add()
203{
204 # parse $args after "submodule ... add".
205 reference_path=
206 while test $# -ne 0
207 do
208 case "$1" in
209 -b | --branch)
210 case "$2" in '') usage ;; esac
211 branch=$2
212 shift
213 ;;
214 -f | --force)
215 force=$1
216 ;;
217 -q|--quiet)
218 GIT_QUIET=1
219 ;;
220 --reference)
221 case "$2" in '') usage ;; esac
222 reference_path=$2
223 shift
224 ;;
225 --reference=*)
226 reference_path="${1#--reference=}"
227 ;;
228 --name)
229 case "$2" in '') usage ;; esac
230 custom_name=$2
231 shift
232 ;;
233 --depth)
234 case "$2" in '') usage ;; esac
235 depth="--depth=$2"
236 shift
237 ;;
238 --depth=*)
239 depth=$1
240 ;;
241 --)
242 shift
243 break
244 ;;
245 -*)
246 usage
247 ;;
248 *)
249 break
250 ;;
251 esac
252 shift
253 done
254 if test -n "$reference_path"
256 then
257 is_absolute_path "$reference_path" ||
258 reference_path="$wt_prefix$reference_path"
259 reference="--reference=$reference_path"
261 fi
262 repo=$1
264 sm_path=$2
265 if test -z "$sm_path"; then
267 sm_path=$(printf '%s\n' "$repo" |
268 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
269 fi
270 if test -z "$repo" || test -z "$sm_path"; then
272 usage
273 fi
274 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
276 # assure repo is absolute or relative to parent
278 case "$repo" in
279 ./*|../*)
280 test -z "$wt_prefix" ||
281 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
282 # dereference source url relative to parent's url
284 realrepo=$(resolve_relative_url "$repo") || exit
285 ;;
286 *:*|/*)
287 # absolute url
288 realrepo=$repo
289 ;;
290 *)
291 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
292 ;;
293 esac
294 # normalize path:
296 # multiple //; leading ./; /./; /../; trailing /
297 sm_path=$(printf '%s/\n' "$sm_path" |
298 sed -e '
299 s|//*|/|g
300 s|^\(\./\)*||
301 s|/\(\./\)*|/|g
302 :start
303 s|\([^/]*\)/\.\./||
304 tstart
305 s|/*$||
306 ')
307 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
308 die "$(eval_gettext "'\$sm_path' already exists in the index")"
309 if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
311 then
312 eval_gettextln "The following path is ignored by one of your .gitignore files:
313\$sm_path
314Use -f if you really want to add it." >&2
315 exit 1
316 fi
317 if test -n "$custom_name"
319 then
320 sm_name="$custom_name"
321 else
322 sm_name="$sm_path"
323 fi
324 # perhaps the path exists and is already a git repo, else clone it
326 if test -e "$sm_path"
327 then
328 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
329 then
330 eval_gettextln "Adding existing repo at '\$sm_path' to the index"
331 else
332 die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
333 fi
334 else
336 if test -d ".git/modules/$sm_name"
337 then
338 if test -z "$force"
339 then
340 echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
341 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^," ", -e s,' (fetch)',, >&2
342 echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
343 echo >&2 " $realrepo"
344 echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
345 die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
346 else
347 echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
348 fi
349 fi
350 git submodule--helper clone ${GIT_QUIET:+--quiet} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" "$reference" "$depth" || exit
351 (
352 clear_local_git_env
353 cd "$sm_path" &&
354 # ash fails to wordsplit ${branch:+-b "$branch"...}
355 case "$branch" in
356 '') git checkout -f -q ;;
357 ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
358 esac
359 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
360 fi
361 git config submodule."$sm_name".url "$realrepo"
362 git add $force "$sm_path" ||
364 die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
365 git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
367 git config -f .gitmodules submodule."$sm_name".url "$repo" &&
368 if test -n "$branch"
369 then
370 git config -f .gitmodules submodule."$sm_name".branch "$branch"
371 fi &&
372 git add --force .gitmodules ||
373 die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
374}
375#
377# Execute an arbitrary command sequence in each checked out
378# submodule
379#
380# $@ = command to execute
381#
382cmd_foreach()
383{
384 # parse $args after "submodule ... foreach".
385 while test $# -ne 0
386 do
387 case "$1" in
388 -q|--quiet)
389 GIT_QUIET=1
390 ;;
391 --recursive)
392 recursive=1
393 ;;
394 -*)
395 usage
396 ;;
397 *)
398 break
399 ;;
400 esac
401 shift
402 done
403 toplevel=$(pwd)
405 # dup stdin so that it can be restored when running the external
407 # command in the subshell (and a recursive call to this function)
408 exec 3<&0
409 git submodule--helper list --prefix "$wt_prefix"|
411 while read mode sha1 stage sm_path
412 do
413 die_if_unmatched "$mode"
414 if test -e "$sm_path"/.git
415 then
416 displaypath=$(relative_path "$sm_path")
417 say "$(eval_gettext "Entering '\$prefix\$displaypath'")"
418 name=$(git submodule--helper name "$sm_path")
419 (
420 prefix="$prefix$sm_path/"
421 clear_local_git_env
422 cd "$sm_path" &&
423 sm_path=$(relative_path "$sm_path") &&
424 # we make $path available to scripts ...
425 path=$sm_path &&
426 if test $# -eq 1
427 then
428 eval "$1"
429 else
430 "$@"
431 fi &&
432 if test -n "$recursive"
433 then
434 cmd_foreach "--recursive" "$@"
435 fi
436 ) <&3 3<&- ||
437 die "$(eval_gettext "Stopping at '\$prefix\$displaypath'; script returned non-zero status.")"
438 fi
439 done
440}
441#
443# Register submodules in .git/config
444#
445# $@ = requested paths (default to all)
446#
447cmd_init()
448{
449 # parse $args after "submodule ... init".
450 while test $# -ne 0
451 do
452 case "$1" in
453 -q|--quiet)
454 GIT_QUIET=1
455 ;;
456 --)
457 shift
458 break
459 ;;
460 -*)
461 usage
462 ;;
463 *)
464 break
465 ;;
466 esac
467 shift
468 done
469 git submodule--helper list --prefix "$wt_prefix" "$@" |
471 while read mode sha1 stage sm_path
472 do
473 die_if_unmatched "$mode"
474 name=$(git submodule--helper name "$sm_path") || exit
475 displaypath=$(relative_path "$sm_path")
477 # Copy url setting when it is not set yet
479 if test -z "$(git config "submodule.$name.url")"
480 then
481 url=$(git config -f .gitmodules submodule."$name".url)
482 test -z "$url" &&
483 die "$(eval_gettext "No url found for submodule path '\$displaypath' in .gitmodules")"
484 # Possibly a url relative to parent
486 case "$url" in
487 ./*|../*)
488 url=$(resolve_relative_url "$url") || exit
489 ;;
490 esac
491 git config submodule."$name".url "$url" ||
492 die "$(eval_gettext "Failed to register url for submodule path '\$displaypath'")"
493 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$displaypath'")"
495 fi
496 # Copy "update" setting when it is not set yet
498 if upd="$(git config -f .gitmodules submodule."$name".update)" &&
499 test -n "$upd" &&
500 test -z "$(git config submodule."$name".update)"
501 then
502 case "$upd" in
503 checkout | rebase | merge | none)
504 ;; # known modes of updating
505 *)
506 echo >&2 "warning: unknown update mode '$upd' suggested for submodule '$name'"
507 upd=none
508 ;;
509 esac
510 git config submodule."$name".update "$upd" ||
511 die "$(eval_gettext "Failed to register update mode for submodule path '\$displaypath'")"
512 fi
513 done
514}
515#
517# Unregister submodules from .git/config and remove their work tree
518#
519# $@ = requested paths (use '.' to deinit all submodules)
520#
521cmd_deinit()
522{
523 # parse $args after "submodule ... deinit".
524 while test $# -ne 0
525 do
526 case "$1" in
527 -f|--force)
528 force=$1
529 ;;
530 -q|--quiet)
531 GIT_QUIET=1
532 ;;
533 --)
534 shift
535 break
536 ;;
537 -*)
538 usage
539 ;;
540 *)
541 break
542 ;;
543 esac
544 shift
545 done
546 if test $# = 0
548 then
549 die "$(eval_gettext "Use '.' if you really want to deinitialize all submodules")"
550 fi
551 git submodule--helper list --prefix "$wt_prefix" "$@" |
553 while read mode sha1 stage sm_path
554 do
555 die_if_unmatched "$mode"
556 name=$(git submodule--helper name "$sm_path") || exit
557 displaypath=$(relative_path "$sm_path")
559 # Remove the submodule work tree (unless the user already did it)
561 if test -d "$sm_path"
562 then
563 # Protect submodules containing a .git directory
564 if test -d "$sm_path/.git"
565 then
566 echo >&2 "$(eval_gettext "Submodule work tree '\$displaypath' contains a .git directory")"
567 die "$(eval_gettext "(use 'rm -rf' if you really want to remove it including all of its history)")"
568 fi
569 if test -z "$force"
571 then
572 git rm -qn "$sm_path" ||
573 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
574 fi
575 rm -rf "$sm_path" &&
576 say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
577 say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
578 fi
579 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
581 # Remove the .git/config entries (unless the user already did it)
583 if test -n "$(git config --get-regexp submodule."$name\.")"
584 then
585 # Remove the whole section so we have a clean state when
586 # the user later decides to init this submodule again
587 url=$(git config submodule."$name".url)
588 git config --remove-section submodule."$name" 2>/dev/null &&
589 say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
590 fi
591 done
592}
593#
595# Update each submodule path to correct revision, using clone and checkout as needed
596#
597# $@ = requested paths (default to all)
598#
599cmd_update()
600{
601 # parse $args after "submodule ... update".
602 while test $# -ne 0
603 do
604 case "$1" in
605 -q|--quiet)
606 GIT_QUIET=1
607 ;;
608 -i|--init)
609 init=1
610 ;;
611 --remote)
612 remote=1
613 ;;
614 -N|--no-fetch)
615 nofetch=1
616 ;;
617 -f|--force)
618 force=$1
619 ;;
620 -r|--rebase)
621 update="rebase"
622 ;;
623 --reference)
624 case "$2" in '') usage ;; esac
625 reference="--reference=$2"
626 shift
627 ;;
628 --reference=*)
629 reference="$1"
630 ;;
631 -m|--merge)
632 update="merge"
633 ;;
634 --recursive)
635 recursive=1
636 ;;
637 --checkout)
638 update="checkout"
639 ;;
640 --depth)
641 case "$2" in '') usage ;; esac
642 depth="--depth=$2"
643 shift
644 ;;
645 --depth=*)
646 depth=$1
647 ;;
648 --)
649 shift
650 break
651 ;;
652 -*)
653 usage
654 ;;
655 *)
656 break
657 ;;
658 esac
659 shift
660 done
661 if test -n "$init"
663 then
664 cmd_init "--" "$@" || return
665 fi
666 {
668 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
669 ${wt_prefix:+--prefix "$wt_prefix"} \
670 ${prefix:+--recursive-prefix "$prefix"} \
671 ${update:+--update "$update"} \
672 ${reference:+--reference "$reference"} \
673 ${depth:+--depth "$depth"} \
674 "$@" || echo "#unmatched"
675 } | {
676 err=
677 while read mode sha1 stage just_cloned sm_path
678 do
679 die_if_unmatched "$mode"
680 name=$(git submodule--helper name "$sm_path") || exit
682 url=$(git config submodule."$name".url)
683 branch=$(get_submodule_config "$name" branch master)
684 if ! test -z "$update"
685 then
686 update_module=$update
687 else
688 update_module=$(git config submodule."$name".update)
689 if test -z "$update_module"
690 then
691 update_module="checkout"
692 fi
693 fi
694 displaypath=$(relative_path "$prefix$sm_path")
696 if test $just_cloned -eq 1
698 then
699 subsha1=
700 update_module=checkout
701 else
702 subsha1=$(clear_local_git_env; cd "$sm_path" &&
703 git rev-parse --verify HEAD) ||
704 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
705 fi
706 if test -n "$remote"
708 then
709 if test -z "$nofetch"
710 then
711 # Fetch remote before determining tracking $sha1
712 (clear_local_git_env; cd "$sm_path" && git-fetch) ||
713 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
714 fi
715 remote_name=$(clear_local_git_env; cd "$sm_path" && get_default_remote)
716 sha1=$(clear_local_git_env; cd "$sm_path" &&
717 git rev-parse --verify "${remote_name}/${branch}") ||
718 die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
719 fi
720 if test "$subsha1" != "$sha1" || test -n "$force"
722 then
723 subforce=$force
724 # If we don't already have a -f flag and the submodule has never been checked out
725 if test -z "$subsha1" && test -z "$force"
726 then
727 subforce="-f"
728 fi
729 if test -z "$nofetch"
731 then
732 # Run fetch only if $sha1 isn't present or it
733 # is not reachable from a ref.
734 (clear_local_git_env; cd "$sm_path" &&
735 ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
736 test -z "$rev") || git-fetch)) ||
737 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
738 fi
739 must_die_on_failure=
741 case "$update_module" in
742 checkout)
743 command="git checkout $subforce -q"
744 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
745 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
746 ;;
747 rebase)
748 command="git rebase"
749 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
750 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
751 must_die_on_failure=yes
752 ;;
753 merge)
754 command="git merge"
755 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
756 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
757 must_die_on_failure=yes
758 ;;
759 !*)
760 command="${update_module#!}"
761 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$prefix\$sm_path'")"
762 say_msg="$(eval_gettext "Submodule path '\$prefix\$sm_path': '\$command \$sha1'")"
763 must_die_on_failure=yes
764 ;;
765 *)
766 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
767 esac
768 if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
770 then
771 say "$say_msg"
772 elif test -n "$must_die_on_failure"
773 then
774 die_with_status 2 "$die_msg"
775 else
776 err="${err};$die_msg"
777 continue
778 fi
779 fi
780 if test -n "$recursive"
782 then
783 (
784 prefix="$prefix$sm_path/"
785 clear_local_git_env
786 cd "$sm_path" &&
787 eval cmd_update
788 )
789 res=$?
790 if test $res -gt 0
791 then
792 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
793 if test $res -eq 1
794 then
795 err="${err};$die_msg"
796 continue
797 else
798 die_with_status $res "$die_msg"
799 fi
800 fi
801 fi
802 done
803 if test -n "$err"
805 then
806 OIFS=$IFS
807 IFS=';'
808 for e in $err
809 do
810 if test -n "$e"
811 then
812 echo >&2 "$e"
813 fi
814 done
815 IFS=$OIFS
816 exit 1
817 fi
818 }
819}
820set_name_rev () {
822 revname=$( (
823 clear_local_git_env
824 cd "$1" && {
825 git describe "$2" 2>/dev/null ||
826 git describe --tags "$2" 2>/dev/null ||
827 git describe --contains "$2" 2>/dev/null ||
828 git describe --all --always "$2"
829 }
830 ) )
831 test -z "$revname" || revname=" ($revname)"
832}
833#
834# Show commit summary for submodules in index or working tree
835#
836# If '--cached' is given, show summary between index and given commit,
837# or between working tree and given commit
838#
839# $@ = [commit (default 'HEAD'),] requested paths (default all)
840#
841cmd_summary() {
842 summary_limit=-1
843 for_status=
844 diff_cmd=diff-index
845 # parse $args after "submodule ... summary".
847 while test $# -ne 0
848 do
849 case "$1" in
850 --cached)
851 cached="$1"
852 ;;
853 --files)
854 files="$1"
855 ;;
856 --for-status)
857 for_status="$1"
858 ;;
859 -n|--summary-limit)
860 summary_limit="$2"
861 isnumber "$summary_limit" || usage
862 shift
863 ;;
864 --summary-limit=*)
865 summary_limit="${1#--summary-limit=}"
866 isnumber "$summary_limit" || usage
867 ;;
868 --)
869 shift
870 break
871 ;;
872 -*)
873 usage
874 ;;
875 *)
876 break
877 ;;
878 esac
879 shift
880 done
881 test $summary_limit = 0 && return
883 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
885 then
886 head=$rev
887 test $# = 0 || shift
888 elif test -z "$1" || test "$1" = "HEAD"
889 then
890 # before the first commit: compare with an empty tree
891 head=$(git hash-object -w -t tree --stdin </dev/null)
892 test -z "$1" || shift
893 else
894 head="HEAD"
895 fi
896 if [ -n "$files" ]
898 then
899 test -n "$cached" &&
900 die "$(gettext "The --cached option cannot be used with the --files option")"
901 diff_cmd=diff-files
902 head=
903 fi
904 cd_to_toplevel
906 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
907 # Get modified modules cared by user
908 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
909 sane_egrep '^:([0-7]* )?160000' |
910 while read mod_src mod_dst sha1_src sha1_dst status sm_path
911 do
912 # Always show modules deleted or type-changed (blob<->module)
913 if test "$status" = D || test "$status" = T
914 then
915 printf '%s\n' "$sm_path"
916 continue
917 fi
918 # Respect the ignore setting for --for-status.
919 if test -n "$for_status"
920 then
921 name=$(git submodule--helper name "$sm_path")
922 ignore_config=$(get_submodule_config "$name" ignore none)
923 test $status != A && test $ignore_config = all && continue
924 fi
925 # Also show added or modified modules which are checked out
926 GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
927 printf '%s\n' "$sm_path"
928 done
929 )
930 test -z "$modules" && return
932 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
934 sane_egrep '^:([0-7]* )?160000' |
935 cut -c2- |
936 while read mod_src mod_dst sha1_src sha1_dst status name
937 do
938 if test -z "$cached" &&
939 test $sha1_dst = 0000000000000000000000000000000000000000
940 then
941 case "$mod_dst" in
942 160000)
943 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
944 ;;
945 100644 | 100755 | 120000)
946 sha1_dst=$(git hash-object $name)
947 ;;
948 000000)
949 ;; # removed
950 *)
951 # unexpected type
952 eval_gettextln "unexpected mode \$mod_dst" >&2
953 continue ;;
954 esac
955 fi
956 missing_src=
957 missing_dst=
958 test $mod_src = 160000 &&
960 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
961 missing_src=t
962 test $mod_dst = 160000 &&
964 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
965 missing_dst=t
966 display_name=$(relative_path "$name")
968 total_commits=
970 case "$missing_src,$missing_dst" in
971 t,)
972 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
973 ;;
974 ,t)
975 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
976 ;;
977 t,t)
978 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
979 ;;
980 *)
981 errmsg=
982 total_commits=$(
983 if test $mod_src = 160000 && test $mod_dst = 160000
984 then
985 range="$sha1_src...$sha1_dst"
986 elif test $mod_src = 160000
987 then
988 range=$sha1_src
989 else
990 range=$sha1_dst
991 fi
992 GIT_DIR="$name/.git" \
993 git rev-list --first-parent $range -- | wc -l
994 )
995 total_commits=" ($(($total_commits + 0)))"
996 ;;
997 esac
998 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
1000 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
1001 if test $status = T
1002 then
1003 blob="$(gettext "blob")"
1004 submodule="$(gettext "submodule")"
1005 if test $mod_dst = 160000
1006 then
1007 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1008 else
1009 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1010 fi
1011 else
1012 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1013 fi
1014 if test -n "$errmsg"
1015 then
1016 # Don't give error msg for modification whose dst is not submodule
1017 # i.e. deleted or changed to blob
1018 test $mod_dst = 160000 && echo "$errmsg"
1019 else
1020 if test $mod_src = 160000 && test $mod_dst = 160000
1021 then
1022 limit=
1023 test $summary_limit -gt 0 && limit="-$summary_limit"
1024 GIT_DIR="$name/.git" \
1025 git log $limit --pretty='format: %m %s' \
1026 --first-parent $sha1_src...$sha1_dst
1027 elif test $mod_dst = 160000
1028 then
1029 GIT_DIR="$name/.git" \
1030 git log --pretty='format: > %s' -1 $sha1_dst
1031 else
1032 GIT_DIR="$name/.git" \
1033 git log --pretty='format: < %s' -1 $sha1_src
1034 fi
1035 echo
1036 fi
1037 echo
1038 done
1039}
1040#
1041# List all submodules, prefixed with:
1042# - submodule not initialized
1043# + different revision checked out
1044#
1045# If --cached was specified the revision in the index will be printed
1046# instead of the currently checked out revision.
1047#
1048# $@ = requested paths (default to all)
1049#
1050cmd_status()
1051{
1052 # parse $args after "submodule ... status".
1053 while test $# -ne 0
1054 do
1055 case "$1" in
1056 -q|--quiet)
1057 GIT_QUIET=1
1058 ;;
1059 --cached)
1060 cached=1
1061 ;;
1062 --recursive)
1063 recursive=1
1064 ;;
1065 --)
1066 shift
1067 break
1068 ;;
1069 -*)
1070 usage
1071 ;;
1072 *)
1073 break
1074 ;;
1075 esac
1076 shift
1077 done
1078 git submodule--helper list --prefix "$wt_prefix" "$@" |
1080 while read mode sha1 stage sm_path
1081 do
1082 die_if_unmatched "$mode"
1083 name=$(git submodule--helper name "$sm_path") || exit
1084 url=$(git config submodule."$name".url)
1085 displaypath=$(relative_path "$prefix$sm_path")
1086 if test "$stage" = U
1087 then
1088 say "U$sha1 $displaypath"
1089 continue
1090 fi
1091 if test -z "$url" ||
1092 {
1093 ! test -d "$sm_path"/.git &&
1094 ! test -f "$sm_path"/.git
1095 }
1096 then
1097 say "-$sha1 $displaypath"
1098 continue;
1099 fi
1100 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1101 then
1102 set_name_rev "$sm_path" "$sha1"
1103 say " $sha1 $displaypath$revname"
1104 else
1105 if test -z "$cached"
1106 then
1107 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1108 fi
1109 set_name_rev "$sm_path" "$sha1"
1110 say "+$sha1 $displaypath$revname"
1111 fi
1112 if test -n "$recursive"
1114 then
1115 (
1116 prefix="$displaypath/"
1117 clear_local_git_env
1118 cd "$sm_path" &&
1119 eval cmd_status
1120 ) ||
1121 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1122 fi
1123 done
1124}
1125#
1126# Sync remote urls for submodules
1127# This makes the value for remote.$remote.url match the value
1128# specified in .gitmodules.
1129#
1130cmd_sync()
1131{
1132 while test $# -ne 0
1133 do
1134 case "$1" in
1135 -q|--quiet)
1136 GIT_QUIET=1
1137 shift
1138 ;;
1139 --recursive)
1140 recursive=1
1141 shift
1142 ;;
1143 --)
1144 shift
1145 break
1146 ;;
1147 -*)
1148 usage
1149 ;;
1150 *)
1151 break
1152 ;;
1153 esac
1154 done
1155 cd_to_toplevel
1156 git submodule--helper list --prefix "$wt_prefix" "$@" |
1157 while read mode sha1 stage sm_path
1158 do
1159 die_if_unmatched "$mode"
1160 name=$(git submodule--helper name "$sm_path")
1161 url=$(git config -f .gitmodules --get submodule."$name".url)
1162 # Possibly a url relative to parent
1164 case "$url" in
1165 ./*|../*)
1166 # rewrite foo/bar as ../.. to find path from
1167 # submodule work tree to superproject work tree
1168 up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1169 # guarantee a trailing /
1170 up_path=${up_path%/}/ &&
1171 # path from submodule work tree to submodule origin repo
1172 sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1173 # path from superproject work tree to submodule origin repo
1174 super_config_url=$(resolve_relative_url "$url") || exit
1175 ;;
1176 *)
1177 sub_origin_url="$url"
1178 super_config_url="$url"
1179 ;;
1180 esac
1181 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1183 then
1184 displaypath=$(relative_path "$prefix$sm_path")
1185 say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1186 git config submodule."$name".url "$super_config_url"
1187 if test -e "$sm_path"/.git
1189 then
1190 (
1191 clear_local_git_env
1192 cd "$sm_path"
1193 remote=$(get_default_remote)
1194 git config remote."$remote".url "$sub_origin_url"
1195 if test -n "$recursive"
1197 then
1198 prefix="$prefix$sm_path/"
1199 eval cmd_sync
1200 fi
1201 )
1202 fi
1203 fi
1204 done
1205}
1206# This loop parses the command line arguments to find the
1208# subcommand name to dispatch. Parsing of the subcommand specific
1209# options are primarily done by the subcommand implementations.
1210# Subcommand specific options such as --branch and --cached are
1211# parsed here as well, for backward compatibility.
1212while test $# != 0 && test -z "$command"
1214do
1215 case "$1" in
1216 add | foreach | init | deinit | update | status | summary | sync)
1217 command=$1
1218 ;;
1219 -q|--quiet)
1220 GIT_QUIET=1
1221 ;;
1222 -b|--branch)
1223 case "$2" in
1224 '')
1225 usage
1226 ;;
1227 esac
1228 branch="$2"; shift
1229 ;;
1230 --cached)
1231 cached="$1"
1232 ;;
1233 --)
1234 break
1235 ;;
1236 -*)
1237 usage
1238 ;;
1239 *)
1240 break
1241 ;;
1242 esac
1243 shift
1244done
1245# No command word defaults to "status"
1247if test -z "$command"
1248then
1249 if test $# = 0
1250 then
1251 command=status
1252 else
1253 usage
1254 fi
1255fi
1256# "-b branch" is accepted only by "add"
1258if test -n "$branch" && test "$command" != add
1259then
1260 usage
1261fi
1262# "--cached" is accepted only by "status" and "summary"
1264if test -n "$cached" && test "$command" != status && test "$command" != summary
1265then
1266 usage
1267fi
1268"cmd_$command" "$@"