git-submodule.shon commit Merge branch 'jk/loose-object-fsck' (42ace93)
   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        git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
 208        die "$(eval_gettext "'\$sm_path' already exists in the index")"
 209
 210        if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
 211        then
 212                eval_gettextln "The following path is ignored by one of your .gitignore files:
 213\$sm_path
 214Use -f if you really want to add it." >&2
 215                exit 1
 216        fi
 217
 218        if test -n "$custom_name"
 219        then
 220                sm_name="$custom_name"
 221        else
 222                sm_name="$sm_path"
 223        fi
 224
 225        # perhaps the path exists and is already a git repo, else clone it
 226        if test -e "$sm_path"
 227        then
 228                if test -d "$sm_path"/.git || test -f "$sm_path"/.git
 229                then
 230                        eval_gettextln "Adding existing repo at '\$sm_path' to the index"
 231                else
 232                        die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
 233                fi
 234
 235        else
 236                if test -d ".git/modules/$sm_name"
 237                then
 238                        if test -z "$force"
 239                        then
 240                                eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
 241                                GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^,"  ", -e s,' (fetch)',, >&2
 242                                die "$(eval_gettextln "\
 243If you want to reuse this local git directory instead of cloning again from
 244  \$realrepo
 245use the '--force' option. If the local git directory is not the correct repo
 246or you are unsure what this means choose another name with the '--name' option.")"
 247                        else
 248                                eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
 249                        fi
 250                fi
 251                git submodule--helper clone ${GIT_QUIET:+--quiet} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${depth:+"$depth"} || exit
 252                (
 253                        sanitize_submodule_env
 254                        cd "$sm_path" &&
 255                        # ash fails to wordsplit ${branch:+-b "$branch"...}
 256                        case "$branch" in
 257                        '') git checkout -f -q ;;
 258                        ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
 259                        esac
 260                ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
 261        fi
 262        git config submodule."$sm_name".url "$realrepo"
 263
 264        git add $force "$sm_path" ||
 265        die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
 266
 267        git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
 268        git config -f .gitmodules submodule."$sm_name".url "$repo" &&
 269        if test -n "$branch"
 270        then
 271                git config -f .gitmodules submodule."$sm_name".branch "$branch"
 272        fi &&
 273        git add --force .gitmodules ||
 274        die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
 275}
 276
 277#
 278# Execute an arbitrary command sequence in each checked out
 279# submodule
 280#
 281# $@ = command to execute
 282#
 283cmd_foreach()
 284{
 285        # parse $args after "submodule ... foreach".
 286        while test $# -ne 0
 287        do
 288                case "$1" in
 289                -q|--quiet)
 290                        GIT_QUIET=1
 291                        ;;
 292                --recursive)
 293                        recursive=1
 294                        ;;
 295                -*)
 296                        usage
 297                        ;;
 298                *)
 299                        break
 300                        ;;
 301                esac
 302                shift
 303        done
 304
 305        toplevel=$(pwd)
 306
 307        # dup stdin so that it can be restored when running the external
 308        # command in the subshell (and a recursive call to this function)
 309        exec 3<&0
 310
 311        {
 312                git submodule--helper list --prefix "$wt_prefix" ||
 313                echo "#unmatched" $?
 314        } |
 315        while read mode sha1 stage sm_path
 316        do
 317                die_if_unmatched "$mode" "$sha1"
 318                if test -e "$sm_path"/.git
 319                then
 320                        displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
 321                        say "$(eval_gettext "Entering '\$displaypath'")"
 322                        name=$(git submodule--helper name "$sm_path")
 323                        (
 324                                prefix="$prefix$sm_path/"
 325                                sanitize_submodule_env
 326                                cd "$sm_path" &&
 327                                sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") &&
 328                                # we make $path available to scripts ...
 329                                path=$sm_path &&
 330                                if test $# -eq 1
 331                                then
 332                                        eval "$1"
 333                                else
 334                                        "$@"
 335                                fi &&
 336                                if test -n "$recursive"
 337                                then
 338                                        cmd_foreach "--recursive" "$@"
 339                                fi
 340                        ) <&3 3<&- ||
 341                        die "$(eval_gettext "Stopping at '\$displaypath'; script returned non-zero status.")"
 342                fi
 343        done
 344}
 345
 346#
 347# Register submodules in .git/config
 348#
 349# $@ = requested paths (default to all)
 350#
 351cmd_init()
 352{
 353        # parse $args after "submodule ... init".
 354        while test $# -ne 0
 355        do
 356                case "$1" in
 357                -q|--quiet)
 358                        GIT_QUIET=1
 359                        ;;
 360                --)
 361                        shift
 362                        break
 363                        ;;
 364                -*)
 365                        usage
 366                        ;;
 367                *)
 368                        break
 369                        ;;
 370                esac
 371                shift
 372        done
 373
 374        git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet}  "$@"
 375}
 376
 377#
 378# Unregister submodules from .git/config and remove their work tree
 379#
 380cmd_deinit()
 381{
 382        # parse $args after "submodule ... deinit".
 383        deinit_all=
 384        while test $# -ne 0
 385        do
 386                case "$1" in
 387                -f|--force)
 388                        force=$1
 389                        ;;
 390                -q|--quiet)
 391                        GIT_QUIET=1
 392                        ;;
 393                --all)
 394                        deinit_all=t
 395                        ;;
 396                --)
 397                        shift
 398                        break
 399                        ;;
 400                -*)
 401                        usage
 402                        ;;
 403                *)
 404                        break
 405                        ;;
 406                esac
 407                shift
 408        done
 409
 410        if test -n "$deinit_all" && test "$#" -ne 0
 411        then
 412                echo >&2 "$(eval_gettext "pathspec and --all are incompatible")"
 413                usage
 414        fi
 415        if test $# = 0 && test -z "$deinit_all"
 416        then
 417                die "$(eval_gettext "Use '--all' if you really want to deinitialize all submodules")"
 418        fi
 419
 420        {
 421                git submodule--helper list --prefix "$wt_prefix" "$@" ||
 422                echo "#unmatched" $?
 423        } |
 424        while read mode sha1 stage sm_path
 425        do
 426                die_if_unmatched "$mode" "$sha1"
 427                name=$(git submodule--helper name "$sm_path") || exit
 428
 429                displaypath=$(git submodule--helper relative-path "$sm_path" "$wt_prefix")
 430
 431                # Remove the submodule work tree (unless the user already did it)
 432                if test -d "$sm_path"
 433                then
 434                        # Protect submodules containing a .git directory
 435                        if test -d "$sm_path/.git"
 436                        then
 437                                die "$(eval_gettext "\
 438Submodule work tree '\$displaypath' contains a .git directory
 439(use 'rm -rf' if you really want to remove it including all of its history)")"
 440                        fi
 441
 442                        if test -z "$force"
 443                        then
 444                                git rm -qn "$sm_path" ||
 445                                die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
 446                        fi
 447                        rm -rf "$sm_path" &&
 448                        say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
 449                        say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
 450                fi
 451
 452                mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
 453
 454                # Remove the .git/config entries (unless the user already did it)
 455                if test -n "$(git config --get-regexp submodule."$name\.")"
 456                then
 457                        # Remove the whole section so we have a clean state when
 458                        # the user later decides to init this submodule again
 459                        url=$(git config submodule."$name".url)
 460                        git config --remove-section submodule."$name" 2>/dev/null &&
 461                        say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
 462                fi
 463        done
 464}
 465
 466is_tip_reachable () (
 467        sanitize_submodule_env &&
 468        cd "$1" &&
 469        rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
 470        test -z "$rev"
 471)
 472
 473fetch_in_submodule () (
 474        sanitize_submodule_env &&
 475        cd "$1" &&
 476        case "$2" in
 477        '')
 478                git fetch ;;
 479        *)
 480                shift
 481                git fetch $(get_default_remote) "$@" ;;
 482        esac
 483)
 484
 485#
 486# Update each submodule path to correct revision, using clone and checkout as needed
 487#
 488# $@ = requested paths (default to all)
 489#
 490cmd_update()
 491{
 492        # parse $args after "submodule ... update".
 493        while test $# -ne 0
 494        do
 495                case "$1" in
 496                -q|--quiet)
 497                        GIT_QUIET=1
 498                        ;;
 499                --progress)
 500                        progress="--progress"
 501                        ;;
 502                -i|--init)
 503                        init=1
 504                        ;;
 505                --remote)
 506                        remote=1
 507                        ;;
 508                -N|--no-fetch)
 509                        nofetch=1
 510                        ;;
 511                -f|--force)
 512                        force=$1
 513                        ;;
 514                -r|--rebase)
 515                        update="rebase"
 516                        ;;
 517                --reference)
 518                        case "$2" in '') usage ;; esac
 519                        reference="--reference=$2"
 520                        shift
 521                        ;;
 522                --reference=*)
 523                        reference="$1"
 524                        ;;
 525                -m|--merge)
 526                        update="merge"
 527                        ;;
 528                --recursive)
 529                        recursive=1
 530                        ;;
 531                --checkout)
 532                        update="checkout"
 533                        ;;
 534                --recommend-shallow)
 535                        recommend_shallow="--recommend-shallow"
 536                        ;;
 537                --no-recommend-shallow)
 538                        recommend_shallow="--no-recommend-shallow"
 539                        ;;
 540                --depth)
 541                        case "$2" in '') usage ;; esac
 542                        depth="--depth=$2"
 543                        shift
 544                        ;;
 545                --depth=*)
 546                        depth=$1
 547                        ;;
 548                -j|--jobs)
 549                        case "$2" in '') usage ;; esac
 550                        jobs="--jobs=$2"
 551                        shift
 552                        ;;
 553                --jobs=*)
 554                        jobs=$1
 555                        ;;
 556                --)
 557                        shift
 558                        break
 559                        ;;
 560                -*)
 561                        usage
 562                        ;;
 563                *)
 564                        break
 565                        ;;
 566                esac
 567                shift
 568        done
 569
 570        if test -n "$init"
 571        then
 572                cmd_init "--" "$@" || return
 573        fi
 574
 575        {
 576        git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
 577                ${progress:+"$progress"} \
 578                ${wt_prefix:+--prefix "$wt_prefix"} \
 579                ${prefix:+--recursive-prefix "$prefix"} \
 580                ${update:+--update "$update"} \
 581                ${reference:+"$reference"} \
 582                ${depth:+--depth "$depth"} \
 583                ${recommend_shallow:+"$recommend_shallow"} \
 584                ${jobs:+$jobs} \
 585                "$@" || echo "#unmatched" $?
 586        } | {
 587        err=
 588        while read mode sha1 stage just_cloned sm_path
 589        do
 590                die_if_unmatched "$mode" "$sha1"
 591
 592                name=$(git submodule--helper name "$sm_path") || exit
 593                url=$(git config submodule."$name".url)
 594                if ! test -z "$update"
 595                then
 596                        update_module=$update
 597                else
 598                        update_module=$(git config submodule."$name".update)
 599                        if test -z "$update_module"
 600                        then
 601                                update_module="checkout"
 602                        fi
 603                fi
 604
 605                displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
 606
 607                if test $just_cloned -eq 1
 608                then
 609                        subsha1=
 610                        update_module=checkout
 611                else
 612                        subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
 613                                git rev-parse --verify HEAD) ||
 614                        die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
 615                fi
 616
 617                if test -n "$remote"
 618                then
 619                        branch=$(git submodule--helper remote-branch "$sm_path")
 620                        if test -z "$nofetch"
 621                        then
 622                                # Fetch remote before determining tracking $sha1
 623                                fetch_in_submodule "$sm_path" $depth ||
 624                                die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
 625                        fi
 626                        remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
 627                        sha1=$(sanitize_submodule_env; cd "$sm_path" &&
 628                                git rev-parse --verify "${remote_name}/${branch}") ||
 629                        die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
 630                fi
 631
 632                if test "$subsha1" != "$sha1" || test -n "$force"
 633                then
 634                        subforce=$force
 635                        # If we don't already have a -f flag and the submodule has never been checked out
 636                        if test -z "$subsha1" && test -z "$force"
 637                        then
 638                                subforce="-f"
 639                        fi
 640
 641                        if test -z "$nofetch"
 642                        then
 643                                # Run fetch only if $sha1 isn't present or it
 644                                # is not reachable from a ref.
 645                                is_tip_reachable "$sm_path" "$sha1" ||
 646                                fetch_in_submodule "$sm_path" $depth ||
 647                                die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
 648
 649                                # Now we tried the usual fetch, but $sha1 may
 650                                # not be reachable from any of the refs
 651                                is_tip_reachable "$sm_path" "$sha1" ||
 652                                fetch_in_submodule "$sm_path" $depth "$sha1" ||
 653                                die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
 654                        fi
 655
 656                        must_die_on_failure=
 657                        case "$update_module" in
 658                        checkout)
 659                                command="git checkout $subforce -q"
 660                                die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
 661                                say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
 662                                ;;
 663                        rebase)
 664                                command="git rebase"
 665                                die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
 666                                say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
 667                                must_die_on_failure=yes
 668                                ;;
 669                        merge)
 670                                command="git merge"
 671                                die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
 672                                say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
 673                                must_die_on_failure=yes
 674                                ;;
 675                        !*)
 676                                command="${update_module#!}"
 677                                die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
 678                                say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
 679                                must_die_on_failure=yes
 680                                ;;
 681                        *)
 682                                die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
 683                        esac
 684
 685                        if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
 686                        then
 687                                say "$say_msg"
 688                        elif test -n "$must_die_on_failure"
 689                        then
 690                                die_with_status 2 "$die_msg"
 691                        else
 692                                err="${err};$die_msg"
 693                                continue
 694                        fi
 695                fi
 696
 697                if test -n "$recursive"
 698                then
 699                        (
 700                                prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
 701                                wt_prefix=
 702                                sanitize_submodule_env
 703                                cd "$sm_path" &&
 704                                eval cmd_update
 705                        )
 706                        res=$?
 707                        if test $res -gt 0
 708                        then
 709                                die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
 710                                if test $res -ne 2
 711                                then
 712                                        err="${err};$die_msg"
 713                                        continue
 714                                else
 715                                        die_with_status $res "$die_msg"
 716                                fi
 717                        fi
 718                fi
 719        done
 720
 721        if test -n "$err"
 722        then
 723                OIFS=$IFS
 724                IFS=';'
 725                for e in $err
 726                do
 727                        if test -n "$e"
 728                        then
 729                                echo >&2 "$e"
 730                        fi
 731                done
 732                IFS=$OIFS
 733                exit 1
 734        fi
 735        }
 736}
 737
 738set_name_rev () {
 739        revname=$( (
 740                sanitize_submodule_env
 741                cd "$1" && {
 742                        git describe "$2" 2>/dev/null ||
 743                        git describe --tags "$2" 2>/dev/null ||
 744                        git describe --contains "$2" 2>/dev/null ||
 745                        git describe --all --always "$2"
 746                }
 747        ) )
 748        test -z "$revname" || revname=" ($revname)"
 749}
 750#
 751# Show commit summary for submodules in index or working tree
 752#
 753# If '--cached' is given, show summary between index and given commit,
 754# or between working tree and given commit
 755#
 756# $@ = [commit (default 'HEAD'),] requested paths (default all)
 757#
 758cmd_summary() {
 759        summary_limit=-1
 760        for_status=
 761        diff_cmd=diff-index
 762
 763        # parse $args after "submodule ... summary".
 764        while test $# -ne 0
 765        do
 766                case "$1" in
 767                --cached)
 768                        cached="$1"
 769                        ;;
 770                --files)
 771                        files="$1"
 772                        ;;
 773                --for-status)
 774                        for_status="$1"
 775                        ;;
 776                -n|--summary-limit)
 777                        summary_limit="$2"
 778                        isnumber "$summary_limit" || usage
 779                        shift
 780                        ;;
 781                --summary-limit=*)
 782                        summary_limit="${1#--summary-limit=}"
 783                        isnumber "$summary_limit" || usage
 784                        ;;
 785                --)
 786                        shift
 787                        break
 788                        ;;
 789                -*)
 790                        usage
 791                        ;;
 792                *)
 793                        break
 794                        ;;
 795                esac
 796                shift
 797        done
 798
 799        test $summary_limit = 0 && return
 800
 801        if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
 802        then
 803                head=$rev
 804                test $# = 0 || shift
 805        elif test -z "$1" || test "$1" = "HEAD"
 806        then
 807                # before the first commit: compare with an empty tree
 808                head=$(git hash-object -w -t tree --stdin </dev/null)
 809                test -z "$1" || shift
 810        else
 811                head="HEAD"
 812        fi
 813
 814        if [ -n "$files" ]
 815        then
 816                test -n "$cached" &&
 817                die "$(gettext "The --cached option cannot be used with the --files option")"
 818                diff_cmd=diff-files
 819                head=
 820        fi
 821
 822        cd_to_toplevel
 823        eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
 824        # Get modified modules cared by user
 825        modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
 826                sane_egrep '^:([0-7]* )?160000' |
 827                while read mod_src mod_dst sha1_src sha1_dst status sm_path
 828                do
 829                        # Always show modules deleted or type-changed (blob<->module)
 830                        if test "$status" = D || test "$status" = T
 831                        then
 832                                printf '%s\n' "$sm_path"
 833                                continue
 834                        fi
 835                        # Respect the ignore setting for --for-status.
 836                        if test -n "$for_status"
 837                        then
 838                                name=$(git submodule--helper name "$sm_path")
 839                                ignore_config=$(get_submodule_config "$name" ignore none)
 840                                test $status != A && test $ignore_config = all && continue
 841                        fi
 842                        # Also show added or modified modules which are checked out
 843                        GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
 844                        printf '%s\n' "$sm_path"
 845                done
 846        )
 847
 848        test -z "$modules" && return
 849
 850        git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
 851        sane_egrep '^:([0-7]* )?160000' |
 852        cut -c2- |
 853        while read mod_src mod_dst sha1_src sha1_dst status name
 854        do
 855                if test -z "$cached" &&
 856                        test $sha1_dst = 0000000000000000000000000000000000000000
 857                then
 858                        case "$mod_dst" in
 859                        160000)
 860                                sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
 861                                ;;
 862                        100644 | 100755 | 120000)
 863                                sha1_dst=$(git hash-object $name)
 864                                ;;
 865                        000000)
 866                                ;; # removed
 867                        *)
 868                                # unexpected type
 869                                eval_gettextln "unexpected mode \$mod_dst" >&2
 870                                continue ;;
 871                        esac
 872                fi
 873                missing_src=
 874                missing_dst=
 875
 876                test $mod_src = 160000 &&
 877                ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
 878                missing_src=t
 879
 880                test $mod_dst = 160000 &&
 881                ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
 882                missing_dst=t
 883
 884                display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
 885
 886                total_commits=
 887                case "$missing_src,$missing_dst" in
 888                t,)
 889                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_src")"
 890                        ;;
 891                ,t)
 892                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_dst")"
 893                        ;;
 894                t,t)
 895                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
 896                        ;;
 897                *)
 898                        errmsg=
 899                        total_commits=$(
 900                        if test $mod_src = 160000 && test $mod_dst = 160000
 901                        then
 902                                range="$sha1_src...$sha1_dst"
 903                        elif test $mod_src = 160000
 904                        then
 905                                range=$sha1_src
 906                        else
 907                                range=$sha1_dst
 908                        fi
 909                        GIT_DIR="$name/.git" \
 910                        git rev-list --first-parent $range -- | wc -l
 911                        )
 912                        total_commits=" ($(($total_commits + 0)))"
 913                        ;;
 914                esac
 915
 916                sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
 917                sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
 918                if test $status = T
 919                then
 920                        blob="$(gettext "blob")"
 921                        submodule="$(gettext "submodule")"
 922                        if test $mod_dst = 160000
 923                        then
 924                                echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
 925                        else
 926                                echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
 927                        fi
 928                else
 929                        echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
 930                fi
 931                if test -n "$errmsg"
 932                then
 933                        # Don't give error msg for modification whose dst is not submodule
 934                        # i.e. deleted or changed to blob
 935                        test $mod_dst = 160000 && echo "$errmsg"
 936                else
 937                        if test $mod_src = 160000 && test $mod_dst = 160000
 938                        then
 939                                limit=
 940                                test $summary_limit -gt 0 && limit="-$summary_limit"
 941                                GIT_DIR="$name/.git" \
 942                                git log $limit --pretty='format:  %m %s' \
 943                                --first-parent $sha1_src...$sha1_dst
 944                        elif test $mod_dst = 160000
 945                        then
 946                                GIT_DIR="$name/.git" \
 947                                git log --pretty='format:  > %s' -1 $sha1_dst
 948                        else
 949                                GIT_DIR="$name/.git" \
 950                                git log --pretty='format:  < %s' -1 $sha1_src
 951                        fi
 952                        echo
 953                fi
 954                echo
 955        done
 956}
 957#
 958# List all submodules, prefixed with:
 959#  - submodule not initialized
 960#  + different revision checked out
 961#
 962# If --cached was specified the revision in the index will be printed
 963# instead of the currently checked out revision.
 964#
 965# $@ = requested paths (default to all)
 966#
 967cmd_status()
 968{
 969        # parse $args after "submodule ... status".
 970        while test $# -ne 0
 971        do
 972                case "$1" in
 973                -q|--quiet)
 974                        GIT_QUIET=1
 975                        ;;
 976                --cached)
 977                        cached=1
 978                        ;;
 979                --recursive)
 980                        recursive=1
 981                        ;;
 982                --)
 983                        shift
 984                        break
 985                        ;;
 986                -*)
 987                        usage
 988                        ;;
 989                *)
 990                        break
 991                        ;;
 992                esac
 993                shift
 994        done
 995
 996        {
 997                git submodule--helper list --prefix "$wt_prefix" "$@" ||
 998                echo "#unmatched" $?
 999        } |
