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