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