git-submodule.shon commit submodule: port submodule subcommand 'foreach' from shell to C (fc1b924)
   1#!/bin/sh
   2#
   3# git-submodule.sh: add, init, update or list git submodules
   4#
   5# Copyright (c) 2007 Lars Hjemli
   6
   7dashless=$(basename "$0" | sed -e 's/-/ /')
   8USAGE="[--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>...]"
  17OPTIONS_SPEC=
  18SUBDIRECTORY_OK=Yes
  19. git-sh-setup
  20. git-parse-remote
  21require_work_tree
  22wt_prefix=$(git rev-parse --show-prefix)
  23cd_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.
  27GIT_PROTOCOL_FROM_USER=0
  28export GIT_PROTOCOL_FROM_USER
  29
  30command=
  31branch=
  32force=
  33reference=
  34cached=
  35recursive=
  36init=
  37files=
  38remote=
  39nofetch=
  40update=
  41prefix=
  42custom_name=
  43depth=
  44progress=
  45
  46die_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#
  67get_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
  79isnumber()
  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.
  87sanitize_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#
 102cmd_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
 221Use -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 "\
 250If you want to reuse this local git directory instead of cloning again from
 251  \$realrepo
 252use the '--force' option. If the local git directory is not the correct repo
 253or 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#
 304cmd_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        git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
 327}
 328
 329#
 330# Register submodules in .git/config
 331#
 332# $@ = requested paths (default to all)
 333#
 334cmd_init()
 335{
 336        # parse $args after "submodule ... init".
 337        while test $# -ne 0
 338        do
 339                case "$1" in
 340                -q|--quiet)
 341                        GIT_QUIET=1
 342                        ;;
 343                --)
 344                        shift
 345                        break
 346                        ;;
 347                -*)
 348                        usage
 349                        ;;
 350                *)
 351                        break
 352                        ;;
 353                esac
 354                shift
 355        done
 356
 357        git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet}  "$@"
 358}
 359
 360#
 361# Unregister submodules from .git/config and remove their work tree
 362#
 363cmd_deinit()
 364{
 365        # parse $args after "submodule ... deinit".
 366        deinit_all=
 367        while test $# -ne 0
 368        do
 369                case "$1" in
 370                -f|--force)
 371                        force=$1
 372                        ;;
 373                -q|--quiet)
 374                        GIT_QUIET=1
 375                        ;;
 376                --all)
 377                        deinit_all=t
 378                        ;;
 379                --)
 380                        shift
 381                        break
 382                        ;;
 383                -*)
 384                        usage
 385                        ;;
 386                *)
 387                        break
 388                        ;;
 389                esac
 390                shift
 391        done
 392
 393        git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
 394}
 395
 396is_tip_reachable () (
 397        sanitize_submodule_env &&
 398        cd "$1" &&
 399        rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
 400        test -z "$rev"
 401)
 402
 403fetch_in_submodule () (
 404        sanitize_submodule_env &&
 405        cd "$1" &&
 406        case "$2" in
 407        '')
 408                git fetch ;;
 409        *)
 410                shift
 411                git fetch $(get_default_remote) "$@" ;;
 412        esac
 413)
 414
 415#
 416# Update each submodule path to correct revision, using clone and checkout as needed
 417#
 418# $@ = requested paths (default to all)
 419#
 420cmd_update()
 421{
 422        # parse $args after "submodule ... update".
 423        while test $# -ne 0
 424        do
 425                case "$1" in
 426                -q|--quiet)
 427                        GIT_QUIET=1
 428                        ;;
 429                --progress)
 430                        progress="--progress"
 431                        ;;
 432                -i|--init)
 433                        init=1
 434                        ;;
 435                --remote)
 436                        remote=1
 437                        ;;
 438                -N|--no-fetch)
 439                        nofetch=1
 440                        ;;
 441                -f|--force)
 442                        force=$1
 443                        ;;
 444                -r|--rebase)
 445                        update="rebase"
 446                        ;;
 447                --reference)
 448                        case "$2" in '') usage ;; esac
 449                        reference="--reference=$2"
 450                        shift
 451                        ;;
 452                --reference=*)
 453                        reference="$1"
 454                        ;;
 455                -m|--merge)
 456                        update="merge"
 457                        ;;
 458                --recursive)
 459                        recursive=1
 460                        ;;
 461                --checkout)
 462                        update="checkout"
 463                        ;;
 464                --recommend-shallow)
 465                        recommend_shallow="--recommend-shallow"
 466                        ;;
 467                --no-recommend-shallow)
 468                        recommend_shallow="--no-recommend-shallow"
 469                        ;;
 470                --depth)
 471                        case "$2" in '') usage ;; esac
 472                        depth="--depth=$2"
 473                        shift
 474                        ;;
 475                --depth=*)
 476                        depth=$1
 477                        ;;
 478                -j|--jobs)
 479                        case "$2" in '') usage ;; esac
 480                        jobs="--jobs=$2"
 481                        shift
 482                        ;;
 483                --jobs=*)
 484                        jobs=$1
 485                        ;;
 486                --)
 487                        shift
 488                        break
 489                        ;;
 490                -*)
 491                        usage
 492                        ;;
 493                *)
 494                        break
 495                        ;;
 496                esac
 497                shift
 498        done
 499
 500        if test -n "$init"
 501        then
 502                cmd_init "--" "$@" || return
 503        fi
 504
 505        {
 506        git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
 507                ${progress:+"$progress"} \
 508                ${wt_prefix:+--prefix "$wt_prefix"} \
 509                ${prefix:+--recursive-prefix "$prefix"} \
 510                ${update:+--update "$update"} \
 511                ${reference:+"$reference"} \
 512                ${depth:+--depth "$depth"} \
 513                ${recommend_shallow:+"$recommend_shallow"} \
 514                ${jobs:+$jobs} \
 515                "$@" || echo "#unmatched" $?
 516        } | {
 517        err=
 518        while read -r mode sha1 stage just_cloned sm_path
 519        do
 520                die_if_unmatched "$mode" "$sha1"
 521
 522                name=$(git submodule--helper name "$sm_path") || exit
 523                if ! test -z "$update"
 524                then
 525                        update_module=$update
 526                else
 527                        update_module=$(git config submodule."$name".update)
 528                        if test -z "$update_module"
 529                        then
 530                                update_module="checkout"
 531                        fi
 532                fi
 533
 534                displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
 535
 536                if test $just_cloned -eq 1
 537                then
 538                        subsha1=
 539                        case "$update_module" in
 540                        merge | rebase | none)
 541                                update_module=checkout ;;
 542                        esac
 543                else
 544                        subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
 545                                git rev-parse --verify HEAD) ||
 546                        die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
 547                fi
 548
 549                if test -n "$remote"
 550                then
 551                        branch=$(git submodule--helper remote-branch "$sm_path")
 552                        if test -z "$nofetch"
 553                        then
 554                                # Fetch remote before determining tracking $sha1
 555                                fetch_in_submodule "$sm_path" $depth ||
 556                                die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
 557                        fi
 558                        remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
 559                        sha1=$(sanitize_submodule_env; cd "$sm_path" &&
 560                                git rev-parse --verify "${remote_name}/${branch}") ||
 561                        die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
 562                fi
 563
 564                if test "$subsha1" != "$sha1" || test -n "$force"
 565                then
 566                        subforce=$force
 567                        # If we don't already have a -f flag and the submodule has never been checked out
 568                        if test -z "$subsha1" && test -z "$force"
 569                        then
 570                                subforce="-f"
 571                        fi
 572
 573                        if test -z "$nofetch"
 574                        then
 575                                # Run fetch only if $sha1 isn't present or it
 576                                # is not reachable from a ref.
 577                                is_tip_reachable "$sm_path" "$sha1" ||
 578                                fetch_in_submodule "$sm_path" $depth ||
 579                                die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
 580
 581                                # Now we tried the usual fetch, but $sha1 may
 582                                # not be reachable from any of the refs
 583                                is_tip_reachable "$sm_path" "$sha1" ||
 584                                fetch_in_submodule "$sm_path" $depth "$sha1" ||
 585                                die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
 586                        fi
 587
 588                        must_die_on_failure=
 589                        case "$update_module" in
 590                        checkout)
 591                                command="git checkout $subforce -q"
 592                                die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
 593                                say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
 594                                ;;
 595                        rebase)
 596                                command="git rebase"
 597                                die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
 598                                say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
 599                                must_die_on_failure=yes
 600                                ;;
 601                        merge)
 602                                command="git merge"
 603                                die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
 604                                say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
 605                                must_die_on_failure=yes
 606                                ;;
 607                        !*)
 608                                command="${update_module#!}"
 609                                die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
 610                                say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
 611                                must_die_on_failure=yes
 612                                ;;
 613                        *)
 614                                die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
 615                        esac
 616
 617                        if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
 618                        then
 619                                say "$say_msg"
 620                        elif test -n "$must_die_on_failure"
 621                        then
 622                                die_with_status 2 "$die_msg"
 623                        else
 624                                err="${err};$die_msg"
 625                                continue
 626                        fi
 627                fi
 628
 629                if test -n "$recursive"
 630                then
 631                        (
 632                                prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
 633                                wt_prefix=
 634                                sanitize_submodule_env
 635                                cd "$sm_path" &&
 636                                eval cmd_update
 637                        )
 638                        res=$?
 639                        if test $res -gt 0
 640                        then
 641                                die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
 642                                if test $res -ne 2
 643                                then
 644                                        err="${err};$die_msg"
 645                                        continue
 646                                else
 647                                        die_with_status $res "$die_msg"
 648                                fi
 649                        fi
 650                fi
 651        done
 652
 653        if test -n "$err"
 654        then
 655                OIFS=$IFS
 656                IFS=';'
 657                for e in $err
 658                do
 659                        if test -n "$e"
 660                        then
 661                                echo >&2 "$e"
 662                        fi
 663                done
 664                IFS=$OIFS
 665                exit 1
 666        fi
 667        }
 668}
 669
 670#
 671# Show commit summary for submodules in index or working tree
 672#
 673# If '--cached' is given, show summary between index and given commit,
 674# or between working tree and given commit
 675#
 676# $@ = [commit (default 'HEAD'),] requested paths (default all)
 677#
 678cmd_summary() {
 679        summary_limit=-1
 680        for_status=
 681        diff_cmd=diff-index
 682
 683        # parse $args after "submodule ... summary".
 684        while test $# -ne 0
 685        do
 686                case "$1" in
 687                --cached)
 688                        cached="$1"
 689                        ;;
 690                --files)
 691                        files="$1"
 692                        ;;
 693                --for-status)
 694                        for_status="$1"
 695                        ;;
 696                -n|--summary-limit)
 697                        summary_limit="$2"
 698                        isnumber "$summary_limit" || usage
 699                        shift
 700                        ;;
 701                --summary-limit=*)
 702                        summary_limit="${1#--summary-limit=}"
 703                        isnumber "$summary_limit" || usage
 704                        ;;
 705                --)
 706                        shift
 707                        break
 708                        ;;
 709                -*)
 710                        usage
 711                        ;;
 712                *)
 713                        break
 714                        ;;
 715                esac
 716                shift
 717        done
 718
 719        test $summary_limit = 0 && return
 720
 721        if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
 722        then
 723                head=$rev
 724                test $# = 0 || shift
 725        elif test -z "$1" || test "$1" = "HEAD"
 726        then
 727                # before the first commit: compare with an empty tree
 728                head=$(git hash-object -w -t tree --stdin </dev/null)
 729                test -z "$1" || shift
 730        else
 731                head="HEAD"
 732        fi
 733
 734        if [ -n "$files" ]
 735        then
 736                test -n "$cached" &&
 737                die "$(gettext "The --cached option cannot be used with the --files option")"
 738                diff_cmd=diff-files
 739                head=
 740        fi
 741
 742        cd_to_toplevel
 743        eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
 744        # Get modified modules cared by user
 745        modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
 746                sane_egrep '^:([0-7]* )?160000' |
 747                while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
 748                do
 749                        # Always show modules deleted or type-changed (blob<->module)
 750                        if test "$status" = D || test "$status" = T
 751                        then
 752                                printf '%s\n' "$sm_path"
 753                                continue
 754                        fi
 755                        # Respect the ignore setting for --for-status.
 756                        if test -n "$for_status"
 757                        then
 758                                name=$(git submodule--helper name "$sm_path")
 759                                ignore_config=$(get_submodule_config "$name" ignore none)
 760                                test $status != A && test $ignore_config = all && continue
 761                        fi
 762                        # Also show added or modified modules which are checked out
 763                        GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
 764                        printf '%s\n' "$sm_path"
 765                done
 766        )
 767
 768        test -z "$modules" && return
 769
 770        git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
 771        sane_egrep '^:([0-7]* )?160000' |
 772        cut -c2- |
 773        while read -r mod_src mod_dst sha1_src sha1_dst status name
 774        do
 775                if test -z "$cached" &&
 776                        test $sha1_dst = 0000000000000000000000000000000000000000
 777                then
 778                        case "$mod_dst" in
 779                        160000)
 780                                sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
 781                                ;;
 782                        100644 | 100755 | 120000)
 783                                sha1_dst=$(git hash-object $name)
 784                                ;;
 785                        000000)
 786                                ;; # removed
 787                        *)
 788                                # unexpected type
 789                                eval_gettextln "unexpected mode \$mod_dst" >&2
 790                                continue ;;
 791                        esac
 792                fi
 793                missing_src=
 794                missing_dst=
 795
 796                test $mod_src = 160000 &&
 797                ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
 798                missing_src=t
 799
 800                test $mod_dst = 160000 &&
 801                ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
 802                missing_dst=t
 803
 804                display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
 805
 806                total_commits=
 807                case "$missing_src,$missing_dst" in
 808                t,)
 809                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_src")"
 810                        ;;
 811                ,t)
 812                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_dst")"
 813                        ;;
 814                t,t)
 815                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
 816                        ;;
 817                *)
 818                        errmsg=
 819                        total_commits=$(
 820                        if test $mod_src = 160000 && test $mod_dst = 160000
 821                        then
 822                                range="$sha1_src...$sha1_dst"
 823                        elif test $mod_src = 160000
 824                        then
 825                                range=$sha1_src
 826                        else
 827                                range=$sha1_dst
 828                        fi
 829                        GIT_DIR="$name/.git" \
 830                        git rev-list --first-parent $range -- | wc -l
 831                        )
 832                        total_commits=" ($(($total_commits + 0)))"
 833                        ;;
 834                esac
 835
 836                sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
 837                sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
 838                if test $status = T
 839                then
 840                        blob="$(gettext "blob")"
 841                        submodule="$(gettext "submodule")"
 842                        if test $mod_dst = 160000
 843                        then
 844                                echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
 845                        else
 846                                echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
 847                        fi
 848                else
 849                        echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
 850                fi
 851                if test -n "$errmsg"
 852                then
 853                        # Don't give error msg for modification whose dst is not submodule
 854                        # i.e. deleted or changed to blob
 855                        test $mod_dst = 160000 && echo "$errmsg"
 856                else
 857                        if test $mod_src = 160000 && test $mod_dst = 160000
 858                        then
 859                                limit=
 860                                test $summary_limit -gt 0 && limit="-$summary_limit"
 861                                GIT_DIR="$name/.git" \
 862                                git log $limit --pretty='format:  %m %s' \
 863                                --first-parent $sha1_src...$sha1_dst
 864                        elif test $mod_dst = 160000
 865                        then
 866                                GIT_DIR="$name/.git" \
 867                                git log --pretty='format:  > %s' -1 $sha1_dst
 868                        else
 869                                GIT_DIR="$name/.git" \
 870                                git log --pretty='format:  < %s' -1 $sha1_src
 871                        fi
 872                        echo
 873                fi
 874                echo
 875        done
 876}
 877#
 878# List all submodules, prefixed with:
 879#  - submodule not initialized
 880#  + different revision checked out
 881#
 882# If --cached was specified the revision in the index will be printed
 883# instead of the currently checked out revision.
 884#
 885# $@ = requested paths (default to all)
 886#
 887cmd_status()
 888{
 889        # parse $args after "submodule ... status".
 890        while test $# -ne 0
 891        do
 892                case "$1" in
 893                -q|--quiet)
 894                        GIT_QUIET=1
 895                        ;;
 896                --cached)
 897                        cached=1
 898                        ;;
 899                --recursive)
 900                        recursive=1
 901                        ;;
 902                --)
 903                        shift
 904                        break
 905                        ;;
 906                -*)
 907                        usage
 908                        ;;
 909                *)
 910                        break
 911                        ;;
 912                esac
 913                shift
 914        done
 915
 916        git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
 917}
 918#
 919# Sync remote urls for submodules
 920# This makes the value for remote.$remote.url match the value
 921# specified in .gitmodules.
 922#
 923cmd_sync()
 924{
 925        while test $# -ne 0
 926        do
 927                case "$1" in
 928                -q|--quiet)
 929                        GIT_QUIET=1
 930                        shift
 931                        ;;
 932                --recursive)
 933                        recursive=1
 934                        shift
 935                        ;;
 936                --)
 937                        shift
 938                        break
 939                        ;;
 940                -*)
 941                        usage
 942                        ;;
 943                *)
 944                        break
 945                        ;;
 946                esac
 947        done
 948
 949        git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
 950}
 951
 952cmd_absorbgitdirs()
 953{
 954        git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
 955}
 956
 957# This loop parses the command line arguments to find the
 958# subcommand name to dispatch.  Parsing of the subcommand specific
 959# options are primarily done by the subcommand implementations.
 960# Subcommand specific options such as --branch and --cached are
 961# parsed here as well, for backward compatibility.
 962
 963while test $# != 0 && test -z "$command"
 964do
 965        case "$1" in
 966        add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
 967                command=$1
 968                ;;
 969        -q|--quiet)
 970                GIT_QUIET=1
 971                ;;
 972        -b|--branch)
 973                case "$2" in
 974                '')
 975                        usage
 976                        ;;
 977                esac
 978                branch="$2"; shift
 979                ;;
 980        --cached)
 981                cached="$1"
 982                ;;
 983        --)
 984                break
 985                ;;
 986        -*)
 987                usage
 988                ;;
 989        *)
 990                break
 991                ;;
 992        esac
 993        shift
 994done
 995
 996# No command word defaults to "status"
 997if test -z "$command"
 998then
 999    if test $# = 0
1000    then
1001        command=status
1002    else
1003        usage
1004    fi
1005fi
1006
1007# "-b branch" is accepted only by "add"
1008if test -n "$branch" && test "$command" != add
1009then
1010        usage
1011fi
1012
1013# "--cached" is accepted only by "status" and "summary"
1014if test -n "$cached" && test "$command" != status && test "$command" != summary
1015then
1016        usage
1017fi
1018
1019"cmd_$command" "$@"