1000        while read mode sha1 stage sm_path
1001        do
1002                die_if_unmatched "$mode" "$sha1"
1003                name=$(git submodule--helper name "$sm_path") || exit
1004                url=$(git config submodule."$name".url)
1005                displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
1006                if test "$stage" = U
1007                then
1008                        say "U$sha1 $displaypath"
1009                        continue
1010                fi
1011                if test -z "$url" ||
1012                {
1013                        ! test -d "$sm_path"/.git &&
1014                        ! test -f "$sm_path"/.git
1015                }
1016                then
1017                        say "-$sha1 $displaypath"
1018                        continue;
1019                fi
1020                if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1021                then
1022                        set_name_rev "$sm_path" "$sha1"
1023                        say " $sha1 $displaypath$revname"
1024                else
1025                        if test -z "$cached"
1026                        then
1027                                sha1=$(sanitize_submodule_env; cd "$sm_path" && git rev-parse --verify HEAD)
1028                        fi
1029                        set_name_rev "$sm_path" "$sha1"
1030                        say "+$sha1 $displaypath$revname"
1031                fi
1032
1033                if test -n "$recursive"
1034                then
1035                        (
1036                                prefix="$displaypath/"
1037                                sanitize_submodule_env
1038                                wt_prefix=
1039                                cd "$sm_path" &&
1040                                eval cmd_status
1041                        ) ||
1042                        die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1043                fi
1044        done
1045}
1046#
1047# Sync remote urls for submodules
1048# This makes the value for remote.$remote.url match the value
1049# specified in .gitmodules.
1050#
1051cmd_sync()
1052{
1053        while test $# -ne 0
1054        do
1055                case "$1" in
1056                -q|--quiet)
1057                        GIT_QUIET=1
1058                        shift
1059                        ;;
1060                --recursive)
1061                        recursive=1
1062                        shift
1063                        ;;
1064                --)
1065                        shift
1066                        break
1067                        ;;
1068                -*)
1069                        usage
1070                        ;;
1071                *)
1072                        break
1073                        ;;
1074                esac
1075        done
1076        cd_to_toplevel
1077        {
1078                git submodule--helper list --prefix "$wt_prefix" "$@" ||
1079                echo "#unmatched" $?
1080        } |
1081        while read mode sha1 stage sm_path
1082        do
1083                die_if_unmatched "$mode" "$sha1"
1084                name=$(git submodule--helper name "$sm_path")
1085                url=$(git config -f .gitmodules --get submodule."$name".url)
1086
1087                # Possibly a url relative to parent
1088                case "$url" in
1089                ./*|../*)
1090                        # rewrite foo/bar as ../.. to find path from
1091                        # submodule work tree to superproject work tree
1092                        up_path="$(printf '%s\n' "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1093                        # guarantee a trailing /
1094                        up_path=${up_path%/}/ &&
1095                        # path from submodule work tree to submodule origin repo
1096                        sub_origin_url=$(git submodule--helper resolve-relative-url "$url" "$up_path") &&
1097                        # path from superproject work tree to submodule origin repo
1098                        super_config_url=$(git submodule--helper resolve-relative-url "$url") || exit
1099                        ;;
1100                *)
1101                        sub_origin_url="$url"
1102                        super_config_url="$url"
1103                        ;;
1104                esac
1105
1106                if git config "submodule.$name.url" >/dev/null 2>/dev/null
1107                then
1108                        displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
1109                        say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1110                        git config submodule."$name".url "$super_config_url"
1111
1112                        if test -e "$sm_path"/.git
1113                        then
1114                        (
1115                                sanitize_submodule_env
1116                                cd "$sm_path"
1117                                remote=$(get_default_remote)
1118                                git config remote."$remote".url "$sub_origin_url"
1119
1120                                if test -n "$recursive"
1121                                then
1122                                        prefix="$prefix$sm_path/"
1123                                        eval cmd_sync
1124                                fi
1125                        )
1126                        fi
1127                fi
1128        done
1129}
1130
1131cmd_absorbgitdirs()
1132{
1133        git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
1134}
1135
1136# This loop parses the command line arguments to find the
1137# subcommand name to dispatch.  Parsing of the subcommand specific
1138# options are primarily done by the subcommand implementations.
1139# Subcommand specific options such as --branch and --cached are
1140# parsed here as well, for backward compatibility.
1141
1142while test $# != 0 && test -z "$command"
1143do
1144        case "$1" in
1145        add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
1146                command=$1
1147                ;;
1148        -q|--quiet)
1149                GIT_QUIET=1
1150                ;;
1151        -b|--branch)
1152                case "$2" in
1153                '')
1154                        usage
1155                        ;;
1156                esac
1157                branch="$2"; shift
1158                ;;
1159        --cached)
1160                cached="$1"
1161                ;;
1162        --)
1163                break
1164                ;;
1165        -*)
1166                usage
1167                ;;
1168        *)
1169                break
1170                ;;
1171        esac
1172        shift
1173done
1174
1175# No command word defaults to "status"
1176if test -z "$command"
1177then
1178    if test $# = 0
1179    then
1180        command=status
1181    else
1182        usage
1183    fi
1184fi
1185
1186# "-b branch" is accepted only by "add"
1187if test -n "$branch" && test "$command" != add
1188then
1189        usage
1190fi
1191
1192# "--cached" is accepted only by "status" and "summary"
1193if test -n "$cached" && test "$command" != status && test "$command" != summary
1194then
1195        usage
1196fi
1197
1198"cmd_$command" "$@"