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