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