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