Merge branch 'ar/submodule-add-config'
[git/debian.git] / git-submodule.sh
blob8c219ef382f08d949063896a5e8b678e8e1568f5
1 #!/bin/sh
3 # git-submodule.sh: add, init, update or list git submodules
5 # Copyright (c) 2007 Lars Hjemli
7 dashless=$(basename "$0" | sed -e 's/-/ /')
8 USAGE="[--quiet] [--cached]
9 or: $dashless [--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
10 or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
11 or: $dashless [--quiet] init [--] [<path>...]
12 or: $dashless [--quiet] deinit [-f|--force] (--all| [--] <path>...)
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>...]
14 or: $dashless [--quiet] set-branch (--default|--branch <branch>) [--] <path>
15 or: $dashless [--quiet] set-url [--] <path> <newurl>
16 or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
17 or: $dashless [--quiet] foreach [--recursive] <command>
18 or: $dashless [--quiet] sync [--recursive] [--] [<path>...]
19 or: $dashless [--quiet] absorbgitdirs [--] [<path>...]"
20 OPTIONS_SPEC=
21 SUBDIRECTORY_OK=Yes
22 . git-sh-setup
23 require_work_tree
24 wt_prefix=$(git rev-parse --show-prefix)
25 cd_to_toplevel
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
32 command=
33 branch=
34 force=
35 reference=
36 cached=
37 recursive=
38 init=
39 require_init=
40 files=
41 remote=
42 nofetch=
43 update=
44 prefix=
45 custom_name=
46 depth=
47 progress=
48 dissociate=
49 single_branch=
50 jobs=
51 recommend_shallow=
53 die_if_unmatched ()
55 if test "$1" = "#unmatched"
56 then
57 exit ${2:-1}
61 isnumber()
63 n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
66 # Given a full hex object ID, is this the zero OID?
67 is_zero_oid () {
68 echo "$1" | sane_egrep '^0+$' >/dev/null 2>&1
71 # Sanitize the local git environment for use within a submodule. We
72 # can't simply use clear_local_git_env since we want to preserve some
73 # of the settings from GIT_CONFIG_PARAMETERS.
74 sanitize_submodule_env()
76 save_config=$GIT_CONFIG_PARAMETERS
77 clear_local_git_env
78 GIT_CONFIG_PARAMETERS=$save_config
79 export GIT_CONFIG_PARAMETERS
83 # Add a new submodule to the working tree, .gitmodules and the index
85 # $@ = repo path
87 # optional branch is stored in global branch variable
89 cmd_add()
91 # parse $args after "submodule ... add".
92 reference_path=
93 while test $# -ne 0
95 case "$1" in
96 -b | --branch)
97 case "$2" in '') usage ;; esac
98 branch=$2
99 shift
101 -f | --force)
102 force=$1
104 -q|--quiet)
105 GIT_QUIET=1
107 --progress)
108 progress=1
110 --reference)
111 case "$2" in '') usage ;; esac
112 reference_path=$2
113 shift
115 --reference=*)
116 reference_path="${1#--reference=}"
118 --dissociate)
119 dissociate=1
121 --name)
122 case "$2" in '') usage ;; esac
123 custom_name=$2
124 shift
126 --depth)
127 case "$2" in '') usage ;; esac
128 depth="--depth=$2"
129 shift
131 --depth=*)
132 depth=$1
135 shift
136 break
139 usage
142 break
144 esac
145 shift
146 done
148 if ! git submodule--helper config --check-writeable >/dev/null 2>&1
149 then
150 die "fatal: $(eval_gettext "please make sure that the .gitmodules file is in the working tree")"
153 if test -n "$reference_path"
154 then
155 is_absolute_path "$reference_path" ||
156 reference_path="$wt_prefix$reference_path"
158 reference="--reference=$reference_path"
161 repo=$1
162 sm_path=$2
164 if test -z "$sm_path"; then
165 sm_path=$(printf '%s\n' "$repo" |
166 sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
169 if test -z "$repo" || test -z "$sm_path"; then
170 usage
173 is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
175 # assure repo is absolute or relative to parent
176 case "$repo" in
177 ./*|../*)
178 test -z "$wt_prefix" ||
179 die "fatal: $(gettext "Relative path can only be used from the toplevel of the working tree")"
181 # dereference source url relative to parent's url
182 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
184 *:*|/*)
185 # absolute url
186 realrepo=$repo
189 die "fatal: $(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
191 esac
193 # normalize path:
194 # multiple //; leading ./; /./; /../; trailing /
195 sm_path=$(printf '%s/\n' "$sm_path" |
196 sed -e '
197 s|//*|/|g
198 s|^\(\./\)*||
199 s|/\(\./\)*|/|g
200 :start
201 s|\([^/]*\)/\.\./||
202 tstart
203 s|/*$||
205 if test -z "$force"
206 then
207 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
208 die "fatal: $(eval_gettext "'\$sm_path' already exists in the index")"
209 else
210 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
211 die "fatal: $(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
214 if test -d "$sm_path" &&
215 test -z $(git -C "$sm_path" rev-parse --show-cdup 2>/dev/null)
216 then
217 git -C "$sm_path" rev-parse --verify -q HEAD >/dev/null ||
218 die "fatal: $(eval_gettext "'\$sm_path' does not have a commit checked out")"
221 if test -z "$force"
222 then
223 dryerr=$(git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" 2>&1 >/dev/null)
224 res=$?
225 if test $res -ne 0
226 then
227 echo >&2 "$dryerr"
228 exit $res
232 if test -n "$custom_name"
233 then
234 sm_name="$custom_name"
235 else
236 sm_name="$sm_path"
239 if ! git submodule--helper check-name "$sm_name"
240 then
241 die "fatal: $(eval_gettext "'$sm_name' is not a valid submodule name")"
244 git submodule--helper add-clone ${GIT_QUIET:+--quiet} ${force:+"--force"} ${progress:+"--progress"} ${branch:+--branch "$branch"} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${dissociate:+"--dissociate"} ${depth:+"$depth"} || exit
245 git submodule--helper add-config ${force:+--force} ${branch:+--branch "$branch"} --url "$repo" --resolved-url "$realrepo" --path "$sm_path" --name "$sm_name"
249 # Execute an arbitrary command sequence in each checked out
250 # submodule
252 # $@ = command to execute
254 cmd_foreach()
256 # parse $args after "submodule ... foreach".
257 while test $# -ne 0
259 case "$1" in
260 -q|--quiet)
261 GIT_QUIET=1
263 --recursive)
264 recursive=1
267 usage
270 break
272 esac
273 shift
274 done
276 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
280 # Register submodules in .git/config
282 # $@ = requested paths (default to all)
284 cmd_init()
286 # parse $args after "submodule ... init".
287 while test $# -ne 0
289 case "$1" in
290 -q|--quiet)
291 GIT_QUIET=1
294 shift
295 break
298 usage
301 break
303 esac
304 shift
305 done
307 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} -- "$@"
311 # Unregister submodules from .git/config and remove their work tree
313 cmd_deinit()
315 # parse $args after "submodule ... deinit".
316 deinit_all=
317 while test $# -ne 0
319 case "$1" in
320 -f|--force)
321 force=$1
323 -q|--quiet)
324 GIT_QUIET=1
326 --all)
327 deinit_all=t
330 shift
331 break
334 usage
337 break
339 esac
340 shift
341 done
343 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${force:+--force} ${deinit_all:+--all} -- "$@"
346 is_tip_reachable () (
347 sanitize_submodule_env &&
348 cd "$1" &&
349 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
350 test -z "$rev"
353 # usage: fetch_in_submodule <module_path> [<depth>] [<sha1>]
354 # Because arguments are positional, use an empty string to omit <depth>
355 # but include <sha1>.
356 fetch_in_submodule () (
357 sanitize_submodule_env &&
358 cd "$1" &&
359 if test $# -eq 3
360 then
361 echo "$3" | git fetch ${GIT_QUIET:+--quiet} --stdin ${2:+"$2"}
362 else
363 git fetch ${GIT_QUIET:+--quiet} ${2:+"$2"}
368 # Update each submodule path to correct revision, using clone and checkout as needed
370 # $@ = requested paths (default to all)
372 cmd_update()
374 # parse $args after "submodule ... update".
375 while test $# -ne 0
377 case "$1" in
378 -q|--quiet)
379 GIT_QUIET=1
382 unset GIT_QUIET
384 --progress)
385 progress=1
387 -i|--init)
388 init=1
390 --require-init)
391 init=1
392 require_init=1
394 --remote)
395 remote=1
397 -N|--no-fetch)
398 nofetch=1
400 -f|--force)
401 force=$1
403 -r|--rebase)
404 update="rebase"
406 --reference)
407 case "$2" in '') usage ;; esac
408 reference="--reference=$2"
409 shift
411 --reference=*)
412 reference="$1"
414 --dissociate)
415 dissociate=1
417 -m|--merge)
418 update="merge"
420 --recursive)
421 recursive=1
423 --checkout)
424 update="checkout"
426 --recommend-shallow)
427 recommend_shallow="--recommend-shallow"
429 --no-recommend-shallow)
430 recommend_shallow="--no-recommend-shallow"
432 --depth)
433 case "$2" in '') usage ;; esac
434 depth="--depth=$2"
435 shift
437 --depth=*)
438 depth=$1
440 -j|--jobs)
441 case "$2" in '') usage ;; esac
442 jobs="--jobs=$2"
443 shift
445 --jobs=*)
446 jobs=$1
448 --single-branch)
449 single_branch="--single-branch"
451 --no-single-branch)
452 single_branch="--no-single-branch"
455 shift
456 break
459 usage
462 break
464 esac
465 shift
466 done
468 if test -n "$init"
469 then
470 cmd_init "--" "$@" || return
474 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
475 ${progress:+"--progress"} \
476 ${wt_prefix:+--prefix "$wt_prefix"} \
477 ${prefix:+--recursive-prefix "$prefix"} \
478 ${update:+--update "$update"} \
479 ${reference:+"$reference"} \
480 ${dissociate:+"--dissociate"} \
481 ${depth:+--depth "$depth"} \
482 ${require_init:+--require-init} \
483 $single_branch \
484 $recommend_shallow \
485 $jobs \
486 -- \
487 "$@" || echo "#unmatched" $?
488 } | {
489 err=
490 while read -r quickabort sha1 just_cloned sm_path
492 die_if_unmatched "$quickabort" "$sha1"
494 git submodule--helper ensure-core-worktree "$sm_path" || exit 1
496 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
498 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
500 if test $just_cloned -eq 1
501 then
502 subsha1=
503 else
504 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
505 git rev-parse --verify HEAD) ||
506 die "fatal: $(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
509 if test -n "$remote"
510 then
511 branch=$(git submodule--helper remote-branch "$sm_path")
512 if test -z "$nofetch"
513 then
514 # Fetch remote before determining tracking $sha1
515 fetch_in_submodule "$sm_path" $depth ||
516 die "fatal: $(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
518 remote_name=$(sanitize_submodule_env; cd "$sm_path" && git submodule--helper print-default-remote)
519 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
520 git rev-parse --verify "${remote_name}/${branch}") ||
521 die "fatal: $(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
524 if test "$subsha1" != "$sha1" || test -n "$force"
525 then
526 subforce=$force
527 # If we don't already have a -f flag and the submodule has never been checked out
528 if test -z "$subsha1" && test -z "$force"
529 then
530 subforce="-f"
533 if test -z "$nofetch"
534 then
535 # Run fetch only if $sha1 isn't present or it
536 # is not reachable from a ref.
537 is_tip_reachable "$sm_path" "$sha1" ||
538 fetch_in_submodule "$sm_path" $depth ||
539 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'; trying to directly fetch \$sha1:")"
541 # Now we tried the usual fetch, but $sha1 may
542 # not be reachable from any of the refs
543 is_tip_reachable "$sm_path" "$sha1" ||
544 fetch_in_submodule "$sm_path" "$depth" "$sha1" ||
545 die "fatal: $(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
548 must_die_on_failure=
549 case "$update_module" in
550 checkout)
551 command="git checkout $subforce -q"
552 die_msg="fatal: $(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
553 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
555 rebase)
556 command="git rebase ${GIT_QUIET:+--quiet}"
557 die_msg="fatal: $(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
558 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
559 must_die_on_failure=yes
561 merge)
562 command="git merge ${GIT_QUIET:+--quiet}"
563 die_msg="fatal: $(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
564 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
565 must_die_on_failure=yes
568 command="${update_module#!}"
569 die_msg="fatal: $(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
570 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
571 must_die_on_failure=yes
574 die "fatal: $(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
575 esac
577 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
578 then
579 say "$say_msg"
580 elif test -n "$must_die_on_failure"
581 then
582 die_with_status 2 "$die_msg"
583 else
584 err="${err};$die_msg"
585 continue
589 if test -n "$recursive"
590 then
592 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
593 wt_prefix=
594 sanitize_submodule_env
595 cd "$sm_path" &&
596 eval cmd_update
598 res=$?
599 if test $res -gt 0
600 then
601 die_msg="fatal: $(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
602 if test $res -ne 2
603 then
604 err="${err};$die_msg"
605 continue
606 else
607 die_with_status $res "$die_msg"
611 done
613 if test -n "$err"
614 then
615 OIFS=$IFS
616 IFS=';'
617 for e in $err
619 if test -n "$e"
620 then
621 echo >&2 "$e"
623 done
624 IFS=$OIFS
625 exit 1
631 # Configures a submodule's default branch
633 # $@ = requested path
635 cmd_set_branch() {
636 default=
637 branch=
639 while test $# -ne 0
641 case "$1" in
642 -q|--quiet)
643 # we don't do anything with this but we need to accept it
645 -d|--default)
646 default=1
648 -b|--branch)
649 case "$2" in '') usage ;; esac
650 branch=$2
651 shift
654 shift
655 break
658 usage
661 break
663 esac
664 shift
665 done
667 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper set-branch ${GIT_QUIET:+--quiet} ${branch:+--branch "$branch"} ${default:+--default} -- "$@"
671 # Configures a submodule's remote url
673 # $@ = requested path, requested url
675 cmd_set_url() {
676 while test $# -ne 0
678 case "$1" in
679 -q|--quiet)
680 GIT_QUIET=1
683 shift
684 break
687 usage
690 break
692 esac
693 shift
694 done
696 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper set-url ${GIT_QUIET:+--quiet} -- "$@"
700 # Show commit summary for submodules in index or working tree
702 # If '--cached' is given, show summary between index and given commit,
703 # or between working tree and given commit
705 # $@ = [commit (default 'HEAD'),] requested paths (default all)
707 cmd_summary() {
708 summary_limit=-1
709 for_status=
710 diff_cmd=diff-index
712 # parse $args after "submodule ... summary".
713 while test $# -ne 0
715 case "$1" in
716 --cached)
717 cached="$1"
719 --files)
720 files="$1"
722 --for-status)
723 for_status="$1"
725 -n|--summary-limit)
726 summary_limit="$2"
727 isnumber "$summary_limit" || usage
728 shift
730 --summary-limit=*)
731 summary_limit="${1#--summary-limit=}"
732 isnumber "$summary_limit" || usage
735 shift
736 break
739 usage
742 break
744 esac
745 shift
746 done
748 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper summary ${files:+--files} ${cached:+--cached} ${for_status:+--for-status} ${summary_limit:+-n $summary_limit} -- "$@"
751 # List all submodules, prefixed with:
752 # - submodule not initialized
753 # + different revision checked out
755 # If --cached was specified the revision in the index will be printed
756 # instead of the currently checked out revision.
758 # $@ = requested paths (default to all)
760 cmd_status()
762 # parse $args after "submodule ... status".
763 while test $# -ne 0
765 case "$1" in
766 -q|--quiet)
767 GIT_QUIET=1
769 --cached)
770 cached=1
772 --recursive)
773 recursive=1
776 shift
777 break
780 usage
783 break
785 esac
786 shift
787 done
789 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@"
792 # Sync remote urls for submodules
793 # This makes the value for remote.$remote.url match the value
794 # specified in .gitmodules.
796 cmd_sync()
798 while test $# -ne 0
800 case "$1" in
801 -q|--quiet)
802 GIT_QUIET=1
803 shift
805 --recursive)
806 recursive=1
807 shift
810 shift
811 break
814 usage
817 break
819 esac
820 done
822 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
825 cmd_absorbgitdirs()
827 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
830 # This loop parses the command line arguments to find the
831 # subcommand name to dispatch. Parsing of the subcommand specific
832 # options are primarily done by the subcommand implementations.
833 # Subcommand specific options such as --branch and --cached are
834 # parsed here as well, for backward compatibility.
836 while test $# != 0 && test -z "$command"
838 case "$1" in
839 add | foreach | init | deinit | update | set-branch | set-url | status | summary | sync | absorbgitdirs)
840 command=$1
842 -q|--quiet)
843 GIT_QUIET=1
845 -b|--branch)
846 case "$2" in
848 usage
850 esac
851 branch="$2"; shift
853 --cached)
854 cached="$1"
857 break
860 usage
863 break
865 esac
866 shift
867 done
869 # No command word defaults to "status"
870 if test -z "$command"
871 then
872 if test $# = 0
873 then
874 command=status
875 else
876 usage
880 # "-b branch" is accepted only by "add" and "set-branch"
881 if test -n "$branch" && (test "$command" != add || test "$command" != set-branch)
882 then
883 usage
886 # "--cached" is accepted only by "status" and "summary"
887 if test -n "$cached" && test "$command" != status && test "$command" != summary
888 then
889 usage
892 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"