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