Merge branch 'cb/ci-build-pedantic' into maint
[git.git] / git-submodule.sh
blobdbd2ec205037e062b6fb4ae52205bbf84e023001
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 config submodule."$sm_name".url "$realrepo"
247 git add --no-warn-embedded-repo $force "$sm_path" ||
248 die "fatal: $(eval_gettext "Failed to add submodule '\$sm_path'")"
250 git submodule--helper config submodule."$sm_name".path "$sm_path" &&
251 git submodule--helper config submodule."$sm_name".url "$repo" &&
252 if test -n "$branch"
253 then
254 git submodule--helper config submodule."$sm_name".branch "$branch"
255 fi &&
256 git add --force .gitmodules ||
257 die "fatal: $(eval_gettext "Failed to register submodule '\$sm_path'")"
259 # NEEDSWORK: In a multi-working-tree world, this needs to be
260 # set in the per-worktree config.
261 if git config --get submodule.active >/dev/null
262 then
263 # If the submodule being adding isn't already covered by the
264 # current configured pathspec, set the submodule's active flag
265 if ! git submodule--helper is-active "$sm_path"
266 then
267 git config submodule."$sm_name".active "true"
269 else
270 git config submodule."$sm_name".active "true"
275 # Execute an arbitrary command sequence in each checked out
276 # submodule
278 # $@ = command to execute
280 cmd_foreach()
282 # parse $args after "submodule ... foreach".
283 while test $# -ne 0
285 case "$1" in
286 -q|--quiet)
287 GIT_QUIET=1
289 --recursive)
290 recursive=1
293 usage
296 break
298 esac
299 shift
300 done
302 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
306 # Register submodules in .git/config
308 # $@ = requested paths (default to all)
310 cmd_init()
312 # parse $args after "submodule ... init".
313 while test $# -ne 0
315 case "$1" in
316 -q|--quiet)
317 GIT_QUIET=1
320 shift
321 break
324 usage
327 break
329 esac
330 shift
331 done
333 git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet} -- "$@"
337 # Unregister submodules from .git/config and remove their work tree
339 cmd_deinit()
341 # parse $args after "submodule ... deinit".
342 deinit_all=
343 while test $# -ne 0
345 case "$1" in
346 -f|--force)
347 force=$1
349 -q|--quiet)
350 GIT_QUIET=1
352 --all)
353 deinit_all=t
356 shift
357 break
360 usage
363 break
365 esac
366 shift
367 done
369 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${force:+--force} ${deinit_all:+--all} -- "$@"
372 is_tip_reachable () (
373 sanitize_submodule_env &&
374 cd "$1" &&
375 rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
376 test -z "$rev"
379 # usage: fetch_in_submodule <module_path> [<depth>] [<sha1>]
380 # Because arguments are positional, use an empty string to omit <depth>
381 # but include <sha1>.
382 fetch_in_submodule () (
383 sanitize_submodule_env &&
384 cd "$1" &&
385 if test $# -eq 3
386 then
387 echo "$3" | git fetch ${GIT_QUIET:+--quiet} --stdin ${2:+"$2"}
388 else
389 git fetch ${GIT_QUIET:+--quiet} ${2:+"$2"}
394 # Update each submodule path to correct revision, using clone and checkout as needed
396 # $@ = requested paths (default to all)
398 cmd_update()
400 # parse $args after "submodule ... update".
401 while test $# -ne 0
403 case "$1" in
404 -q|--quiet)
405 GIT_QUIET=1
408 unset GIT_QUIET
410 --progress)
411 progress=1
413 -i|--init)
414 init=1
416 --require-init)
417 init=1
418 require_init=1
420 --remote)
421 remote=1
423 -N|--no-fetch)
424 nofetch=1
426 -f|--force)
427 force=$1
429 -r|--rebase)
430 update="rebase"
432 --reference)
433 case "$2" in '') usage ;; esac
434 reference="--reference=$2"
435 shift
437 --reference=*)
438 reference="$1"
440 --dissociate)
441 dissociate=1
443 -m|--merge)
444 update="merge"
446 --recursive)
447 recursive=1
449 --checkout)
450 update="checkout"
452 --recommend-shallow)
453 recommend_shallow="--recommend-shallow"
455 --no-recommend-shallow)
456 recommend_shallow="--no-recommend-shallow"
458 --depth)
459 case "$2" in '') usage ;; esac
460 depth="--depth=$2"
461 shift
463 --depth=*)
464 depth=$1
466 -j|--jobs)
467 case "$2" in '') usage ;; esac
468 jobs="--jobs=$2"
469 shift
471 --jobs=*)
472 jobs=$1
474 --single-branch)
475 single_branch="--single-branch"
477 --no-single-branch)
478 single_branch="--no-single-branch"
481 shift
482 break
485 usage
488 break
490 esac
491 shift
492 done
494 if test -n "$init"
495 then
496 cmd_init "--" "$@" || return
500 git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
501 ${progress:+"--progress"} \
502 ${wt_prefix:+--prefix "$wt_prefix"} \
503 ${prefix:+--recursive-prefix "$prefix"} \
504 ${update:+--update "$update"} \
505 ${reference:+"$reference"} \
506 ${dissociate:+"--dissociate"} \
507 ${depth:+--depth "$depth"} \
508 ${require_init:+--require-init} \
509 $single_branch \
510 $recommend_shallow \
511 $jobs \
512 -- \
513 "$@" || echo "#unmatched" $?
514 } | {
515 err=
516 while read -r quickabort sha1 just_cloned sm_path
518 die_if_unmatched "$quickabort" "$sha1"
520 git submodule--helper ensure-core-worktree "$sm_path" || exit 1
522 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
524 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
526 if test $just_cloned -eq 1
527 then
528 subsha1=
529 else
530 subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
531 git rev-parse --verify HEAD) ||
532 die "fatal: $(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
535 if test -n "$remote"
536 then
537 branch=$(git submodule--helper remote-branch "$sm_path")
538 if test -z "$nofetch"
539 then
540 # Fetch remote before determining tracking $sha1
541 fetch_in_submodule "$sm_path" $depth ||
542 die "fatal: $(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
544 remote_name=$(sanitize_submodule_env; cd "$sm_path" && git submodule--helper print-default-remote)
545 sha1=$(sanitize_submodule_env; cd "$sm_path" &&
546 git rev-parse --verify "${remote_name}/${branch}") ||
547 die "fatal: $(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
550 if test "$subsha1" != "$sha1" || test -n "$force"
551 then
552 subforce=$force
553 # If we don't already have a -f flag and the submodule has never been checked out
554 if test -z "$subsha1" && test -z "$force"
555 then
556 subforce="-f"
559 if test -z "$nofetch"
560 then
561 # Run fetch only if $sha1 isn't present or it
562 # is not reachable from a ref.
563 is_tip_reachable "$sm_path" "$sha1" ||
564 fetch_in_submodule "$sm_path" $depth ||
565 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'; trying to directly fetch \$sha1:")"
567 # Now we tried the usual fetch, but $sha1 may
568 # not be reachable from any of the refs
569 is_tip_reachable "$sm_path" "$sha1" ||
570 fetch_in_submodule "$sm_path" "$depth" "$sha1" ||
571 die "fatal: $(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
574 must_die_on_failure=
575 case "$update_module" in
576 checkout)
577 command="git checkout $subforce -q"
578 die_msg="fatal: $(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
579 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
581 rebase)
582 command="git rebase ${GIT_QUIET:+--quiet}"
583 die_msg="fatal: $(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
584 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
585 must_die_on_failure=yes
587 merge)
588 command="git merge ${GIT_QUIET:+--quiet}"
589 die_msg="fatal: $(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
590 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
591 must_die_on_failure=yes
594 command="${update_module#!}"
595 die_msg="fatal: $(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
596 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
597 must_die_on_failure=yes
600 die "fatal: $(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
601 esac
603 if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
604 then
605 say "$say_msg"
606 elif test -n "$must_die_on_failure"
607 then
608 die_with_status 2 "$die_msg"
609 else
610 err="${err};$die_msg"
611 continue
615 if test -n "$recursive"
616 then
618 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
619 wt_prefix=
620 sanitize_submodule_env
621 cd "$sm_path" &&
622 eval cmd_update
624 res=$?
625 if test $res -gt 0
626 then
627 die_msg="fatal: $(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
628 if test $res -ne 2
629 then
630 err="${err};$die_msg"
631 continue
632 else
633 die_with_status $res "$die_msg"
637 done
639 if test -n "$err"
640 then
641 OIFS=$IFS
642 IFS=';'
643 for e in $err
645 if test -n "$e"
646 then
647 echo >&2 "$e"
649 done
650 IFS=$OIFS
651 exit 1
657 # Configures a submodule's default branch
659 # $@ = requested path
661 cmd_set_branch() {
662 default=
663 branch=
665 while test $# -ne 0
667 case "$1" in
668 -q|--quiet)
669 # we don't do anything with this but we need to accept it
671 -d|--default)
672 default=1
674 -b|--branch)
675 case "$2" in '') usage ;; esac
676 branch=$2
677 shift
680 shift
681 break
684 usage
687 break
689 esac
690 shift
691 done
693 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper set-branch ${GIT_QUIET:+--quiet} ${branch:+--branch "$branch"} ${default:+--default} -- "$@"
697 # Configures a submodule's remote url
699 # $@ = requested path, requested url
701 cmd_set_url() {
702 while test $# -ne 0
704 case "$1" in
705 -q|--quiet)
706 GIT_QUIET=1
709 shift
710 break
713 usage
716 break
718 esac
719 shift
720 done
722 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper set-url ${GIT_QUIET:+--quiet} -- "$@"
726 # Show commit summary for submodules in index or working tree
728 # If '--cached' is given, show summary between index and given commit,
729 # or between working tree and given commit
731 # $@ = [commit (default 'HEAD'),] requested paths (default all)
733 cmd_summary() {
734 summary_limit=-1
735 for_status=
736 diff_cmd=diff-index
738 # parse $args after "submodule ... summary".
739 while test $# -ne 0
741 case "$1" in
742 --cached)
743 cached="$1"
745 --files)
746 files="$1"
748 --for-status)
749 for_status="$1"
751 -n|--summary-limit)
752 summary_limit="$2"
753 isnumber "$summary_limit" || usage
754 shift
756 --summary-limit=*)
757 summary_limit="${1#--summary-limit=}"
758 isnumber "$summary_limit" || usage
761 shift
762 break
765 usage
768 break
770 esac
771 shift
772 done
774 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper summary ${files:+--files} ${cached:+--cached} ${for_status:+--for-status} ${summary_limit:+-n $summary_limit} -- "$@"
777 # List all submodules, prefixed with:
778 # - submodule not initialized
779 # + different revision checked out
781 # If --cached was specified the revision in the index will be printed
782 # instead of the currently checked out revision.
784 # $@ = requested paths (default to all)
786 cmd_status()
788 # parse $args after "submodule ... status".
789 while test $# -ne 0
791 case "$1" in
792 -q|--quiet)
793 GIT_QUIET=1
795 --cached)
796 cached=1
798 --recursive)
799 recursive=1
802 shift
803 break
806 usage
809 break
811 esac
812 shift
813 done
815 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@"
818 # Sync remote urls for submodules
819 # This makes the value for remote.$remote.url match the value
820 # specified in .gitmodules.
822 cmd_sync()
824 while test $# -ne 0
826 case "$1" in
827 -q|--quiet)
828 GIT_QUIET=1
829 shift
831 --recursive)
832 recursive=1
833 shift
836 shift
837 break
840 usage
843 break
845 esac
846 done
848 git ${wt_prefix:+-C "$wt_prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} -- "$@"
851 cmd_absorbgitdirs()
853 git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
856 # This loop parses the command line arguments to find the
857 # subcommand name to dispatch. Parsing of the subcommand specific
858 # options are primarily done by the subcommand implementations.
859 # Subcommand specific options such as --branch and --cached are
860 # parsed here as well, for backward compatibility.
862 while test $# != 0 && test -z "$command"
864 case "$1" in
865 add | foreach | init | deinit | update | set-branch | set-url | status | summary | sync | absorbgitdirs)
866 command=$1
868 -q|--quiet)
869 GIT_QUIET=1
871 -b|--branch)
872 case "$2" in
874 usage
876 esac
877 branch="$2"; shift
879 --cached)
880 cached="$1"
883 break
886 usage
889 break
891 esac
892 shift
893 done
895 # No command word defaults to "status"
896 if test -z "$command"
897 then
898 if test $# = 0
899 then
900 command=status
901 else
902 usage
906 # "-b branch" is accepted only by "add" and "set-branch"
907 if test -n "$branch" && (test "$command" != add || test "$command" != set-branch)
908 then
909 usage
912 # "--cached" is accepted only by "status" and "summary"
913 if test -n "$cached" && test "$command" != status && test "$command" != summary
914 then
915 usage
918 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"