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