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