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