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