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}
593is_tip_reachable () (
595 clear_local_git_env
596 cd "$1" &&
597 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
598 test -z "$rev"
599)
600fetch_in_submodule () (
602 clear_local_git_env
603 cd "$1" &&
604 case "$2" in
605 '')
606 git fetch ;;
607 *)
608 git fetch $(get_default_remote) "$2" ;;
609 esac
610)
611#
613# Update each submodule path to correct revision, using clone and checkout as needed
614#
615# $@ = requested paths (default to all)
616#
617cmd_update()
618{
619 # parse $args after "submodule ... update".
620 while test $# -ne 0
621 do
622 case "$1" in
623 -q|--quiet)
624 GIT_QUIET=1
625 ;;
626 -i|--init)
627 init=1
628 ;;
629 --remote)
630 remote=1
631 ;;
632 -N|--no-fetch)
633 nofetch=1
634 ;;
635 -f|--force)
636 force=$1
637 ;;
638 -r|--rebase)
639 update="rebase"
640 ;;
641 --reference)
642 case "$2" in '') usage ;; esac
643 reference="--reference=$2"
644 shift
645 ;;
646 --reference=*)
647 reference="$1"
648 ;;
649 -m|--merge)
650 update="merge"
651 ;;
652 --recursive)
653 recursive=1
654 ;;
655 --checkout)
656 update="checkout"
657 ;;
658 --depth)
659 case "$2" in '') usage ;; esac
660 depth="--depth=$2"
661 shift
662 ;;
663 --depth=*)
664 depth=$1
665 ;;
666 -j|--jobs)
667 case "$2" in '') usage ;; esac
668 jobs="--jobs=$2"
669 shift
670 ;;
671 --jobs=*)
672 jobs=$1
673 ;;
674 --)
675 shift
676 break
677 ;;
678 -*)
679 usage
680 ;;
681 *)
682 break
683 ;;
684 esac
685 shift
686 done
687 if test -n "$init"
689 then
690 cmd_init "--" "$@" || return
691 fi
692 {
694 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
695 ${wt_prefix:+--prefix "$wt_prefix"} \
696 ${prefix:+--recursive-prefix "$prefix"} \
697 ${update:+--update "$update"} \
698 ${reference:+--reference "$reference"} \
699 ${depth:+--depth "$depth"} \
700 ${jobs:+$jobs} \
701 "$@" || echo "#unmatched"
702 } | {
703 err=
704 while read mode sha1 stage just_cloned sm_path
705 do
706 die_if_unmatched "$mode"
707 name=$(git submodule--helper name "$sm_path") || exit
709 url=$(git config submodule."$name".url)
710 branch=$(get_submodule_config "$name" branch master)
711 if ! test -z "$update"
712 then
713 update_module=$update
714 else
715 update_module=$(git config submodule."$name".update)
716 if test -z "$update_module"
717 then
718 update_module="checkout"
719 fi
720 fi
721 displaypath=$(relative_path "$prefix$sm_path")
723 if test $just_cloned -eq 1
725 then
726 subsha1=
727 update_module=checkout
728 else
729 subsha1=$(clear_local_git_env; cd "$sm_path" &&
730 git rev-parse --verify HEAD) ||
731 die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
732 fi
733 if test -n "$remote"
735 then
736 if test -z "$nofetch"
737 then
738 # Fetch remote before determining tracking $sha1
739 (clear_local_git_env; cd "$sm_path" && git-fetch) ||
740 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
741 fi
742 remote_name=$(clear_local_git_env; cd "$sm_path" && get_default_remote)
743 sha1=$(clear_local_git_env; cd "$sm_path" &&
744 git rev-parse --verify "${remote_name}/${branch}") ||
745 die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
746 fi
747 if test "$subsha1" != "$sha1" || test -n "$force"
749 then
750 subforce=$force
751 # If we don't already have a -f flag and the submodule has never been checked out
752 if test -z "$subsha1" && test -z "$force"
753 then
754 subforce="-f"
755 fi
756 if test -z "$nofetch"
758 then
759 # Run fetch only if $sha1 isn't present or it
760 # is not reachable from a ref.
761 is_tip_reachable "$sm_path" "$sha1" ||
762 fetch_in_submodule "$sm_path" ||
763 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
764 # Now we tried the usual fetch, but $sha1 may
766 # not be reachable from any of the refs
767 is_tip_reachable "$sm_path" "$sha1" ||
768 fetch_in_submodule "$sm_path" "$sha1" ||
769 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain $sha1. Direct fetching of that commit failed.")"
770 fi
771 must_die_on_failure=
773 case "$update_module" in
774 checkout)
775 command="git checkout $subforce -q"
776 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
777 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
778 ;;
779 rebase)
780 command="git rebase"
781 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
782 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
783 must_die_on_failure=yes
784 ;;
785 merge)
786 command="git merge"
787 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
788 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
789 must_die_on_failure=yes
790 ;;
791 !*)
792 command="${update_module#!}"
793 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$prefix\$sm_path'")"
794 say_msg="$(eval_gettext "Submodule path '\$prefix\$sm_path': '\$command \$sha1'")"
795 must_die_on_failure=yes
796 ;;
797 *)
798 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
799 esac
800 if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
802 then
803 say "$say_msg"
804 elif test -n "$must_die_on_failure"
805 then
806 die_with_status 2 "$die_msg"
807 else
808 err="${err};$die_msg"
809 continue
810 fi
811 fi
812 if test -n "$recursive"
814 then
815 (
816 prefix="$prefix$sm_path/"
817 clear_local_git_env
818 cd "$sm_path" &&
819 eval cmd_update
820 )
821 res=$?
822 if test $res -gt 0
823 then
824 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
825 if test $res -eq 1
826 then
827 err="${err};$die_msg"
828 continue
829 else
830 die_with_status $res "$die_msg"
831 fi
832 fi
833 fi
834 done
835 if test -n "$err"
837 then
838 OIFS=$IFS
839 IFS=';'
840 for e in $err
841 do
842 if test -n "$e"
843 then
844 echo >&2 "$e"
845 fi
846 done
847 IFS=$OIFS
848 exit 1
849 fi
850 }
851}
852set_name_rev () {
854 revname=$( (
855 clear_local_git_env
856 cd "$1" && {
857 git describe "$2" 2>/dev/null ||
858 git describe --tags "$2" 2>/dev/null ||
859 git describe --contains "$2" 2>/dev/null ||
860 git describe --all --always "$2"
861 }
862 ) )
863 test -z "$revname" || revname=" ($revname)"
864}
865#
866# Show commit summary for submodules in index or working tree
867#
868# If '--cached' is given, show summary between index and given commit,
869# or between working tree and given commit
870#
871# $@ = [commit (default 'HEAD'),] requested paths (default all)
872#
873cmd_summary() {
874 summary_limit=-1
875 for_status=
876 diff_cmd=diff-index
877 # parse $args after "submodule ... summary".
879 while test $# -ne 0
880 do
881 case "$1" in
882 --cached)
883 cached="$1"
884 ;;
885 --files)
886 files="$1"
887 ;;
888 --for-status)
889 for_status="$1"
890 ;;
891 -n|--summary-limit)
892 summary_limit="$2"
893 isnumber "$summary_limit" || usage
894 shift
895 ;;
896 --summary-limit=*)
897 summary_limit="${1#--summary-limit=}"
898 isnumber "$summary_limit" || usage
899 ;;
900 --)
901 shift
902 break
903 ;;
904 -*)
905 usage
906 ;;
907 *)
908 break
909 ;;
910 esac
911 shift
912 done
913 test $summary_limit = 0 && return
915 if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
917 then
918 head=$rev
919 test $# = 0 || shift
920 elif test -z "$1" || test "$1" = "HEAD"
921 then
922 # before the first commit: compare with an empty tree
923 head=$(git hash-object -w -t tree --stdin </dev/null)
924 test -z "$1" || shift
925 else
926 head="HEAD"
927 fi
928 if [ -n "$files" ]
930 then
931 test -n "$cached" &&
932 die "$(gettext "The --cached option cannot be used with the --files option")"
933 diff_cmd=diff-files
934 head=
935 fi
936 cd_to_toplevel
938 eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
939 # Get modified modules cared by user
940 modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
941 sane_egrep '^:([0-7]* )?160000' |
942 while read mod_src mod_dst sha1_src sha1_dst status sm_path
943 do
944 # Always show modules deleted or type-changed (blob<->module)
945 if test "$status" = D || test "$status" = T
946 then
947 printf '%s\n' "$sm_path"
948 continue
949 fi
950 # Respect the ignore setting for --for-status.
951 if test -n "$for_status"
952 then
953 name=$(git submodule--helper name "$sm_path")
954 ignore_config=$(get_submodule_config "$name" ignore none)
955 test $status != A && test $ignore_config = all && continue
956 fi
957 # Also show added or modified modules which are checked out
958 GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
959 printf '%s\n' "$sm_path"
960 done
961 )
962 test -z "$modules" && return
964 git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
966 sane_egrep '^:([0-7]* )?160000' |
967 cut -c2- |
968 while read mod_src mod_dst sha1_src sha1_dst status name
969 do
970 if test -z "$cached" &&
971 test $sha1_dst = 0000000000000000000000000000000000000000
972 then
973 case "$mod_dst" in
974 160000)
975 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
976 ;;
977 100644 | 100755 | 120000)
978 sha1_dst=$(git hash-object $name)
979 ;;
980 000000)
981 ;; # removed
982 *)
983 # unexpected type
984 eval_gettextln "unexpected mode \$mod_dst" >&2
985 continue ;;
986 esac
987 fi
988 missing_src=
989 missing_dst=
990 test $mod_src = 160000 &&
992 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
993 missing_src=t
994 test $mod_dst = 160000 &&
996 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
997 missing_dst=t
998 display_name=$(relative_path "$name")
1000 total_commits=
1002 case "$missing_src,$missing_dst" in
1003 t,)
1004 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_src")"
1005 ;;
1006 ,t)
1007 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commit \$sha1_dst")"
1008 ;;
1009 t,t)
1010 errmsg="$(eval_gettext " Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
1011 ;;
1012 *)
1013 errmsg=
1014 total_commits=$(
1015 if test $mod_src = 160000 && test $mod_dst = 160000
1016 then
1017 range="$sha1_src...$sha1_dst"
1018 elif test $mod_src = 160000
1019 then
1020 range=$sha1_src
1021 else
1022 range=$sha1_dst
1023 fi
1024 GIT_DIR="$name/.git" \
1025 git rev-list --first-parent $range -- | wc -l
1026 )
1027 total_commits=" ($(($total_commits + 0)))"
1028 ;;
1029 esac
1030 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
1032 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
1033 if test $status = T
1034 then
1035 blob="$(gettext "blob")"
1036 submodule="$(gettext "submodule")"
1037 if test $mod_dst = 160000
1038 then
1039 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1040 else
1041 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1042 fi
1043 else
1044 echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1045 fi
1046 if test -n "$errmsg"
1047 then
1048 # Don't give error msg for modification whose dst is not submodule
1049 # i.e. deleted or changed to blob
1050 test $mod_dst = 160000 && echo "$errmsg"
1051 else
1052 if test $mod_src = 160000 && test $mod_dst = 160000
1053 then
1054 limit=
1055 test $summary_limit -gt 0 && limit="-$summary_limit"
1056 GIT_DIR="$name/.git" \
1057 git log $limit --pretty='format: %m %s' \
1058 --first-parent $sha1_src...$sha1_dst
1059 elif test $mod_dst = 160000
1060 then
1061 GIT_DIR="$name/.git" \
1062 git log --pretty='format: > %s' -1 $sha1_dst
1063 else
1064 GIT_DIR="$name/.git" \
1065 git log --pretty='format: < %s' -1 $sha1_src
1066 fi
1067 echo
1068 fi
1069 echo
1070 done
1071}
1072#
1073# List all submodules, prefixed with:
1074# - submodule not initialized
1075# + different revision checked out
1076#
1077# If --cached was specified the revision in the index will be printed
1078# instead of the currently checked out revision.
1079#
1080# $@ = requested paths (default to all)
1081#
1082cmd_status()
1083{
1084 # parse $args after "submodule ... status".
1085 while test $# -ne 0
1086 do
1087 case "$1" in
1088 -q|--quiet)
1089 GIT_QUIET=1
1090 ;;
1091 --cached)
1092 cached=1
1093 ;;
1094 --recursive)
1095 recursive=1
1096 ;;
1097 --)
1098 shift
1099 break
1100 ;;
1101 -*)
1102 usage
1103 ;;
1104 *)
1105 break
1106 ;;
1107 esac
1108 shift
1109 done
1110 git submodule--helper list --prefix "$wt_prefix" "$@" |
1112 while read mode sha1 stage sm_path
1113 do
1114 die_if_unmatched "$mode"
1115 name=$(git submodule--helper name "$sm_path") || exit
1116 url=$(git config submodule."$name".url)
1117 displaypath=$(relative_path "$prefix$sm_path")
1118 if test "$stage" = U
1119 then
1120 say "U$sha1 $displaypath"
1121 continue
1122 fi
1123 if test -z "$url" ||
1124 {
1125 ! test -d "$sm_path"/.git &&
1126 ! test -f "$sm_path"/.git
1127 }
1128 then
1129 say "-$sha1 $displaypath"
1130 continue;
1131 fi
1132 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1133 then
1134 set_name_rev "$sm_path" "$sha1"
1135 say " $sha1 $displaypath$revname"
1136 else
1137 if test -z "$cached"
1138 then
1139 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1140 fi
1141 set_name_rev "$sm_path" "$sha1"
1142 say "+$sha1 $displaypath$revname"
1143 fi
1144 if test -n "$recursive"
1146 then
1147 (
1148 prefix="$displaypath/"
1149 clear_local_git_env
1150 cd "$sm_path" &&
1151 eval cmd_status
1152 ) ||
1153 die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1154 fi
1155 done
1156}
1157#
1158# Sync remote urls for submodules
1159# This makes the value for remote.$remote.url match the value
1160# specified in .gitmodules.
1161#
1162cmd_sync()
1163{
1164 while test $# -ne 0
1165 do
1166 case "$1" in
1167 -q|--quiet)
1168 GIT_QUIET=1
1169 shift
1170 ;;
1171 --recursive)
1172 recursive=1
1173 shift
1174 ;;
1175 --)
1176 shift
1177 break
1178 ;;
1179 -*)
1180 usage
1181 ;;
1182 *)
1183 break
1184 ;;
1185 esac
1186 done
1187 cd_to_toplevel
1188 git submodule--helper list --prefix "$wt_prefix" "$@" |
1189 while read mode sha1 stage sm_path
1190 do
1191 die_if_unmatched "$mode"
1192 name=$(git submodule--helper name "$sm_path")
1193 url=$(git config -f .gitmodules --get submodule."$name".url)
1194 # Possibly a url relative to parent
1196 case "$url" in
1197 ./*|../*)
1198 # rewrite foo/bar as ../.. to find path from
1199 # submodule work tree to superproject work tree
1200 up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1201 # guarantee a trailing /
1202 up_path=${up_path%/}/ &&
1203 # path from submodule work tree to submodule origin repo
1204 sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1205 # path from superproject work tree to submodule origin repo
1206 super_config_url=$(resolve_relative_url "$url") || exit
1207 ;;
1208 *)
1209 sub_origin_url="$url"
1210 super_config_url="$url"
1211 ;;
1212 esac
1213 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1215 then
1216 displaypath=$(relative_path "$prefix$sm_path")
1217 say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1218 git config submodule."$name".url "$super_config_url"
1219 if test -e "$sm_path"/.git
1221 then
1222 (
1223 clear_local_git_env
1224 cd "$sm_path"
1225 remote=$(get_default_remote)
1226 git config remote."$remote".url "$sub_origin_url"
1227 if test -n "$recursive"
1229 then
1230 prefix="$prefix$sm_path/"
1231 eval cmd_sync
1232 fi
1233 )
1234 fi
1235 fi
1236 done
1237}
1238# This loop parses the command line arguments to find the
1240# subcommand name to dispatch. Parsing of the subcommand specific
1241# options are primarily done by the subcommand implementations.
1242# Subcommand specific options such as --branch and --cached are
1243# parsed here as well, for backward compatibility.
1244while test $# != 0 && test -z "$command"
1246do
1247 case "$1" in
1248 add | foreach | init | deinit | update | status | summary | sync)
1249 command=$1
1250 ;;
1251 -q|--quiet)
1252 GIT_QUIET=1
1253 ;;
1254 -b|--branch)
1255 case "$2" in
1256 '')
1257 usage
1258 ;;
1259 esac
1260 branch="$2"; shift
1261 ;;
1262 --cached)
1263 cached="$1"
1264 ;;
1265 --)
1266 break
1267 ;;
1268 -*)
1269 usage
1270 ;;
1271 *)
1272 break
1273 ;;
1274 esac
1275 shift
1276done
1277# No command word defaults to "status"
1279if test -z "$command"
1280then
1281 if test $# = 0
1282 then
1283 command=status
1284 else
1285 usage
1286 fi
1287fi
1288# "-b branch" is accepted only by "add"
1290if test -n "$branch" && test "$command" != add
1291then
1292 usage
1293fi
1294# "--cached" is accepted only by "status" and "summary"
1296if test -n "$cached" && test "$command" != status && test "$command" != summary
1297then
1298 usage
1299fi
1300"cmd_$command" "$@"