]>
Commit | Line | Data |
---|---|---|
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 | 7 | dashless=$(basename "$0" | sed -e 's/-/ /') |
68cabbfd DL |
8 | USAGE="[--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>...) |
f05da2b4 | 13 | or: $dashless [--quiet] update [--init [--filter=<filter-spec>]] [--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 | 20 | OPTIONS_SPEC= |
091a6eb0 | 21 | SUBDIRECTORY_OK=Yes |
70c7ac22 LH |
22 | . git-sh-setup |
23 | require_work_tree | |
091a6eb0 JK |
24 | wt_prefix=$(git rev-parse --show-prefix) |
25 | cd_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. | |
29 | GIT_PROTOCOL_FROM_USER=0 | |
30 | export GIT_PROTOCOL_FROM_USER | |
33cfccbb | 31 | |
5c08dbbd | 32 | command= |
2eec4637 | 33 | quiet= |
ecda0723 | 34 | branch= |
d27b876b | 35 | force= |
d92a3959 | 36 | reference= |
70c7ac22 | 37 | cached= |
48bb3033 GP |
38 | recursive= |
39 | init= | |
0060fd15 | 40 | require_init= |
1c244f6e | 41 | files= |
06b1abb5 | 42 | remote= |
31ca3ac3 | 43 | nofetch= |
8f12108c ÆAB |
44 | rebase= |
45 | merge= | |
46 | checkout= | |
73b0898d | 47 | custom_name= |
275cd184 | 48 | depth= |
72c5f883 | 49 | progress= |
a0ef2934 | 50 | dissociate= |
132f600b | 51 | single_branch= |
65d100c4 LX |
52 | jobs= |
53 | recommend_shallow= | |
f05da2b4 | 54 | filter= |
70c7ac22 | 55 | |
862ae6cd RS |
56 | isnumber() |
57 | { | |
58 | n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1" | |
59 | } | |
60 | ||
ecda0723 SV |
61 | # |
62 | # Add a new submodule to the working tree, .gitmodules and the index | |
63 | # | |
ec05df35 | 64 | # $@ = repo path |
ecda0723 SV |
65 | # |
66 | # optional branch is stored in global branch variable | |
67 | # | |
23a485e3 | 68 | cmd_add() |
ecda0723 | 69 | { |
5c08dbbd | 70 | # parse $args after "submodule ... add". |
091a6eb0 | 71 | reference_path= |
5c08dbbd JH |
72 | while test $# -ne 0 |
73 | do | |
74 | case "$1" in | |
75 | -b | --branch) | |
76 | case "$2" in '') usage ;; esac | |
77 | branch=$2 | |
78 | shift | |
79 | ;; | |
d27b876b JL |
80 | -f | --force) |
81 | force=$1 | |
82 | ;; | |
5c08dbbd | 83 | -q|--quiet) |
2eec4637 | 84 | quiet=1 |
5c08dbbd | 85 | ;; |
6d33e1c2 CF |
86 | --progress) |
87 | progress=1 | |
88 | ;; | |
d92a3959 MT |
89 | --reference) |
90 | case "$2" in '') usage ;; esac | |
091a6eb0 | 91 | reference_path=$2 |
d92a3959 MT |
92 | shift |
93 | ;; | |
94 | --reference=*) | |
091a6eb0 | 95 | reference_path="${1#--reference=}" |
d92a3959 | 96 | ;; |
a0ef2934 CF |
97 | --dissociate) |
98 | dissociate=1 | |
99 | ;; | |
73b0898d JL |
100 | --name) |
101 | case "$2" in '') usage ;; esac | |
102 | custom_name=$2 | |
103 | shift | |
104 | ;; | |
275cd184 FG |
105 | --depth) |
106 | case "$2" in '') usage ;; esac | |
107 | depth="--depth=$2" | |
108 | shift | |
109 | ;; | |
110 | --depth=*) | |
111 | depth=$1 | |
112 | ;; | |
5c08dbbd JH |
113 | --) |
114 | shift | |
115 | break | |
116 | ;; | |
117 | -*) | |
118 | usage | |
119 | ;; | |
120 | *) | |
121 | break | |
122 | ;; | |
123 | esac | |
124 | shift | |
125 | done | |
126 | ||
a6226fd7 | 127 | if test -z "$1" |
76e9bdc4 | 128 | then |
ecda0723 SV |
129 | usage |
130 | fi | |
131 | ||
2eec4637 | 132 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper add ${quiet:+--quiet} ${force:+--force} ${progress:+"--progress"} ${branch:+--branch "$branch"} ${reference_path:+--reference "$reference_path"} ${dissociate:+--dissociate} ${custom_name:+--name "$custom_name"} ${depth:+"$depth"} -- "$@" |
ecda0723 SV |
133 | } |
134 | ||
19a31f9c ML |
135 | # |
136 | # Execute an arbitrary command sequence in each checked out | |
137 | # submodule | |
138 | # | |
139 | # $@ = command to execute | |
140 | # | |
141 | cmd_foreach() | |
142 | { | |
1d5bec8b JH |
143 | # parse $args after "submodule ... foreach". |
144 | while test $# -ne 0 | |
145 | do | |
146 | case "$1" in | |
147 | -q|--quiet) | |
2eec4637 | 148 | quiet=1 |
1d5bec8b | 149 | ;; |
15fc56a8 JH |
150 | --recursive) |
151 | recursive=1 | |
152 | ;; | |
1d5bec8b JH |
153 | -*) |
154 | usage | |
155 | ;; | |
156 | *) | |
157 | break | |
158 | ;; | |
159 | esac | |
160 | shift | |
161 | done | |
162 | ||
2eec4637 | 163 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper foreach ${quiet:+--quiet} ${recursive:+--recursive} -- "$@" |
19a31f9c ML |
164 | } |
165 | ||
70c7ac22 | 166 | # |
211b7f19 | 167 | # Register submodules in .git/config |
70c7ac22 LH |
168 | # |
169 | # $@ = requested paths (default to all) | |
170 | # | |
23a485e3 | 171 | cmd_init() |
70c7ac22 | 172 | { |
5c08dbbd JH |
173 | # parse $args after "submodule ... init". |
174 | while test $# -ne 0 | |
175 | do | |
176 | case "$1" in | |
177 | -q|--quiet) | |
2eec4637 | 178 | quiet=1 |
5c08dbbd JH |
179 | ;; |
180 | --) | |
181 | shift | |
182 | break | |
183 | ;; | |
184 | -*) | |
185 | usage | |
186 | ;; | |
187 | *) | |
188 | break | |
189 | ;; | |
190 | esac | |
191 | shift | |
192 | done | |
193 | ||
2eec4637 | 194 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper init ${quiet:+--quiet} -- "$@" |
70c7ac22 LH |
195 | } |
196 | ||
cf419828 JL |
197 | # |
198 | # Unregister submodules from .git/config and remove their work tree | |
199 | # | |
cf419828 JL |
200 | cmd_deinit() |
201 | { | |
202 | # parse $args after "submodule ... deinit". | |
f6a52799 | 203 | deinit_all= |
cf419828 JL |
204 | while test $# -ne 0 |
205 | do | |
206 | case "$1" in | |
207 | -f|--force) | |
208 | force=$1 | |
209 | ;; | |
210 | -q|--quiet) | |
2eec4637 | 211 | quiet=1 |
cf419828 | 212 | ;; |
f6a52799 SB |
213 | --all) |
214 | deinit_all=t | |
215 | ;; | |
cf419828 JL |
216 | --) |
217 | shift | |
218 | break | |
219 | ;; | |
220 | -*) | |
221 | usage | |
222 | ;; | |
223 | *) | |
224 | break | |
225 | ;; | |
226 | esac | |
227 | shift | |
228 | done | |
229 | ||
2eec4637 | 230 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${quiet:+--quiet} ${force:+--force} ${deinit_all:+--all} -- "$@" |
cf419828 JL |
231 | } |
232 | ||
70c7ac22 | 233 | # |
211b7f19 | 234 | # Update each submodule path to correct revision, using clone and checkout as needed |
70c7ac22 LH |
235 | # |
236 | # $@ = requested paths (default to all) | |
237 | # | |
23a485e3 | 238 | cmd_update() |
70c7ac22 | 239 | { |
5c08dbbd JH |
240 | # parse $args after "submodule ... update". |
241 | while test $# -ne 0 | |
242 | do | |
243 | case "$1" in | |
244 | -q|--quiet) | |
2eec4637 | 245 | quiet=1 |
5c08dbbd | 246 | ;; |
6f65f847 SS |
247 | -v|--verbose) |
248 | quiet=0 | |
249 | ;; | |
72c5f883 | 250 | --progress) |
c7199e3a | 251 | progress=1 |
72c5f883 | 252 | ;; |
be4d2c83 | 253 | -i|--init) |
d92a3959 | 254 | init=1 |
be4d2c83 | 255 | ;; |
0060fd15 | 256 | --require-init) |
0060fd15 JS |
257 | require_init=1 |
258 | ;; | |
06b1abb5 TK |
259 | --remote) |
260 | remote=1 | |
261 | ;; | |
31ca3ac3 | 262 | -N|--no-fetch) |
31ca3ac3 FF |
263 | nofetch=1 |
264 | ;; | |
9db31bdf NMC |
265 | -f|--force) |
266 | force=$1 | |
267 | ;; | |
ca2cedba | 268 | -r|--rebase) |
8f12108c | 269 | rebase=1 |
ca2cedba | 270 | ;; |
d92a3959 MT |
271 | --reference) |
272 | case "$2" in '') usage ;; esac | |
273 | reference="--reference=$2" | |
98dbe63d | 274 | shift |
d92a3959 MT |
275 | ;; |
276 | --reference=*) | |
277 | reference="$1" | |
d92a3959 | 278 | ;; |
a0ef2934 CF |
279 | --dissociate) |
280 | dissociate=1 | |
281 | ;; | |
42b49178 | 282 | -m|--merge) |
8f12108c | 283 | merge=1 |
42b49178 | 284 | ;; |
b13fd5c1 | 285 | --recursive) |
b13fd5c1 JH |
286 | recursive=1 |
287 | ;; | |
efc5fb6a | 288 | --checkout) |
8f12108c | 289 | checkout=1 |
efc5fb6a | 290 | ;; |
abed000a SB |
291 | --recommend-shallow) |
292 | recommend_shallow="--recommend-shallow" | |
293 | ;; | |
294 | --no-recommend-shallow) | |
295 | recommend_shallow="--no-recommend-shallow" | |
296 | ;; | |
275cd184 FG |
297 | --depth) |
298 | case "$2" in '') usage ;; esac | |
299 | depth="--depth=$2" | |
300 | shift | |
301 | ;; | |
302 | --depth=*) | |
303 | depth=$1 | |
304 | ;; | |
2335b870 SB |
305 | -j|--jobs) |
306 | case "$2" in '') usage ;; esac | |
307 | jobs="--jobs=$2" | |
308 | shift | |
309 | ;; | |
310 | --jobs=*) | |
311 | jobs=$1 | |
312 | ;; | |
132f600b ES |
313 | --single-branch) |
314 | single_branch="--single-branch" | |
315 | ;; | |
316 | --no-single-branch) | |
317 | single_branch="--no-single-branch" | |
318 | ;; | |
f05da2b4 JS |
319 | --filter) |
320 | case "$2" in '') usage ;; esac | |
321 | filter="--filter=$2" | |
322 | shift | |
323 | ;; | |
324 | --filter=*) | |
325 | filter="$1" | |
326 | ;; | |
5c08dbbd JH |
327 | --) |
328 | shift | |
329 | break | |
330 | ;; | |
331 | -*) | |
332 | usage | |
333 | ;; | |
334 | *) | |
335 | break | |
336 | ;; | |
337 | esac | |
98dbe63d | 338 | shift |
5c08dbbd JH |
339 | done |
340 | ||
b3c5f5cb | 341 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper update \ |
2eec4637 | 342 | ${quiet:+--quiet} \ |
b3c5f5cb | 343 | ${force:+--force} \ |
c7199e3a | 344 | ${progress:+"--progress"} \ |
b3c5f5cb AR |
345 | ${remote:+--remote} \ |
346 | ${recursive:+--recursive} \ | |
29a5e9e1 | 347 | ${init:+--init} \ |
b3c5f5cb | 348 | ${nofetch:+--no-fetch} \ |
8f12108c ÆAB |
349 | ${rebase:+--rebase} \ |
350 | ${merge:+--merge} \ | |
351 | ${checkout:+--checkout} \ | |
5f50f33e | 352 | ${reference:+"$reference"} \ |
a0ef2934 | 353 | ${dissociate:+"--dissociate"} \ |
c9911c93 | 354 | ${depth:+"$depth"} \ |
0060fd15 | 355 | ${require_init:+--require-init} \ |
b3c5f5cb | 356 | ${dissociate:+"--dissociate"} \ |
132f600b | 357 | $single_branch \ |
c7199e3a CF |
358 | $recommend_shallow \ |
359 | $jobs \ | |
f05da2b4 | 360 | $filter \ |
a282f5a9 | 361 | -- \ |
b3c5f5cb | 362 | "$@" |
70c7ac22 LH |
363 | } |
364 | ||
b57e8119 DL |
365 | # |
366 | # Configures a submodule's default branch | |
367 | # | |
368 | # $@ = requested path | |
369 | # | |
370 | cmd_set_branch() { | |
2964d6e5 | 371 | default= |
b57e8119 DL |
372 | branch= |
373 | ||
374 | while test $# -ne 0 | |
375 | do | |
376 | case "$1" in | |
377 | -q|--quiet) | |
378 | # we don't do anything with this but we need to accept it | |
379 | ;; | |
380 | -d|--default) | |
2964d6e5 | 381 | default=1 |
b57e8119 DL |
382 | ;; |
383 | -b|--branch) | |
384 | case "$2" in '') usage ;; esac | |
385 | branch=$2 | |
386 | shift | |
387 | ;; | |
388 | --) | |
389 | shift | |
390 | break | |
391 | ;; | |
392 | -*) | |
393 | usage | |
394 | ;; | |
395 | *) | |
396 | break | |
397 | ;; | |
398 | esac | |
399 | shift | |
400 | done | |
401 | ||
2eec4637 | 402 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper set-branch ${quiet:+--quiet} ${branch:+--branch "$branch"} ${default:+--default} -- "$@" |
b57e8119 DL |
403 | } |
404 | ||
26b06100 DL |
405 | # |
406 | # Configures a submodule's remote url | |
407 | # | |
408 | # $@ = requested path, requested url | |
409 | # | |
410 | cmd_set_url() { | |
411 | while test $# -ne 0 | |
412 | do | |
413 | case "$1" in | |
414 | -q|--quiet) | |
2eec4637 | 415 | quiet=1 |
26b06100 DL |
416 | ;; |
417 | --) | |
418 | shift | |
419 | break | |
420 | ;; | |
421 | -*) | |
422 | usage | |
423 | ;; | |
424 | *) | |
425 | break | |
426 | ;; | |
427 | esac | |
428 | shift | |
429 | done | |
430 | ||
2eec4637 | 431 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper set-url ${quiet:+--quiet} -- "$@" |
26b06100 DL |
432 | } |
433 | ||
28f9af5d PY |
434 | # |
435 | # Show commit summary for submodules in index or working tree | |
436 | # | |
437 | # If '--cached' is given, show summary between index and given commit, | |
438 | # or between working tree and given commit | |
439 | # | |
440 | # $@ = [commit (default 'HEAD'),] requested paths (default all) | |
441 | # | |
442 | cmd_summary() { | |
f2dc06a3 | 443 | summary_limit=-1 |
d0f64dd4 | 444 | for_status= |
1c244f6e | 445 | diff_cmd=diff-index |
f2dc06a3 | 446 | |
28f9af5d PY |
447 | # parse $args after "submodule ... summary". |
448 | while test $# -ne 0 | |
449 | do | |
450 | case "$1" in | |
451 | --cached) | |
757d0927 | 452 | cached=1 |
28f9af5d | 453 | ;; |
1c244f6e JL |
454 | --files) |
455 | files="$1" | |
456 | ;; | |
d0f64dd4 PY |
457 | --for-status) |
458 | for_status="$1" | |
459 | ;; | |
f2dc06a3 | 460 | -n|--summary-limit) |
862ae6cd RS |
461 | summary_limit="$2" |
462 | isnumber "$summary_limit" || usage | |
f2dc06a3 PY |
463 | shift |
464 | ;; | |
862ae6cd RS |
465 | --summary-limit=*) |
466 | summary_limit="${1#--summary-limit=}" | |
467 | isnumber "$summary_limit" || usage | |
468 | ;; | |
28f9af5d PY |
469 | --) |
470 | shift | |
471 | break | |
472 | ;; | |
473 | -*) | |
474 | usage | |
475 | ;; | |
476 | *) | |
477 | break | |
478 | ;; | |
479 | esac | |
480 | shift | |
481 | done | |
bffe71f4 | 482 | |
1cf823d8 | 483 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper summary ${files:+--files} ${cached:+--cached} ${for_status:+--for-status} ${summary_limit:+-n $summary_limit} -- "$@" |
28f9af5d | 484 | } |
70c7ac22 | 485 | # |
941987a5 | 486 | # List all submodules, prefixed with: |
70c7ac22 LH |
487 | # - submodule not initialized |
488 | # + different revision checked out | |
489 | # | |
490 | # If --cached was specified the revision in the index will be printed | |
491 | # instead of the currently checked out revision. | |
492 | # | |
493 | # $@ = requested paths (default to all) | |
494 | # | |
23a485e3 | 495 | cmd_status() |
70c7ac22 | 496 | { |
5c08dbbd JH |
497 | # parse $args after "submodule ... status". |
498 | while test $# -ne 0 | |
499 | do | |
500 | case "$1" in | |
501 | -q|--quiet) | |
2eec4637 | 502 | quiet=1 |
5c08dbbd JH |
503 | ;; |
504 | --cached) | |
505 | cached=1 | |
506 | ;; | |
64b19ffe JH |
507 | --recursive) |
508 | recursive=1 | |
509 | ;; | |
5c08dbbd JH |
510 | --) |
511 | shift | |
512 | break | |
513 | ;; | |
514 | -*) | |
515 | usage | |
516 | ;; | |
517 | *) | |
518 | break | |
519 | ;; | |
520 | esac | |
521 | shift | |
522 | done | |
523 | ||
2eec4637 | 524 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper status ${quiet:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@" |
70c7ac22 | 525 | } |
2327f61e DA |
526 | # |
527 | # Sync remote urls for submodules | |
528 | # This makes the value for remote.$remote.url match the value | |
529 | # specified in .gitmodules. | |
530 | # | |
531 | cmd_sync() | |
532 | { | |
533 | while test $# -ne 0 | |
534 | do | |
535 | case "$1" in | |
536 | -q|--quiet) | |
2eec4637 | 537 | quiet=1 |
2327f61e DA |
538 | shift |
539 | ;; | |
82f49f29 PH |
540 | --recursive) |
541 | recursive=1 | |
542 | shift | |
543 | ;; | |
2327f61e DA |
544 | --) |
545 | shift | |
546 | break | |
547 | ;; | |
548 | -*) | |
549 | usage | |
550 | ;; | |
551 | *) | |
552 | break | |
553 | ;; | |
554 | esac | |
555 | done | |
e7849a96 | 556 | |
2eec4637 | 557 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper sync ${quiet:+--quiet} ${recursive:+--recursive} -- "$@" |
2327f61e | 558 | } |
70c7ac22 | 559 | |
f6f85861 SB |
560 | cmd_absorbgitdirs() |
561 | { | |
64f48ad1 | 562 | git ${wt_prefix:+-C "$wt_prefix"} submodule--helper absorbgitdirs "$@" |
f6f85861 SB |
563 | } |
564 | ||
5c08dbbd JH |
565 | # This loop parses the command line arguments to find the |
566 | # subcommand name to dispatch. Parsing of the subcommand specific | |
567 | # options are primarily done by the subcommand implementations. | |
568 | # Subcommand specific options such as --branch and --cached are | |
569 | # parsed here as well, for backward compatibility. | |
570 | ||
571 | while test $# != 0 && test -z "$command" | |
70c7ac22 LH |
572 | do |
573 | case "$1" in | |
26b06100 | 574 | add | foreach | init | deinit | update | set-branch | set-url | status | summary | sync | absorbgitdirs) |
5c08dbbd | 575 | command=$1 |
70c7ac22 LH |
576 | ;; |
577 | -q|--quiet) | |
2eec4637 | 578 | quiet=1 |
70c7ac22 LH |
579 | ;; |
580 | --cached) | |
757d0927 | 581 | cached=1 |
70c7ac22 LH |
582 | ;; |
583 | --) | |
584 | break | |
585 | ;; | |
586 | -*) | |
587 | usage | |
588 | ;; | |
589 | *) | |
590 | break | |
591 | ;; | |
592 | esac | |
593 | shift | |
594 | done | |
595 | ||
5c08dbbd | 596 | # No command word defaults to "status" |
af9c9f97 RR |
597 | if test -z "$command" |
598 | then | |
599 | if test $# = 0 | |
600 | then | |
601 | command=status | |
602 | else | |
603 | usage | |
604 | fi | |
605 | fi | |
5c08dbbd | 606 | |
28f9af5d | 607 | # "--cached" is accepted only by "status" and "summary" |
496eeeb1 | 608 | if test -n "$cached" && test "$command" != status && test "$command" != summary |
5c08dbbd | 609 | then |
70c7ac22 | 610 | usage |
5c08dbbd JH |
611 | fi |
612 | ||
b57e8119 | 613 | "cmd_$(echo $command | sed -e s/-/_/g)" "$@" |