git.oblomov.eu Git - git/blob - 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] (--all| [--] <path>...)
  12    or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--[no-]recommend-shallow] [--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    or: $dashless [--quiet] absorbgitdirs [--] [<path>...]"
  17 OPTIONS_SPEC=
  18 SUBDIRECTORY_OK=Yes
  19 . git-sh-setup
  20 . git-parse-remote
  21 require_work_tree
  22 wt_prefix=$(git rev-parse --show-prefix)
  23 cd_to_toplevel
  24
  25 # Tell the rest of git that any URLs we get don't come
  26 # directly from the user, so it can apply policy as appropriate.
  27 GIT_PROTOCOL_FROM_USER=0
  28 export GIT_PROTOCOL_FROM_USER
  29
  30 command=
  31 branch=
  32 force=
  33 reference=
  34 cached=
  35 recursive=
  36 init=
  37 files=
  38 remote=
  39 nofetch=
  40 update=
  41 prefix=
  42 custom_name=
  43 depth=
  44 progress=
  45 dissociate=
  46
  47 die_if_unmatched ()
  48 {
  49         if test "$1" = "#unmatched"
  50         then
  51                 exit ${2:-1}
  52         fi
  53 }
  54
  55 #
  56 # Print a submodule configuration setting
  57 #
  58 # $1 = submodule name
  59 # $2 = option name
  60 # $3 = default value
  61 #
  62 # Checks in the usual git-config places first (for overrides),
  63 # otherwise it falls back on .gitmodules.  This allows you to
  64 # distribute project-wide defaults in .gitmodules, while still
  65 # customizing individual repositories if necessary.  If the option is
  66 # not in .gitmodules either, print a default value.
  67 #
  68 get_submodule_config () {
  69         name="$1"
  70         option="$2"
  71         default="$3"
  72         value=$(git config submodule."$name"."$option")
  73         if test -z "$value"
  74         then
  75                 value=$(git config -f .gitmodules submodule."$name"."$option")
  76         fi
  77         printf '%s' "${value:-$default}"
  78 }
  79
  80 isnumber()
  81 {
  82         n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
  83 }
  84
  85 # Sanitize the local git environment for use within a submodule. We
  86 # can't simply use clear_local_git_env since we want to preserve some
  87 # of the settings from GIT_CONFIG_PARAMETERS.
  88 sanitize_submodule_env()
  89 {
  90         save_config=$GIT_CONFIG_PARAMETERS
  91         clear_local_git_env
  92         GIT_CONFIG_PARAMETERS=$save_config
  93         export GIT_CONFIG_PARAMETERS
  94 }
  95
  96 #
  97 # Add a new submodule to the working tree, .gitmodules and the index
  98 #
  99 # $@ = repo path
 100 #
 101 # optional branch is stored in global branch variable
 102 #
 103 cmd_add()
 104 {
 105         # parse $args after "submodule ... add".
 106         reference_path=
 107         while test $# -ne 0
 108         do
 109                 case "$1" in
 110                 -b | --branch)
 111                         case "$2" in '') usage ;; esac
 112                         branch=$2
 113                         shift
 114                         ;;
 115                 -f | --force)
 116                         force=$1
 117                         ;;
 118                 -q|--quiet)
 119                         GIT_QUIET=1
 120                         ;;
 121                 --progress)
 122                         progress=1
 123                         ;;
 124                 --reference)
 125                         case "$2" in '') usage ;; esac
 126                         reference_path=$2
 127                         shift
 128                         ;;
 129                 --reference=*)
 130                         reference_path="${1#--reference=}"
 131                         ;;
 132                 --dissociate)
 133                         dissociate=1
 134                         ;;
 135                 --name)
 136                         case "$2" in '') usage ;; esac
 137                         custom_name=$2
 138                         shift
 139                         ;;
 140                 --depth)
 141                         case "$2" in '') usage ;; esac
 142                         depth="--depth=$2"
 143                         shift
 144                         ;;
 145                 --depth=*)
 146                         depth=$1
 147                         ;;
 148                 --)
 149                         shift
 150                         break
 151                         ;;
 152                 -*)
 153                         usage
 154                         ;;
 155                 *)
 156                         break
 157                         ;;
 158                 esac
 159                 shift
 160         done
 161
 162         if test -n "$reference_path"
 163         then
 164                 is_absolute_path "$reference_path" ||
 165                 reference_path="$wt_prefix$reference_path"
 166
 167                 reference="--reference=$reference_path"
 168         fi
 169
 170         repo=$1
 171         sm_path=$2
 172
 173         if test -z "$sm_path"; then
 174                 sm_path=$(printf '%s\n' "$repo" |
 175                         sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
 176         fi
 177
 178         if test -z "$repo" || test -z "$sm_path"; then
 179                 usage
 180         fi
 181
 182         is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
 183
 184         # assure repo is absolute or relative to parent
 185         case "$repo" in
 186         ./*|../*)
 187                 test -z "$wt_prefix" ||
 188                 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
 189
 190                 # dereference source url relative to parent's url
 191                 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
 192                 ;;
 193         *:*|/*)
 194                 # absolute url
 195                 realrepo=$repo
 196                 ;;
 197         *)
 198                 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
 199         ;;
 200         esac
 201
 202         # normalize path:
 203         # multiple //; leading ./; /./; /../; trailing /
 204         sm_path=$(printf '%s/\n' "$sm_path" |
 205                 sed -e '
 206                         s|//*|/|g
 207                         s|^\(\./\)*||
 208                         s|/\(\./\)*|/|g
 209                         :start
 210                         s|\([^/]*\)/\.\./||
 211                         tstart
 212                         s|/*$||
 213                 ')
 214         if test -z "$force"
 215         then
 216                 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
 217                 die "$(eval_gettext "'\$sm_path' already exists in the index")"
 218         else
 219                 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
 220                 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
 221         fi
 222
 223         if test -z "$force" &&
 224                 ! git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev/null 2>&1
 225         then
 226                 eval_gettextln "The following path is ignored by one of your .gitignore files:
 227 \$sm_path
 228 Use -f if you really want to add it." >&2
 229                 exit 1
 230         fi
 231
 232         if test -n "$custom_name"
 233         then
 234                 sm_name="$custom_name"
 235         else
 236                 sm_name="$sm_path"
 237         fi
 238
 239         if ! git submodule--helper check-name "$sm_name"
 240         then
 241                 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
 242         fi
 243
 244         # perhaps the path exists and is already a git repo, else clone it
 245         if test -e "$sm_path"
 246         then
 247                 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
 248                 then
 249                         eval_gettextln "Adding existing repo at '\$sm_path' to the index"
 250                 else
 251                         die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
 252                 fi
 253
 254         else
 255                 if test -d ".git/modules/$sm_name"
 256                 then
 257                         if test -z "$force"
 258                         then
 259                                 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
 260                                 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^,"  ", -e s,' (fetch)',, >&2
 261                                 die "$(eval_gettextln "\
 262 If you want to reuse this local git directory instead of cloning again from
 263   \$realrepo
 264 use the '--force' option. If the local git directory is not the correct repo
 265 or you are unsure what this means choose another name with the '--name' option.")"
 266                         else
 267                                 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
 268                         fi
 269                 fi
 270                 git submodule--helper clone ${GIT_QUIET:+--quiet} ${progress:+"--progress"} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${dissociate:+"--dissociate"} ${depth:+"$depth"} || exit
 271                 (
 272                         sanitize_submodule_env
 273                         cd "$sm_path" &&
 274                         # ash fails to wordsplit ${branch:+-b "$branch"...}
 275                         case "$branch" in
 276                         '') git checkout -f -q ;;
 277                         ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
 278                         esac
 279                 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
 280         fi
 281         git config submodule."$sm_name".url "$realrepo"
 282
 283         git add --no-warn-embedded-repo $force "$sm_path" ||
 284         die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
 285
 286         git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
 287         git config -f .gitmodules submodule."$sm_name".url "$repo" &&
 288         if test -n "$branch"
 289         then
 290                 git config -f .gitmodules submodule."$sm_name".branch "$branch"
 291         fi &&
 292         git add --force .gitmodules ||
 293         die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
 294
 295         # NEEDSWORK: In a multi-working-tree world, this needs to be
 296         # set in the per-worktree config.
 297         if git config --get submodule.active >/dev/null
 298         then
 299                 # If the submodule being adding isn't already covered by the
 300                 # current configured pathspec, set the submodule's active flag
 301                 if ! git submodule--helper is-active "$sm_path"
 302                 then
 303                         git config submodule."$sm_name".active "true"
 304                 fi
 305         else
 306                 git config submodule."$sm_name".active "true"
 307         fi
 308 }
 309
 310 #
 311 # Execute an arbitrary command sequence in each checked out
 312 # submodule
 313 #
 314 # $@ = command to execute
 315 #
 316 cmd_foreach()
 317 {
 318         # parse $args after "submodule ... foreach".
 319         while test $# -ne 0
 320         do
 321                 case "$1" in
 322                 -q|--quiet)
 323                         GIT_QUIET=1
 324                         ;;
 325                 --recursive)
 326                         recursive=1
 327                         ;;
 328                 -*)
 329                         usage
 330                         ;;
 331                 *)
 332                         break
 333                         ;;
 334                 esac
 335                 shift
 336         done
 337
 338         toplevel=$(pwd)
 339
 340         # dup stdin so that it can be restored when running the external
 341         # command in the subshell (and a recursive call to this function)
 342         exec 3<&0
 343
 344         {
 345                 git submodule--helper list --prefix "$wt_prefix" ||
 346                 echo "#unmatched" $?
 347         } |
 348         while read -r mode sha1 stage sm_path
 349         do
 350                 die_if_unmatched "$mode" "$sha1"
 351                 if test -e "$sm_path"/.git
 352                 then
 353                         displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
 354                         say "$(eval_gettext "Entering '\$displaypath'")"
 355                         name=$(git submodule--helper name "$sm_path")
 356                         (
 357                                 prefix="$prefix$sm_path/"
 358                                 sanitize_submodule_env
 359                                 cd "$sm_path" &&
 360                                 sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") &&
 361                                 # we make $path available to scripts ...
 362                                 path=$sm_path &&
 363                                 if test $# -eq 1
 364                                 then
 365                                         eval "$1"
 366                                 else
 367                                         "$@"
 368                                 fi &&
 369                                 if test -n "$recursive"
 370                                 then
 371                                         cmd_foreach "--recursive" "$@"
 372                                 fi
 373                         ) <&3 3<&- ||
 374                         die "$(eval_gettext "Stopping at '\$displaypath'; script returned non-zero status.")"
 375                 fi
 376         done
 377 }
 378
 379 #
 380 # Register submodules in .git/config
 381 #
 382 # $@ = requested paths (default to all)
 383 #
 384 cmd_init()
 385 {
 386         # parse $args after "submodule ... init".
 387         while test $# -ne 0
 388         do
 389                 case "$1" in
 390                 -q|--quiet)
 391                         GIT_QUIET=1
 392                         ;;
 393                 --)
 394                         shift
 395                         break
 396                         ;;
 397                 -*)
 398                         usage
 399                         ;;
 400                 *)
 401                         break
 402                         ;;
 403                 esac
 404                 shift
 405         done
 406
 407         git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet}  "$@"
 408 }
 409
 410 #
 411 # Unregister submodules from .git/config and remove their work tree
 412 #
 413 cmd_deinit()
 414 {
 415         # parse $args after "submodule ... deinit".
 416         deinit_all=
 417         while test $# -ne 0
 418         do
 419                 case "$1" in
 420                 -f|--force)
 421                         force=$1
 422                         ;;
 423                 -q|--quiet)
 424                         GIT_QUIET=1
 425                         ;;
 426                 --all)
 427                         deinit_all=t
 428                         ;;
 429                 --)
 430                         shift
 431                         break
 432                         ;;
 433                 -*)
 434                         usage
 435                         ;;
 436                 *)
 437                         break
 438                         ;;
 439                 esac
 440                 shift
 441         done
 442
 443         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
 444 }
 445
 446 is_tip_reachable () (
 447         sanitize_submodule_env &&
 448         cd "$1" &&
 449         rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
 450         test -z "$rev"
 451 )
 452
 453 fetch_in_submodule () (
 454         sanitize_submodule_env &&
 455         cd "$1" &&
 456         case "$2" in
 457         '')
 458                 git fetch ;;
 459         *)
 460                 shift
 461                 git fetch $(get_default_remote) "$@" ;;
 462         esac
 463 )
 464
 465 #
 466 # Update each submodule path to correct revision, using clone and checkout as needed
 467 #
 468 # $@ = requested paths (default to all)
 469 #
 470 cmd_update()
 471 {
 472         # parse $args after "submodule ... update".
 473         while test $# -ne 0
 474         do
 475                 case "$1" in
 476                 -q|--quiet)
 477                         GIT_QUIET=1
 478                         ;;
 479                 --progress)
 480                         progress=1
 481                         ;;
 482                 -i|--init)
 483                         init=1
 484                         ;;
 485                 --remote)
 486                         remote=1
 487                         ;;
 488                 -N|--no-fetch)
 489                         nofetch=1
 490                         ;;
 491                 -f|--force)
 492                         force=$1
 493                         ;;
 494                 -r|--rebase)
 495                         update="rebase"
 496                         ;;
 497                 --reference)
 498                         case "$2" in '') usage ;; esac
 499                         reference="--reference=$2"
 500                         shift
 501                         ;;
 502                 --reference=*)
 503                         reference="$1"
 504                         ;;
 505                 --dissociate)
 506                         dissociate=1
 507                         ;;
 508                 -m|--merge)
 509                         update="merge"
 510                         ;;
 511                 --recursive)
 512                         recursive=1
 513                         ;;
 514                 --checkout)
 515                         update="checkout"
 516                         ;;
 517                 --recommend-shallow)
 518                         recommend_shallow="--recommend-shallow"
 519                         ;;
 520                 --no-recommend-shallow)
 521                         recommend_shallow="--no-recommend-shallow"
 522                         ;;
 523                 --depth)
 524                         case "$2" in '') usage ;; esac
 525                         depth="--depth=$2"
 526                         shift
 527                         ;;
 528                 --depth=*)
 529                         depth=$1
 530                         ;;
 531                 -j|--jobs)
 532                         case "$2" in '') usage ;; esac
 533                         jobs="--jobs=$2"
 534                         shift
 535                         ;;
 536                 --jobs=*)
 537                         jobs=$1
 538                         ;;
 539                 --)
 540                         shift
 541                         break
 542                         ;;
 543                 -*)
 544                         usage
 545                         ;;
 546                 *)
 547                         break
 548                         ;;
 549                 esac
 550                 shift
 551         done
 552
 553         if test -n "$init"
 554         then
 555                 cmd_init "--" "$@" || return
 556         fi
 557
 558         {
 559         git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
 560                 ${progress:+"--progress"} \
 561                 ${wt_prefix:+--prefix "$wt_prefix"} \
 562                 ${prefix:+--recursive-prefix "$prefix"} \
 563                 ${update:+--update "$update"} \
 564                 ${reference:+"$reference"} \
 565                 ${dissociate:+"--dissociate"} \
 566                 ${depth:+--depth "$depth"} \
 567                 $recommend_shallow \
 568                 $jobs \
 569                 "$@" || echo "#unmatched" $?
 570         } | {
 571         err=
 572         while read -r mode sha1 stage just_cloned sm_path
 573         do
 574                 die_if_unmatched "$mode" "$sha1"
 575
 576                 name=$(git submodule--helper name "$sm_path") || exit
 577                 if ! test -z "$update"
 578                 then
 579                         update_module=$update
 580                 else
 581                         update_module=$(git config submodule."$name".update)
 582                         if test -z "$update_module"
 583                         then
 584                                 update_module="checkout"
 585                         fi
 586                 fi
 587
 588                 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
 589
 590                 if test $just_cloned -eq 1
 591                 then
 592                         subsha1=
 593                         case "$update_module" in
 594                         merge | rebase | none)
 595                                 update_module=checkout ;;
 596                         esac
 597                 else
 598                         subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
 599                                 git rev-parse --verify HEAD) ||
 600                         die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
 601                 fi
 602
 603                 if test -n "$remote"
 604                 then
 605                         branch=$(git submodule--helper remote-branch "$sm_path")
 606                         if test -z "$nofetch"
 607                         then
 608                                 # Fetch remote before determining tracking $sha1
 609                                 fetch_in_submodule "$sm_path" $depth ||
 610                                 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
 611                         fi
 612                         remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
 613                         sha1=$(sanitize_submodule_env; cd "$sm_path" &&
 614                                 git rev-parse --verify "${remote_name}/${branch}") ||
 615                         die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
 616                 fi
 617
 618                 if ! $(git config -f "$(git rev-parse --git-common-dir)/modules/$name/config" core.worktree) 2>/dev/null
 619                 then
 620                         git submodule--helper connect-gitdir-workingtree "$name" "$sm_path"
 621                 fi
 622
 623                 if test "$subsha1" != "$sha1" || test -n "$force"
 624                 then
 625                         subforce=$force
 626                         # If we don't already have a -f flag and the submodule has never been checked out
 627                         if test -z "$subsha1" && test -z "$force"
 628                         then
 629                                 subforce="-f"
 630                         fi
 631
 632                         if test -z "$nofetch"
 633                         then
 634                                 # Run fetch only if $sha1 isn't present or it
 635                                 # is not reachable from a ref.
 636                                 is_tip_reachable "$sm_path" "$sha1" ||
 637                                 fetch_in_submodule "$sm_path" $depth ||
 638                                 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
 639
 640                                 # Now we tried the usual fetch, but $sha1 may
 641                                 # not be reachable from any of the refs
 642                                 is_tip_reachable "$sm_path" "$sha1" ||
 643                                 fetch_in_submodule "$sm_path" $depth "$sha1" ||
 644                                 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
 645                         fi
 646
 647                         must_die_on_failure=
 648                         case "$update_module" in
 649                         checkout)
 650                                 command="git checkout $subforce -q"
 651                                 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
 652                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
 653                                 ;;
 654                         rebase)
 655                                 command="git rebase"
 656                                 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
 657                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
 658                                 must_die_on_failure=yes
 659                                 ;;
 660                         merge)
 661                                 command="git merge"
 662                                 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
 663                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
 664                                 must_die_on_failure=yes
 665                                 ;;
 666                         !*)
 667                                 command="${update_module#!}"
 668                                 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
 669                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
 670                                 must_die_on_failure=yes
 671                                 ;;
 672                         *)
 673                                 die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
 674                         esac
 675
 676                         if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
 677                         then
 678                                 say "$say_msg"
 679                         elif test -n "$must_die_on_failure"
 680                         then
 681                                 die_with_status 2 "$die_msg"
 682                         else
 683                                 err="${err};$die_msg"
 684                                 continue
 685                         fi
 686                 fi
 687
 688                 if test -n "$recursive"
 689                 then
 690                         (
 691                                 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
 692                                 wt_prefix=
 693                                 sanitize_submodule_env
 694                                 cd "$sm_path" &&
 695                                 eval cmd_update
 696                         )
 697                         res=$?
 698                         if test $res -gt 0
 699                         then
 700                                 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
 701                                 if test $res -ne 2
 702                                 then
 703                                         err="${err};$die_msg"
 704                                         continue
 705                                 else
 706                                         die_with_status $res "$die_msg"
 707                                 fi
 708                         fi
 709                 fi
 710         done
 711
 712         if test -n "$err"
 713         then
 714                 OIFS=$IFS
 715                 IFS=';'
 716                 for e in $err
 717                 do
 718                         if test -n "$e"
 719                         then
 720                                 echo >&2 "$e"
 721                         fi
 722                 done
 723                 IFS=$OIFS
 724                 exit 1
 725         fi
 726         }
 727 }
 728
 729 #
 730 # Show commit summary for submodules in index or working tree
 731 #
 732 # If '--cached' is given, show summary between index and given commit,
 733 # or between working tree and given commit
 734 #
 735 # $@ = [commit (default 'HEAD'),] requested paths (default all)
 736 #
 737 cmd_summary() {
 738         summary_limit=-1
 739         for_status=
 740         diff_cmd=diff-index
 741
 742         # parse $args after "submodule ... summary".
 743         while test $# -ne 0
 744         do
 745                 case "$1" in
 746                 --cached)
 747                         cached="$1"
 748                         ;;
 749                 --files)
 750                         files="$1"
 751                         ;;
 752                 --for-status)
 753                         for_status="$1"
 754                         ;;
 755                 -n|--summary-limit)
 756                         summary_limit="$2"
 757                         isnumber "$summary_limit" || usage
 758                         shift
 759                         ;;
 760                 --summary-limit=*)
 761                         summary_limit="${1#--summary-limit=}"
 762                         isnumber "$summary_limit" || usage
 763                         ;;
 764                 --)
 765                         shift
 766                         break
 767                         ;;
 768                 -*)
 769                         usage
 770                         ;;
 771                 *)
 772                         break
 773                         ;;
 774                 esac
 775                 shift
 776         done
 777
 778         test $summary_limit = 0 && return
 779
 780         if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
 781         then
 782                 head=$rev
 783                 test $# = 0 || shift
 784         elif test -z "$1" || test "$1" = "HEAD"
 785         then
 786                 # before the first commit: compare with an empty tree
 787                 head=$(git hash-object -w -t tree --stdin </dev/null)
 788                 test -z "$1" || shift
 789         else
 790                 head="HEAD"
 791         fi
 792
 793         if [ -n "$files" ]
 794         then
 795                 test -n "$cached" &&
 796                 die "$(gettext "The --cached option cannot be used with the --files option")"
 797                 diff_cmd=diff-files
 798                 head=
 799         fi
 800
 801         cd_to_toplevel
 802         eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
 803         # Get modified modules cared by user
 804         modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
 805                 sane_egrep '^:([0-7]* )?160000' |
 806                 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
 807                 do
 808                         # Always show modules deleted or type-changed (blob<->module)
 809                         if test "$status" = D || test "$status" = T
 810                         then
 811                                 printf '%s\n' "$sm_path"
 812                                 continue
 813                         fi
 814                         # Respect the ignore setting for --for-status.
 815                         if test -n "$for_status"
 816                         then
 817                                 name=$(git submodule--helper name "$sm_path")
 818                                 ignore_config=$(get_submodule_config "$name" ignore none)
 819                                 test $status != A && test $ignore_config = all && continue
 820                         fi
 821                         # Also show added or modified modules which are checked out
 822                         GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
 823                         printf '%s\n' "$sm_path"
 824                 done
 825         )
 826
 827         test -z "$modules" && return
 828
 829         git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
 830         sane_egrep '^:([0-7]* )?160000' |
 831         cut -c2- |
 832         while read -r mod_src mod_dst sha1_src sha1_dst status name
 833         do
 834                 if test -z "$cached" &&
 835                         test $sha1_dst = 0000000000000000000000000000000000000000
 836                 then
 837                         case "$mod_dst" in
 838                         160000)
 839                                 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
 840                                 ;;
 841                         100644 | 100755 | 120000)
 842                                 sha1_dst=$(git hash-object $name)
 843                                 ;;
 844                         000000)
 845                                 ;; # removed
 846                         *)
 847                                 # unexpected type
 848                                 eval_gettextln "unexpected mode \$mod_dst" >&2
 849                                 continue ;;
 850                         esac
 851                 fi
 852                 missing_src=
 853                 missing_dst=
 854
 855                 test $mod_src = 160000 &&
 856                 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
 857                 missing_src=t
 858
 859                 test $mod_dst = 160000 &&
 860                 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
 861                 missing_dst=t
 862
 863                 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
 864
 865                 total_commits=
 866                 case "$missing_src,$missing_dst" in
 867                 t,)
 868                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_src")"
 869                         ;;
 870                 ,t)
 871                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_dst")"
 872                         ;;
 873                 t,t)
 874                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
 875                         ;;
 876                 *)
 877                         errmsg=
 878                         total_commits=$(
 879                         if test $mod_src = 160000 && test $mod_dst = 160000
 880                         then
 881                                 range="$sha1_src...$sha1_dst"
 882                         elif test $mod_src = 160000
 883                         then
 884                                 range=$sha1_src
 885                         else
 886                                 range=$sha1_dst
 887                         fi
 888                         GIT_DIR="$name/.git" \
 889                         git rev-list --first-parent $range -- | wc -l
 890                         )
 891                         total_commits=" ($(($total_commits + 0)))"
 892                         ;;
 893                 esac
 894
 895                 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
 896                 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
 897                 if test $status = T
 898                 then
 899                         blob="$(gettext "blob")"
 900                         submodule="$(gettext "submodule")"
 901                         if test $mod_dst = 160000
 902                         then
 903                                 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
 904                         else
 905                                 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
 906                         fi
 907                 else
 908                         echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
 909                 fi
 910                 if test -n "$errmsg"
 911                 then
 912                         # Don't give error msg for modification whose dst is not submodule
 913                         # i.e. deleted or changed to blob
 914                         test $mod_dst = 160000 && echo "$errmsg"
 915                 else
 916                         if test $mod_src = 160000 && test $mod_dst = 160000
 917                         then
 918                                 limit=
 919                                 test $summary_limit -gt 0 && limit="-$summary_limit"
 920                                 GIT_DIR="$name/.git" \
 921                                 git log $limit --pretty='format:  %m %s' \
 922                                 --first-parent $sha1_src...$sha1_dst
 923                         elif test $mod_dst = 160000
 924                         then
 925                                 GIT_DIR="$name/.git" \
 926                                 git log --pretty='format:  > %s' -1 $sha1_dst
 927                         else
 928                                 GIT_DIR="$name/.git" \
 929                                 git log --pretty='format:  < %s' -1 $sha1_src
 930                         fi
 931                         echo
 932                 fi
 933                 echo
 934         done
 935 }
 936 #
 937 # List all submodules, prefixed with:
 938 #  - submodule not initialized
 939 #  + different revision checked out
 940 #
 941 # If --cached was specified the revision in the index will be printed
 942 # instead of the currently checked out revision.
 943 #
 944 # $@ = requested paths (default to all)
 945 #
 946 cmd_status()
 947 {
 948         # parse $args after "submodule ... status".
 949         while test $# -ne 0
 950         do
 951                 case "$1" in
 952                 -q|--quiet)
 953                         GIT_QUIET=1
 954                         ;;
 955                 --cached)
 956                         cached=1
 957                         ;;
 958                 --recursive)
 959                         recursive=1
 960                         ;;
 961                 --)
 962                         shift
 963                         break
 964                         ;;
 965                 -*)
 966                         usage
 967                         ;;
 968                 *)
 969                         break
 970                         ;;
 971                 esac
 972                 shift
 973         done
 974
 975         git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
 976 }
 977 #
 978 # Sync remote urls for submodules
 979 # This makes the value for remote.$remote.url match the value
 980 # specified in .gitmodules.
 981 #
 982 cmd_sync()
 983 {
 984         while test $# -ne 0
 985         do
 986                 case "$1" in
 987                 -q|--quiet)
 988                         GIT_QUIET=1
 989                         shift
 990                         ;;
 991                 --recursive)
 992                         recursive=1
 993                         shift
 994                         ;;
 995                 --)
 996                         shift
 997                         break
 998                         ;;
 999                 -*)
1000                         usage
1001                         ;;
1002                 *)
1003                         break
1004                         ;;
1005                 esac
1006         done
1007
1008         git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
1009 }
1010
1011 cmd_absorbgitdirs()
1012 {
1013         git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
1014 }
1015
1016 # This loop parses the command line arguments to find the
1017 # subcommand name to dispatch.  Parsing of the subcommand specific
1018 # options are primarily done by the subcommand implementations.
1019 # Subcommand specific options such as --branch and --cached are
1020 # parsed here as well, for backward compatibility.
1021
1022 while test $# != 0 && test -z "$command"
1023 do
1024         case "$1" in
1025         add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
1026                 command=$1
1027                 ;;
1028         -q|--quiet)
1029                 GIT_QUIET=1
1030                 ;;
1031         -b|--branch)
1032                 case "$2" in
1033                 '')
1034                         usage
1035                         ;;
1036                 esac
1037                 branch="$2"; shift
1038                 ;;
1039         --cached)
1040                 cached="$1"
1041                 ;;
1042         --)
1043                 break
1044                 ;;
1045         -*)
1046                 usage
1047                 ;;
1048         *)
1049                 break
1050                 ;;
1051         esac
1052         shift
1053 done
1054
1055 # No command word defaults to "status"
1056 if test -z "$command"
1057 then
1058     if test $# = 0
1059     then
1060         command=status
1061     else
1062         usage
1063     fi
1064 fi
1065
1066 # "-b branch" is accepted only by "add"
1067 if test -n "$branch" && test "$command" != add
1068 then
1069         usage
1070 fi
1071
1072 # "--cached" is accepted only by "status" and "summary"
1073 if test -n "$cached" && test "$command" != status && test "$command" != summary
1074 then
1075         usage
1076 fi
1077
1078 "cmd_$command" "$@"