git-submodule.sh

   1 #!/bin/sh
   2 #
   3 # git-submodule.sh: add, init, update or list git submodules
   4 #
   5 # Copyright (c) 2007 Lars Hjemli
   6
   7 dashless=$(basename "$0" | sed -e 's/-/ /')
   8 USAGE="[--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
   9    or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
  10    or: $dashless [--quiet] init [--] [<path>...]
  11    or: $dashless [--quiet] deinit [-f|--force] [--] <path>...
  12    or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--reference <repository>] [--recursive] [--] [<path>...]
  13    or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
  14    or: $dashless [--quiet] foreach [--recursive] <command>
  15    or: $dashless [--quiet] sync [--recursive] [--] [<path>...]"
  16 OPTIONS_SPEC=
  17 SUBDIRECTORY_OK=Yes
  18 . git-sh-setup
  19 . git-sh-i18n
  20 . git-parse-remote
  21 require_work_tree
  22 wt_prefix=$(git rev-parse --show-prefix)
  23 cd_to_toplevel
  24
  25 command=
  26 branch=
  27 force=
  28 reference=
  29 cached=
  30 recursive=
  31 init=
  32 files=
  33 remote=
  34 nofetch=
  35 update=
  36 prefix=
  37 custom_name=
  38 depth=
  39
  40 # The function takes at most 2 arguments. The first argument is the
  41 # URL that navigates to the submodule origin repo. When relative, this URL
  42 # is relative to the superproject origin URL repo. The second up_path
  43 # argument, if specified, is the relative path that navigates
  44 # from the submodule working tree to the superproject working tree.
  45 #
  46 # The output of the function is the origin URL of the submodule.
  47 #
  48 # The output will either be an absolute URL or filesystem path (if the
  49 # superproject origin URL is an absolute URL or filesystem path,
  50 # respectively) or a relative file system path (if the superproject
  51 # origin URL is a relative file system path).
  52 #
  53 # When the output is a relative file system path, the path is either
  54 # relative to the submodule working tree, if up_path is specified, or to
  55 # the superproject working tree otherwise.
  56 resolve_relative_url ()
  57 {
  58         remote=$(get_default_remote)
  59         remoteurl=$(git config "remote.$remote.url") ||
  60                 remoteurl=$(pwd) # the repository is its own authoritative upstream
  61         url="$1"
  62         remoteurl=${remoteurl%/}
  63         sep=/
  64         up_path="$2"
  65
  66         case "$remoteurl" in
  67         *:*|/*)
  68                 is_relative=
  69                 ;;
  70         ./*|../*)
  71                 is_relative=t
  72                 ;;
  73         *)
  74                 is_relative=t
  75                 remoteurl="./$remoteurl"
  76                 ;;
  77         esac
  78
  79         while test -n "$url"
  80         do
  81                 case "$url" in
  82                 ../*)
  83                         url="${url#../}"
  84                         case "$remoteurl" in
  85                         */*)
  86                                 remoteurl="${remoteurl%/*}"
  87                                 ;;
  88                         *:*)
  89                                 remoteurl="${remoteurl%:*}"
  90                                 sep=:
  91                                 ;;
  92                         *)
  93                                 if test -z "$is_relative" || test "." = "$remoteurl"
  94                                 then
  95                                         die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
  96                                 else
  97                                         remoteurl=.
  98                                 fi
  99                                 ;;
 100                         esac
 101                         ;;
 102                 ./*)
 103                         url="${url#./}"
 104                         ;;
 105                 *)
 106                         break;;
 107                 esac
 108         done
 109         remoteurl="$remoteurl$sep${url%/}"
 110         echo "${is_relative:+${up_path}}${remoteurl#./}"
 111 }
 112
 113 # Resolve a path to be relative to another path.  This is intended for
 114 # converting submodule paths when git-submodule is run in a subdirectory
 115 # and only handles paths where the directory separator is '/'.
 116 #
 117 # The output is the first argument as a path relative to the second argument,
 118 # which defaults to $wt_prefix if it is omitted.
 119 relative_path ()
 120 {
 121         local target curdir result
 122         target=$1
 123         curdir=${2-$wt_prefix}
 124         curdir=${curdir%/}
 125         result=
 126
 127         while test -n "$curdir"
 128         do
 129                 case "$target" in
 130                 "$curdir/"*)
 131                         target=${target#"$curdir"/}
 132                         break
 133                         ;;
 134                 esac
 135
 136                 result="${result}../"
 137                 if test "$curdir" = "${curdir%/*}"
 138                 then
 139                         curdir=
 140                 else
 141                         curdir="${curdir%/*}"
 142                 fi
 143         done
 144
 145         echo "$result$target"
 146 }
 147
 148 #
 149 # Get submodule info for registered submodules
 150 # $@ = path to limit submodule list
 151 #
 152 module_list()
 153 {
 154         eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
 155         (
 156                 git ls-files -z --error-unmatch --stage -- "$@" ||
 157                 echo "unmatched pathspec exists"
 158         ) |
 159         @@PERL@@ -e '
 160         my %unmerged = ();
 161         my ($null_sha1) = ("0" x 40);
 162         my @out = ();
 163         my $unmatched = 0;
 164         $/ = "\0";
 165         while (<STDIN>) {
 166                 if (/^unmatched pathspec/) {
 167                         $unmatched = 1;
 168                         next;
 169                 }
 170                 chomp;
 171                 my ($mode, $sha1, $stage, $path) =
 172                         /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
 173                 next unless $mode eq "160000";
 174                 if ($stage ne "0") {
 175                         if (!$unmerged{$path}++) {
 176                                 push @out, "$mode $null_sha1 U\t$path\n";
 177                         }
 178                         next;
 179                 }
 180                 push @out, "$_\n";
 181         }
 182         if ($unmatched) {
 183                 print "#unmatched\n";
 184         } else {
 185                 print for (@out);
 186         }
 187         '
 188 }
 189
 190 die_if_unmatched ()
 191 {
 192         if test "$1" = "#unmatched"
 193         then
 194                 exit 1
 195         fi
 196 }
 197
 198 #
 199 # Print a submodule configuration setting
 200 #
 201 # $1 = submodule name
 202 # $2 = option name
 203 # $3 = default value
 204 #
 205 # Checks in the usual git-config places first (for overrides),
 206 # otherwise it falls back on .gitmodules.  This allows you to
 207 # distribute project-wide defaults in .gitmodules, while still
 208 # customizing individual repositories if necessary.  If the option is
 209 # not in .gitmodules either, print a default value.
 210 #
 211 get_submodule_config () {
 212         name="$1"
 213         option="$2"
 214         default="$3"
 215         value=$(git config submodule."$name"."$option")
 216         if test -z "$value"
 217         then
 218                 value=$(git config -f .gitmodules submodule."$name"."$option")
 219         fi
 220         printf '%s' "${value:-$default}"
 221 }
 222
 223
 224 #
 225 # Map submodule path to submodule name
 226 #
 227 # $1 = path
 228 #
 229 module_name()
 230 {
 231         # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
 232         sm_path="$1"
 233         re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
 234         name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
 235                 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
 236         test -z "$name" &&
 237         die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$sm_path'")"
 238         echo "$name"
 239 }
 240
 241 #
 242 # Clone a submodule
 243 #
 244 # $1 = submodule path
 245 # $2 = submodule name
 246 # $3 = URL to clone
 247 # $4 = reference repository to reuse (empty for independent)
 248 # $5 = depth argument for shallow clones (empty for deep)
 249 #
 250 # Prior to calling, cmd_update checks that a possibly existing
 251 # path is not a git repository.
 252 # Likewise, cmd_add checks that path does not exist at all,
 253 # since it is the location of a new submodule.
 254 #
 255 module_clone()
 256 {
 257         sm_path=$1
 258         name=$2
 259         url=$3
 260         reference="$4"
 261         depth="$5"
 262         quiet=
 263         if test -n "$GIT_QUIET"
 264         then
 265                 quiet=-q
 266         fi
 267
 268         gitdir=
 269         gitdir_base=
 270         base_name=$(dirname "$name")
 271
 272         gitdir=$(git rev-parse --git-dir)
 273         gitdir_base="$gitdir/modules/$base_name"
 274         gitdir="$gitdir/modules/$name"
 275
 276         if test -d "$gitdir"
 277         then
 278                 mkdir -p "$sm_path"
 279                 rm -f "$gitdir/index"
 280         else
 281                 mkdir -p "$gitdir_base"
 282                 (
 283                         clear_local_git_env
 284                         git clone $quiet ${depth:+"$depth"} -n ${reference:+"$reference"} \
 285                                 --separate-git-dir "$gitdir" "$url" "$sm_path"
 286                 ) ||
 287                 die "$(eval_gettext "Clone of '\$url' into submodule path '\$sm_path' failed")"
 288         fi
 289
 290         # We already are at the root of the work tree but cd_to_toplevel will
 291         # resolve any symlinks that might be present in $PWD
 292         a=$(cd_to_toplevel && cd "$gitdir" && pwd)/
 293         b=$(cd_to_toplevel && cd "$sm_path" && pwd)/
 294         # Remove all common leading directories after a sanity check
 295         if test "${a#$b}" != "$a" || test "${b#$a}" != "$b"; then
 296                 die "$(eval_gettext "Gitdir '\$a' is part of the submodule path '\$b' or vice versa")"
 297         fi
 298         while test "${a%%/*}" = "${b%%/*}"
 299         do
 300                 a=${a#*/}
 301                 b=${b#*/}
 302         done
 303         # Now chop off the trailing '/'s that were added in the beginning
 304         a=${a%/}
 305         b=${b%/}
 306
 307         # Turn each leading "*/" component into "../"
 308         rel=$(echo $b | sed -e 's|[^/][^/]*|..|g')
 309         echo "gitdir: $rel/$a" >"$sm_path/.git"
 310
 311         rel=$(echo $a | sed -e 's|[^/][^/]*|..|g')
 312         (clear_local_git_env; cd "$sm_path" && GIT_WORK_TREE=. git config core.worktree "$rel/$b")
 313 }
 314
 315 isnumber()
 316 {
 317         n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
 318 }
 319
 320 #
 321 # Add a new submodule to the working tree, .gitmodules and the index
 322 #
 323 # $@ = repo path
 324 #
 325 # optional branch is stored in global branch variable
 326 #
 327 cmd_add()
 328 {
 329         # parse $args after "submodule ... add".
 330         reference_path=
 331         while test $# -ne 0
 332         do
 333                 case "$1" in
 334                 -b | --branch)
 335                         case "$2" in '') usage ;; esac
 336                         branch=$2
 337                         shift
 338                         ;;
 339                 -f | --force)
 340                         force=$1
 341                         ;;
 342                 -q|--quiet)
 343                         GIT_QUIET=1
 344                         ;;
 345                 --reference)
 346                         case "$2" in '') usage ;; esac
 347                         reference_path=$2
 348                         shift
 349                         ;;
 350                 --reference=*)
 351                         reference_path="${1#--reference=}"
 352                         ;;
 353                 --name)
 354                         case "$2" in '') usage ;; esac
 355                         custom_name=$2
 356                         shift
 357                         ;;
 358                 --depth)
 359                         case "$2" in '') usage ;; esac
 360                         depth="--depth=$2"
 361                         shift
 362                         ;;
 363                 --depth=*)
 364                         depth=$1
 365                         ;;
 366                 --)
 367                         shift
 368                         break
 369                         ;;
 370                 -*)
 371                         usage
 372                         ;;
 373                 *)
 374                         break
 375                         ;;
 376                 esac
 377                 shift
 378         done
 379
 380         if test -n "$reference_path"
 381         then
 382                 is_absolute_path "$reference_path" ||
 383                 reference_path="$wt_prefix$reference_path"
 384
 385                 reference="--reference=$reference_path"
 386         fi
 387
 388         repo=$1
 389         sm_path=$2
 390
 391         if test -z "$sm_path"; then
 392                 sm_path=$(echo "$repo" |
 393                         sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
 394         fi
 395
 396         if test -z "$repo" -o -z "$sm_path"; then
 397                 usage
 398         fi
 399
 400         is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
 401
 402         # assure repo is absolute or relative to parent
 403         case "$repo" in
 404         ./*|../*)
 405                 test -z "$wt_prefix" ||
 406                 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
 407
 408                 # dereference source url relative to parent's url
 409                 realrepo=$(resolve_relative_url "$repo") || exit
 410                 ;;
 411         *:*|/*)
 412                 # absolute url
 413                 realrepo=$repo
 414                 ;;
 415         *)
 416                 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
 417         ;;
 418         esac
 419
 420         # normalize path:
 421         # multiple //; leading ./; /./; /../; trailing /
 422         sm_path=$(printf '%s/\n' "$sm_path" |
 423                 sed -e '
 424                         s|//*|/|g
 425                         s|^\(\./\)*||
 426                         s|/\./|/|g
 427                         :start
 428                         s|\([^/]*\)/\.\./||
 429                         tstart
 430                         s|/*$||
 431                 ')
 432         git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
 433         die "$(eval_gettext "'\$sm_path' already exists in the index")"
 434
 435         if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
 436         then
 437                 eval_gettextln "The following path is ignored by one of your .gitignore files:
 438 \$sm_path
 439 Use -f if you really want to add it." >&2
 440                 exit 1
 441         fi
 442
 443         if test -n "$custom_name"
 444         then
 445                 sm_name="$custom_name"
 446         else
 447                 sm_name="$sm_path"
 448         fi
 449
 450         # perhaps the path exists and is already a git repo, else clone it
 451         if test -e "$sm_path"
 452         then
 453                 if test -d "$sm_path"/.git -o -f "$sm_path"/.git
 454                 then
 455                         eval_gettextln "Adding existing repo at '\$sm_path' to the index"
 456                 else
 457                         die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
 458                 fi
 459
 460         else
 461                 if test -d ".git/modules/$sm_name"
 462                 then
 463                         if test -z "$force"
 464                         then
 465                                 echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
 466                                 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^,"  ", -e s,' (fetch)',, >&2
 467                                 echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
 468                                 echo >&2 "  $realrepo"
 469                                 echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
 470                                 die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
 471                         else
 472                                 echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
 473                         fi
 474                 fi
 475                 module_clone "$sm_path" "$sm_name" "$realrepo" "$reference" "$depth" || exit
 476                 (
 477                         clear_local_git_env
 478                         cd "$sm_path" &&
 479                         # ash fails to wordsplit ${branch:+-b "$branch"...}
 480                         case "$branch" in
 481                         '') git checkout -f -q ;;
 482                         ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
 483                         esac
 484                 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
 485         fi
 486         git config submodule."$sm_name".url "$realrepo"
 487
 488         git add $force "$sm_path" ||
 489         die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
 490
 491         git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
 492         git config -f .gitmodules submodule."$sm_name".url "$repo" &&
 493         if test -n "$branch"
 494         then
 495                 git config -f .gitmodules submodule."$sm_name".branch "$branch"
 496         fi &&
 497         git add --force .gitmodules ||
 498         die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
 499 }
 500
 501 #
 502 # Execute an arbitrary command sequence in each checked out
 503 # submodule
 504 #
 505 # $@ = command to execute
 506 #
 507 cmd_foreach()
 508 {
 509         # parse $args after "submodule ... foreach".
 510         while test $# -ne 0
 511         do
 512                 case "$1" in
 513                 -q|--quiet)
 514                         GIT_QUIET=1
 515                         ;;
 516                 --recursive)
 517                         recursive=1
 518                         ;;
 519                 -*)
 520                         usage
 521                         ;;
 522                 *)
 523                         break
 524                         ;;
 525                 esac
 526                 shift
 527         done
 528
 529         toplevel=$(pwd)
 530
 531         # dup stdin so that it can be restored when running the external
 532         # command in the subshell (and a recursive call to this function)
 533         exec 3<&0
 534
 535         module_list |
 536         while read mode sha1 stage sm_path
 537         do
 538                 die_if_unmatched "$mode"
 539                 if test -e "$sm_path"/.git
 540                 then
 541                         displaypath=$(relative_path "$sm_path")
 542                         say "$(eval_gettext "Entering '\$prefix\$displaypath'")"
 543                         name=$(module_name "$sm_path")
 544                         (
 545                                 prefix="$prefix$sm_path/"
 546                                 clear_local_git_env
 547                                 cd "$sm_path" &&
 548                                 sm_path=$(relative_path "$sm_path") &&
 549                                 # we make $path available to scripts ...
 550                                 path=$sm_path &&
 551                                 if test $# -eq 1
 552                                 then
 553                                         eval "$1"
 554                                 else
 555                                         "$@"
 556                                 fi &&
 557                                 if test -n "$recursive"
 558                                 then
 559                                         cmd_foreach "--recursive" "$@"
 560                                 fi
 561                         ) <&3 3<&- ||
 562                         die "$(eval_gettext "Stopping at '\$prefix\$displaypath'; script returned non-zero status.")"
 563                 fi
 564         done
 565 }
 566
 567 #
 568 # Register submodules in .git/config
 569 #
 570 # $@ = requested paths (default to all)
 571 #
 572 cmd_init()
 573 {
 574         # parse $args after "submodule ... init".
 575         while test $# -ne 0
 576         do
 577                 case "$1" in
 578                 -q|--quiet)
 579                         GIT_QUIET=1
 580                         ;;
 581                 --)
 582                         shift
 583                         break
 584                         ;;
 585                 -*)
 586                         usage
 587                         ;;
 588                 *)
 589                         break
 590                         ;;
 591                 esac
 592                 shift
 593         done
 594
 595         module_list "$@" |
 596         while read mode sha1 stage sm_path
 597         do
 598                 die_if_unmatched "$mode"
 599                 name=$(module_name "$sm_path") || exit
 600
 601                 displaypath=$(relative_path "$sm_path")
 602
 603                 # Copy url setting when it is not set yet
 604                 if test -z "$(git config "submodule.$name.url")"
 605                 then
 606                         url=$(git config -f .gitmodules submodule."$name".url)
 607                         test -z "$url" &&
 608                         die "$(eval_gettext "No url found for submodule path '\$displaypath' in .gitmodules")"
 609
 610                         # Possibly a url relative to parent
 611                         case "$url" in
 612                         ./*|../*)
 613                                 url=$(resolve_relative_url "$url") || exit
 614                                 ;;
 615                         esac
 616                         git config submodule."$name".url "$url" ||
 617                         die "$(eval_gettext "Failed to register url for submodule path '\$displaypath'")"
 618
 619                         say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$displaypath'")"
 620                 fi
 621
 622                 # Copy "update" setting when it is not set yet
 623                 if upd="$(git config -f .gitmodules submodule."$name".update)" &&
 624                    test -n "$upd" &&
 625                    test -z "$(git config submodule."$name".update)"
 626                 then
 627                         case "$upd" in
 628                         checkout | rebase | merge | none)
 629                                 ;; # known modes of updating
 630                         *)
 631                                 echo >&2 "warning: unknown update mode '$upd' suggested for submodule '$name'"
 632                                 upd=none
 633                                 ;;
 634                         esac
 635                         git config submodule."$name".update "$upd" ||
 636                         die "$(eval_gettext "Failed to register update mode for submodule path '\$displaypath'")"
 637                 fi
 638         done
 639 }
 640
 641 #
 642 # Unregister submodules from .git/config and remove their work tree
 643 #
 644 # $@ = requested paths (use '.' to deinit all submodules)
 645 #
 646 cmd_deinit()
 647 {
 648         # parse $args after "submodule ... deinit".
 649         while test $# -ne 0
 650         do
 651                 case "$1" in
 652                 -f|--force)
 653                         force=$1
 654                         ;;
 655                 -q|--quiet)
 656                         GIT_QUIET=1
 657                         ;;
 658                 --)
 659                         shift
 660                         break
 661                         ;;
 662                 -*)
 663                         usage
 664                         ;;
 665                 *)
 666                         break
 667                         ;;
 668                 esac
 669                 shift
 670         done
 671
 672         if test $# = 0
 673         then
 674                 die "$(eval_gettext "Use '.' if you really want to deinitialize all submodules")"
 675         fi
 676
 677         module_list "$@" |
 678         while read mode sha1 stage sm_path
 679         do
 680                 die_if_unmatched "$mode"
 681                 name=$(module_name "$sm_path") || exit
 682
 683                 displaypath=$(relative_path "$sm_path")
 684
 685                 # Remove the submodule work tree (unless the user already did it)
 686                 if test -d "$sm_path"
 687                 then
 688                         # Protect submodules containing a .git directory
 689                         if test -d "$sm_path/.git"
 690                         then
 691                                 echo >&2 "$(eval_gettext "Submodule work tree '\$displaypath' contains a .git directory")"
 692                                 die "$(eval_gettext "(use 'rm -rf' if you really want to remove it including all of its history)")"
 693                         fi
 694
 695                         if test -z "$force"
 696                         then
 697                                 git rm -qn "$sm_path" ||
 698                                 die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
 699                         fi
 700                         rm -rf "$sm_path" &&
 701                         say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
 702                         say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
 703                 fi
 704
 705                 mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
 706
 707                 # Remove the .git/config entries (unless the user already did it)
 708                 if test -n "$(git config --get-regexp submodule."$name\.")"
 709                 then
 710                         # Remove the whole section so we have a clean state when
 711                         # the user later decides to init this submodule again
 712                         url=$(git config submodule."$name".url)
 713                         git config --remove-section submodule."$name" 2>/dev/null &&
 714                         say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
 715                 fi
 716         done
 717 }
 718
 719 #
 720 # Update each submodule path to correct revision, using clone and checkout as needed
 721 #
 722 # $@ = requested paths (default to all)
 723 #
 724 cmd_update()
 725 {
 726         # parse $args after "submodule ... update".
 727         while test $# -ne 0
 728         do
 729                 case "$1" in
 730                 -q|--quiet)
 731                         GIT_QUIET=1
 732                         ;;
 733                 -i|--init)
 734                         init=1
 735                         ;;
 736                 --remote)
 737                         remote=1
 738                         ;;
 739                 -N|--no-fetch)
 740                         nofetch=1
 741                         ;;
 742                 -f|--force)
 743                         force=$1
 744                         ;;
 745                 -r|--rebase)
 746                         update="rebase"
 747                         ;;
 748                 --reference)
 749                         case "$2" in '') usage ;; esac
 750                         reference="--reference=$2"
 751                         shift
 752                         ;;
 753                 --reference=*)
 754                         reference="$1"
 755                         ;;
 756                 -m|--merge)
 757                         update="merge"
 758                         ;;
 759                 --recursive)
 760                         recursive=1
 761                         ;;
 762                 --checkout)
 763                         update="checkout"
 764                         ;;
 765                 --depth)
 766                         case "$2" in '') usage ;; esac
 767                         depth="--depth=$2"
 768                         shift
 769                         ;;
 770                 --depth=*)
 771                         depth=$1
 772                         ;;
 773                 --)
 774                         shift
 775                         break
 776                         ;;
 777                 -*)
 778                         usage
 779                         ;;
 780                 *)
 781                         break
 782                         ;;
 783                 esac
 784                 shift
 785         done
 786
 787         if test -n "$init"
 788         then
 789                 cmd_init "--" "$@" || return
 790         fi
 791
 792         cloned_modules=
 793         module_list "$@" | {
 794         err=
 795         while read mode sha1 stage sm_path
 796         do
 797                 die_if_unmatched "$mode"
 798                 if test "$stage" = U
 799                 then
 800                         echo >&2 "Skipping unmerged submodule $prefix$sm_path"
 801                         continue
 802                 fi
 803                 name=$(module_name "$sm_path") || exit
 804                 url=$(git config submodule."$name".url)
 805                 branch=$(get_submodule_config "$name" branch master)
 806                 if ! test -z "$update"
 807                 then
 808                         update_module=$update
 809                 else
 810                         update_module=$(git config submodule."$name".update)
 811                         if test -z "$update_module"
 812                         then
 813                                 update_module="checkout"
 814                         fi
 815                 fi
 816
 817                 displaypath=$(relative_path "$prefix$sm_path")
 818
 819                 if test "$update_module" = "none"
 820                 then
 821                         echo "Skipping submodule '$displaypath'"
 822                         continue
 823                 fi
 824
 825                 if test -z "$url"
 826                 then
 827                         # Only mention uninitialized submodules when its
 828                         # path have been specified
 829                         test "$#" != "0" &&
 830                         say "$(eval_gettext "Submodule path '\$displaypath' not initialized
 831 Maybe you want to use 'update --init'?")"
 832                         continue
 833                 fi
 834
 835                 if ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
 836                 then
 837                         module_clone "$sm_path" "$name" "$url" "$reference" "$depth" || exit
 838                         cloned_modules="$cloned_modules;$name"
 839                         subsha1=
 840                 else
 841                         subsha1=$(clear_local_git_env; cd "$sm_path" &&
 842                                 git rev-parse --verify HEAD) ||
 843                         die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
 844                 fi
 845
 846                 if test -n "$remote"
 847                 then
 848                         if test -z "$nofetch"
 849                         then
 850                                 # Fetch remote before determining tracking $sha1
 851                                 (clear_local_git_env; cd "$sm_path" && git-fetch) ||
 852                                 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
 853                         fi
 854                         remote_name=$(clear_local_git_env; cd "$sm_path" && get_default_remote)
 855                         sha1=$(clear_local_git_env; cd "$sm_path" &&
 856                                 git rev-parse --verify "${remote_name}/${branch}") ||
 857                         die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
 858                 fi
 859
 860                 if test "$subsha1" != "$sha1" -o -n "$force"
 861                 then
 862                         subforce=$force
 863                         # If we don't already have a -f flag and the submodule has never been checked out
 864                         if test -z "$subsha1" -a -z "$force"
 865                         then
 866                                 subforce="-f"
 867                         fi
 868
 869                         if test -z "$nofetch"
 870                         then
 871                                 # Run fetch only if $sha1 isn't present or it
 872                                 # is not reachable from a ref.
 873                                 (clear_local_git_env; cd "$sm_path" &&
 874                                         ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
 875                                          test -z "$rev") || git-fetch)) ||
 876                                 die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
 877                         fi
 878
 879                         # Is this something we just cloned?
 880                         case ";$cloned_modules;" in
 881                         *";$name;"*)
 882                                 # then there is no local change to integrate
 883                                 update_module=checkout ;;
 884                         esac
 885
 886                         must_die_on_failure=
 887                         case "$update_module" in
 888                         checkout)
 889                                 command="git checkout $subforce -q"
 890                                 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
 891                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
 892                                 ;;
 893                         rebase)
 894                                 command="git rebase"
 895                                 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
 896                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
 897                                 must_die_on_failure=yes
 898                                 ;;
 899                         merge)
 900                                 command="git merge"
 901                                 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
 902                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
 903                                 must_die_on_failure=yes
 904                                 ;;
 905                         !*)
 906                                 command="${update_module#!}"
 907                                 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule  path '\$prefix\$sm_path'")"
 908                                 say_msg="$(eval_gettext "Submodule path '\$prefix\$sm_path': '\$command \$sha1'")"
 909                                 must_die_on_failure=yes
 910                                 ;;
 911                         *)
 912                                 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
 913                         esac
 914
 915                         if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
 916                         then
 917                                 say "$say_msg"
 918                         elif test -n "$must_die_on_failure"
 919                         then
 920                                 die_with_status 2 "$die_msg"
 921                         else
 922                                 err="${err};$die_msg"
 923                                 continue
 924                         fi
 925                 fi
 926
 927                 if test -n "$recursive"
 928                 then
 929                         (
 930                                 prefix="$prefix$sm_path/"
 931                                 clear_local_git_env
 932                                 cd "$sm_path" &&
 933                                 eval cmd_update
 934                         )
 935                         res=$?
 936                         if test $res -gt 0
 937                         then
 938                                 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
 939                                 if test $res -eq 1
 940                                 then
 941                                         err="${err};$die_msg"
 942                                         continue
 943                                 else
 944                                         die_with_status $res "$die_msg"
 945                                 fi
 946                         fi
 947                 fi
 948         done
 949
 950         if test -n "$err"
 951         then
 952                 OIFS=$IFS
 953                 IFS=';'
 954                 for e in $err
 955                 do
 956                         if test -n "$e"
 957                         then
 958                                 echo >&2 "$e"
 959                         fi
 960                 done
 961                 IFS=$OIFS
 962                 exit 1
 963         fi
 964         }
 965 }
 966
 967 set_name_rev () {
 968         revname=$( (
 969                 clear_local_git_env
 970                 cd "$1" && {
 971                         git describe "$2" 2>/dev/null ||
 972                         git describe --tags "$2" 2>/dev/null ||
 973                         git describe --contains "$2" 2>/dev/null ||
 974                         git describe --all --always "$2"
 975                 }
 976         ) )
 977         test -z "$revname" || revname=" ($revname)"
 978 }
 979 #
 980 # Show commit summary for submodules in index or working tree
 981 #
 982 # If '--cached' is given, show summary between index and given commit,
 983 # or between working tree and given commit
 984 #
 985 # $@ = [commit (default 'HEAD'),] requested paths (default all)
 986 #
 987 cmd_summary() {
 988         summary_limit=-1
 989         for_status=
 990         diff_cmd=diff-index
 991
 992         # parse $args after "submodule ... summary".
 993         while test $# -ne 0
 994         do
 995                 case "$1" in
 996                 --cached)
 997                         cached="$1"
 998                         ;;
 999                 --files)
1000                         files="$1"
1001                         ;;
1002                 --for-status)
1003                         for_status="$1"
1004                         ;;
1005                 -n|--summary-limit)
1006                         summary_limit="$2"
1007                         isnumber "$summary_limit" || usage
1008                         shift
1009                         ;;
1010                 --summary-limit=*)
1011                         summary_limit="${1#--summary-limit=}"
1012                         isnumber "$summary_limit" || usage
1013                         ;;
1014                 --)
1015                         shift
1016                         break
1017                         ;;
1018                 -*)
1019                         usage
1020                         ;;
1021                 *)
1022                         break
1023                         ;;
1024                 esac
1025                 shift
1026         done
1027
1028         test $summary_limit = 0 && return
1029
1030         if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
1031         then
1032                 head=$rev
1033                 test $# = 0 || shift
1034         elif test -z "$1" -o "$1" = "HEAD"
1035         then
1036                 # before the first commit: compare with an empty tree
1037                 head=$(git hash-object -w -t tree --stdin </dev/null)
1038                 test -z "$1" || shift
1039         else
1040                 head="HEAD"
1041         fi
1042
1043         if [ -n "$files" ]
1044         then
1045                 test -n "$cached" &&
1046                 die "$(gettext "The --cached option cannot be used with the --files option")"
1047                 diff_cmd=diff-files
1048                 head=
1049         fi
1050
1051         cd_to_toplevel
1052         eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
1053         # Get modified modules cared by user
1054         modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
1055                 sane_egrep '^:([0-7]* )?160000' |
1056                 while read mod_src mod_dst sha1_src sha1_dst status sm_path
1057                 do
1058                         # Always show modules deleted or type-changed (blob<->module)
1059                         test $status = D -o $status = T && echo "$sm_path" && continue
1060                         # Respect the ignore setting for --for-status.
1061                         if test -n "$for_status"
1062                         then
1063                                 name=$(module_name "$sm_path")
1064                                 ignore_config=$(get_submodule_config "$name" ignore none)
1065                                 test $status != A -a $ignore_config = all && continue
1066                         fi
1067                         # Also show added or modified modules which are checked out
1068                         GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
1069                         echo "$sm_path"
1070                 done
1071         )
1072
1073         test -z "$modules" && return
1074
1075         git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
1076         sane_egrep '^:([0-7]* )?160000' |
1077         cut -c2- |
1078         while read mod_src mod_dst sha1_src sha1_dst status name
1079         do
1080                 if test -z "$cached" &&
1081                         test $sha1_dst = 0000000000000000000000000000000000000000
1082                 then
1083                         case "$mod_dst" in
1084                         160000)
1085                                 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
1086                                 ;;
1087                         100644 | 100755 | 120000)
1088                                 sha1_dst=$(git hash-object $name)
1089                                 ;;
1090                         000000)
1091                                 ;; # removed
1092                         *)
1093                                 # unexpected type
1094                                 eval_gettextln "unexpected mode \$mod_dst" >&2
1095                                 continue ;;
1096                         esac
1097                 fi
1098                 missing_src=
1099                 missing_dst=
1100
1101                 test $mod_src = 160000 &&
1102                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
1103                 missing_src=t
1104
1105                 test $mod_dst = 160000 &&
1106                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
1107                 missing_dst=t
1108
1109                 display_name=$(relative_path "$name")
1110
1111                 total_commits=
1112                 case "$missing_src,$missing_dst" in
1113                 t,)
1114                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_src")"
1115                         ;;
1116                 ,t)
1117                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_dst")"
1118                         ;;
1119                 t,t)
1120                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
1121                         ;;
1122                 *)
1123                         errmsg=
1124                         total_commits=$(
1125                         if test $mod_src = 160000 -a $mod_dst = 160000
1126                         then
1127                                 range="$sha1_src...$sha1_dst"
1128                         elif test $mod_src = 160000
1129                         then
1130                                 range=$sha1_src
1131                         else
1132                                 range=$sha1_dst
1133                         fi
1134                         GIT_DIR="$name/.git" \
1135                         git rev-list --first-parent $range -- | wc -l
1136                         )
1137                         total_commits=" ($(($total_commits + 0)))"
1138                         ;;
1139                 esac
1140
1141                 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
1142                 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
1143                 if test $status = T
1144                 then
1145                         blob="$(gettext "blob")"
1146                         submodule="$(gettext "submodule")"
1147                         if test $mod_dst = 160000
1148                         then
1149                                 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1150                         else
1151                                 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1152                         fi
1153                 else
1154                         echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1155                 fi
1156                 if test -n "$errmsg"
1157                 then
1158                         # Don't give error msg for modification whose dst is not submodule
1159                         # i.e. deleted or changed to blob
1160                         test $mod_dst = 160000 && echo "$errmsg"
1161                 else
1162                         if test $mod_src = 160000 -a $mod_dst = 160000
1163                         then
1164                                 limit=
1165                                 test $summary_limit -gt 0 && limit="-$summary_limit"
1166                                 GIT_DIR="$name/.git" \
1167                                 git log $limit --pretty='format:  %m %s' \
1168                                 --first-parent $sha1_src...$sha1_dst
1169                         elif test $mod_dst = 160000
1170                         then
1171                                 GIT_DIR="$name/.git" \
1172                                 git log --pretty='format:  > %s' -1 $sha1_dst
1173                         else
1174                                 GIT_DIR="$name/.git" \
1175                                 git log --pretty='format:  < %s' -1 $sha1_src
1176                         fi
1177                         echo
1178                 fi
1179                 echo
1180         done
1181 }
1182 #
1183 # List all submodules, prefixed with:
1184 #  - submodule not initialized
1185 #  + different revision checked out
1186 #
1187 # If --cached was specified the revision in the index will be printed
1188 # instead of the currently checked out revision.
1189 #
1190 # $@ = requested paths (default to all)
1191 #
1192 cmd_status()
1193 {
1194         # parse $args after "submodule ... status".
1195         while test $# -ne 0
1196         do
1197                 case "$1" in
1198                 -q|--quiet)
1199                         GIT_QUIET=1
1200                         ;;
1201                 --cached)
1202                         cached=1
1203                         ;;
1204                 --recursive)
1205                         recursive=1
1206                         ;;
1207                 --)
1208                         shift
1209                         break
1210                         ;;
1211                 -*)
1212                         usage
1213                         ;;
1214                 *)
1215                         break
1216                         ;;
1217                 esac
1218                 shift
1219         done
1220
1221         module_list "$@" |
1222         while read mode sha1 stage sm_path
1223         do
1224                 die_if_unmatched "$mode"
1225                 name=$(module_name "$sm_path") || exit
1226                 url=$(git config submodule."$name".url)
1227                 displaypath=$(relative_path "$prefix$sm_path")
1228                 if test "$stage" = U
1229                 then
1230                         say "U$sha1 $displaypath"
1231                         continue
1232                 fi
1233                 if test -z "$url" || ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
1234                 then
1235                         say "-$sha1 $displaypath"
1236                         continue;
1237                 fi
1238                 if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1239                 then
1240                         set_name_rev "$sm_path" "$sha1"
1241                         say " $sha1 $displaypath$revname"
1242                 else
1243                         if test -z "$cached"
1244                         then
1245                                 sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1246                         fi
1247                         set_name_rev "$sm_path" "$sha1"
1248                         say "+$sha1 $displaypath$revname"
1249                 fi
1250
1251                 if test -n "$recursive"
1252                 then
1253                         (
1254                                 prefix="$displaypath/"
1255                                 clear_local_git_env
1256                                 cd "$sm_path" &&
1257                                 eval cmd_status
1258                         ) ||
1259                         die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1260                 fi
1261         done
1262 }
1263 #
1264 # Sync remote urls for submodules
1265 # This makes the value for remote.$remote.url match the value
1266 # specified in .gitmodules.
1267 #
1268 cmd_sync()
1269 {
1270         while test $# -ne 0
1271         do
1272                 case "$1" in
1273                 -q|--quiet)
1274                         GIT_QUIET=1
1275                         shift
1276                         ;;
1277                 --recursive)
1278                         recursive=1
1279                         shift
1280                         ;;
1281                 --)
1282                         shift
1283                         break
1284                         ;;
1285                 -*)
1286                         usage
1287                         ;;
1288                 *)
1289                         break
1290                         ;;
1291                 esac
1292         done
1293         cd_to_toplevel
1294         module_list "$@" |
1295         while read mode sha1 stage sm_path
1296         do
1297                 die_if_unmatched "$mode"
1298                 name=$(module_name "$sm_path")
1299                 url=$(git config -f .gitmodules --get submodule."$name".url)
1300
1301                 # Possibly a url relative to parent
1302                 case "$url" in
1303                 ./*|../*)
1304                         # rewrite foo/bar as ../.. to find path from
1305                         # submodule work tree to superproject work tree
1306                         up_path="$(echo "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1307                         # guarantee a trailing /
1308                         up_path=${up_path%/}/ &&
1309                         # path from submodule work tree to submodule origin repo
1310                         sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1311                         # path from superproject work tree to submodule origin repo
1312                         super_config_url=$(resolve_relative_url "$url") || exit
1313                         ;;
1314                 *)
1315                         sub_origin_url="$url"
1316                         super_config_url="$url"
1317                         ;;
1318                 esac
1319
1320                 if git config "submodule.$name.url" >/dev/null 2>/dev/null
1321                 then
1322                         displaypath=$(relative_path "$prefix$sm_path")
1323                         say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1324                         git config submodule."$name".url "$super_config_url"
1325
1326                         if test -e "$sm_path"/.git
1327                         then
1328                         (
1329                                 clear_local_git_env
1330                                 cd "$sm_path"
1331                                 remote=$(get_default_remote)
1332                                 git config remote."$remote".url "$sub_origin_url"
1333
1334                                 if test -n "$recursive"
1335                                 then
1336                                         prefix="$prefix$sm_path/"
1337                                         eval cmd_sync
1338                                 fi
1339                         )
1340                         fi
1341                 fi
1342         done
1343 }
1344
1345 # This loop parses the command line arguments to find the
1346 # subcommand name to dispatch.  Parsing of the subcommand specific
1347 # options are primarily done by the subcommand implementations.
1348 # Subcommand specific options such as --branch and --cached are
1349 # parsed here as well, for backward compatibility.
1350
1351 while test $# != 0 && test -z "$command"
1352 do
1353         case "$1" in
1354         add | foreach | init | deinit | update | status | summary | sync)
1355                 command=$1
1356                 ;;
1357         -q|--quiet)
1358                 GIT_QUIET=1
1359                 ;;
1360         -b|--branch)
1361                 case "$2" in
1362                 '')
1363                         usage
1364                         ;;
1365                 esac
1366                 branch="$2"; shift
1367                 ;;
1368         --cached)
1369                 cached="$1"
1370                 ;;
1371         --)
1372                 break
1373                 ;;
1374         -*)
1375                 usage
1376                 ;;
1377         *)
1378                 break
1379                 ;;
1380         esac
1381         shift
1382 done
1383
1384 # No command word defaults to "status"
1385 if test -z "$command"
1386 then
1387     if test $# = 0
1388     then
1389         command=status
1390     else
1391         usage
1392     fi
1393 fi
1394
1395 # "-b branch" is accepted only by "add"
1396 if test -n "$branch" && test "$command" != add
1397 then
1398         usage
1399 fi
1400
1401 # "--cached" is accepted only by "status" and "summary"
1402 if test -n "$cached" && test "$command" != status -a "$command" != summary
1403 then
1404         usage
1405 fi
1406
1407 "cmd_$command" "$@"