5247f78f35455036a17914623d531e02a5fb617d
   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] [--] <path>...
  12   or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--rebase] [--reference <repository>] [--merge] [--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>...]"
  16OPTIONS_SPEC=
  17SUBDIRECTORY_OK=Yes
  18. git-sh-setup
  19. git-sh-i18n
  20. git-parse-remote
  21require_work_tree
  22wt_prefix=$(git rev-parse --show-prefix)
  23cd_to_toplevel
  24
  25command=
  26branch=
  27force=
  28reference=
  29cached=
  30recursive=
  31init=
  32files=
  33remote=
  34nofetch=
  35update=
  36prefix=
  37custom_name=
  38depth=
  39
  40# The function takes at most 2 arguments. The first argument is the
  41# URL that navigates to the submodule origin repo. When relative, this URL
  42# is relative to the superproject origin URL repo. The second up_path
  43# argument, if specified, is the relative path that navigates
  44# from the submodule working tree to the superproject working tree.
  45#
  46# The output of the function is the origin URL of the submodule.
  47#
  48# The output will either be an absolute URL or filesystem path (if the
  49# superproject origin URL is an absolute URL or filesystem path,
  50# respectively) or a relative file system path (if the superproject
  51# origin URL is a relative file system path).
  52#
  53# When the output is a relative file system path, the path is either
  54# relative to the submodule working tree, if up_path is specified, or to
  55# the superproject working tree otherwise.
  56resolve_relative_url ()
  57{
  58        remote=$(get_default_remote)
  59        remoteurl=$(git config "remote.$remote.url") ||
  60                remoteurl=$(pwd) # the repository is its own authoritative upstream
  61        url="$1"
  62        remoteurl=${remoteurl%/}
  63        sep=/
  64        up_path="$2"
  65
  66        case "$remoteurl" in
  67        *:*|/*)
  68                is_relative=
  69                ;;
  70        ./*|../*)
  71                is_relative=t
  72                ;;
  73        *)
  74                is_relative=t
  75                remoteurl="./$remoteurl"
  76                ;;
  77        esac
  78
  79        while test -n "$url"
  80        do
  81                case "$url" in
  82                ../*)
  83                        url="${url#../}"
  84                        case "$remoteurl" in
  85                        */*)
  86                                remoteurl="${remoteurl%/*}"
  87                                ;;
  88                        *:*)
  89                                remoteurl="${remoteurl%:*}"
  90                                sep=:
  91                                ;;
  92                        *)
  93                                if test -z "$is_relative" || test "." = "$remoteurl"
  94                                then
  95                                        die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
  96                                else
  97                                        remoteurl=.
  98                                fi
  99                                ;;
 100                        esac
 101                        ;;
 102                ./*)
 103                        url="${url#./}"
 104                        ;;
 105                *)
 106                        break;;
 107                esac
 108        done
 109        remoteurl="$remoteurl$sep${url%/}"
 110        echo "${is_relative:+${up_path}}${remoteurl#./}"
 111}
 112
 113# Resolve a path to be relative to another path.  This is intended for
 114# converting submodule paths when git-submodule is run in a subdirectory
 115# and only handles paths where the directory separator is '/'.
 116#
 117# The output is the first argument as a path relative to the second argument,
 118# which defaults to $wt_prefix if it is omitted.
 119relative_path ()
 120{
 121        local target curdir result
 122        target=$1
 123        curdir=${2-$wt_prefix}
 124        curdir=${curdir%/}
 125        result=
 126
 127        while test -n "$curdir"
 128        do
 129                case "$target" in
 130                "$curdir/"*)
 131                        target=${target#"$curdir"/}
 132                        break
 133                        ;;
 134                esac
 135
 136                result="${result}../"
 137                if test "$curdir" = "${curdir%/*}"
 138                then
 139                        curdir=
 140                else
 141                        curdir="${curdir%/*}"
 142                fi
 143        done
 144
 145        echo "$result$target"
 146}
 147
 148#
 149# Get submodule info for registered submodules
 150# $@ = path to limit submodule list
 151#
 152module_list()
 153{
 154        eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
 155        (
 156                git ls-files -z --error-unmatch --stage -- "$@" ||
 157                echo "unmatched pathspec exists"
 158        ) |
 159        perl -e '
 160        my %unmerged = ();
 161        my ($null_sha1) = ("0" x 40);
 162        my @out = ();
 163        my $unmatched = 0;
 164        $/ = "\0";
 165        while (<STDIN>) {
 166                if (/^unmatched pathspec/) {
 167                        $unmatched = 1;
 168                        next;
 169                }
 170                chomp;
 171                my ($mode, $sha1, $stage, $path) =
 172                        /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
 173                next unless $mode eq "160000";
 174                if ($stage ne "0") {
 175                        if (!$unmerged{$path}++) {
 176                                push @out, "$mode $null_sha1 U\t$path\n";
 177                        }
 178                        next;
 179                }
 180                push @out, "$_\n";
 181        }
 182        if ($unmatched) {
 183                print "#unmatched\n";
 184        } else {
 185                print for (@out);
 186        }
 187        '
 188}
 189
 190die_if_unmatched ()
 191{
 192        if test "$1" = "#unmatched"
 193        then
 194                exit 1
 195        fi
 196}
 197
 198#
 199# Print a submodule configuration setting
 200#
 201# $1 = submodule name
 202# $2 = option name
 203# $3 = default value
 204#
 205# Checks in the usual git-config places first (for overrides),
 206# otherwise it falls back on .gitmodules.  This allows you to
 207# distribute project-wide defaults in .gitmodules, while still
 208# customizing individual repositories if necessary.  If the option is
 209# not in .gitmodules either, print a default value.
 210#
 211get_submodule_config () {
 212        name="$1"
 213        option="$2"
 214        default="$3"
 215        value=$(git config submodule."$name"."$option")
 216        if test -z "$value"
 217        then
 218                value=$(git config -f .gitmodules submodule."$name"."$option")
 219        fi
 220        printf '%s' "${value:-$default}"
 221}
 222
 223
 224#
 225# Map submodule path to submodule name
 226#
 227# $1 = path
 228#
 229module_name()
 230{
 231        # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
 232        sm_path="$1"
 233        re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
 234        name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
 235                sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
 236        test -z "$name" &&
 237        die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$sm_path'")"
 238        echo "$name"
 239}
 240
 241#
 242# Clone a submodule
 243#
 244# Prior to calling, cmd_update checks that a possibly existing
 245# path is not a git repository.
 246# Likewise, cmd_add checks that path does not exist at all,
 247# since it is the location of a new submodule.
 248#
 249module_clone()
 250{
 251        sm_path=$1
 252        name=$2
 253        url=$3
 254        reference="$4"
 255        depth="$5"
 256        quiet=
 257        if test -n "$GIT_QUIET"
 258        then
 259                quiet=-q
 260        fi
 261
 262        gitdir=
 263        gitdir_base=
 264        base_name=$(dirname "$name")
 265
 266        gitdir=$(git rev-parse --git-dir)
 267        gitdir_base="$gitdir/modules/$base_name"
 268        gitdir="$gitdir/modules/$name"
 269
 270        if test -d "$gitdir"
 271        then
 272                mkdir -p "$sm_path"
 273                rm -f "$gitdir/index"
 274        else
 275                mkdir -p "$gitdir_base"
 276                (
 277                        clear_local_git_env
 278                        git clone $quiet ${depth:+"$depth"} -n ${reference:+"$reference"} \
 279                                --separate-git-dir "$gitdir" "$url" "$sm_path"
 280                ) ||
 281                die "$(eval_gettext "Clone of '\$url' into submodule path '\$sm_path' failed")"
 282        fi
 283
 284        # We already are at the root of the work tree but cd_to_toplevel will
 285        # resolve any symlinks that might be present in $PWD
 286        a=$(cd_to_toplevel && cd "$gitdir" && pwd)/
 287        b=$(cd_to_toplevel && cd "$sm_path" && pwd)/
 288        # normalize Windows-style absolute paths to POSIX-style absolute paths
 289        case $a in [a-zA-Z]:/*) a=/${a%%:*}${a#*:} ;; esac
 290        case $b in [a-zA-Z]:/*) b=/${b%%:*}${b#*:} ;; esac
 291        # Remove all common leading directories after a sanity check
 292        if test "${a#$b}" != "$a" || test "${b#$a}" != "$b"; then
 293                die "$(eval_gettext "Gitdir '\$a' is part of the submodule path '\$b' or vice versa")"
 294        fi
 295        while test "${a%%/*}" = "${b%%/*}"
 296        do
 297                a=${a#*/}
 298                b=${b#*/}
 299        done
 300        # Now chop off the trailing '/'s that were added in the beginning
 301        a=${a%/}
 302        b=${b%/}
 303
 304        # Turn each leading "*/" component into "../"
 305        rel=$(echo $b | sed -e 's|[^/][^/]*|..|g')
 306        echo "gitdir: $rel/$a" >"$sm_path/.git"
 307
 308        rel=$(echo $a | sed -e 's|[^/][^/]*|..|g')
 309        (clear_local_git_env; cd "$sm_path" && GIT_WORK_TREE=. git config core.worktree "$rel/$b")
 310}
 311
 312isnumber()
 313{
 314        n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
 315}
 316
 317#
 318# Add a new submodule to the working tree, .gitmodules and the index
 319#
 320# $@ = repo path
 321#
 322# optional branch is stored in global branch variable
 323#
 324cmd_add()
 325{
 326        # parse $args after "submodule ... add".
 327        reference_path=
 328        while test $# -ne 0
 329        do
 330                case "$1" in
 331                -b | --branch)
 332                        case "$2" in '') usage ;; esac
 333                        branch=$2
 334                        shift
 335                        ;;
 336                -f | --force)
 337                        force=$1
 338                        ;;
 339                -q|--quiet)
 340                        GIT_QUIET=1
 341                        ;;
 342                --reference)
 343                        case "$2" in '') usage ;; esac
 344                        reference_path=$2
 345                        shift
 346                        ;;
 347                --reference=*)
 348                        reference_path="${1#--reference=}"
 349                        ;;
 350                --name)
 351                        case "$2" in '') usage ;; esac
 352                        custom_name=$2
 353                        shift
 354                        ;;
 355                --depth)
 356                        case "$2" in '') usage ;; esac
 357                        depth="--depth=$2"
 358                        shift
 359                        ;;
 360                --depth=*)
 361                        depth=$1
 362                        ;;
 363                --)
 364                        shift
 365                        break
 366                        ;;
 367                -*)
 368                        usage
 369                        ;;
 370                *)
 371                        break
 372                        ;;
 373                esac
 374                shift
 375        done
 376
 377        if test -n "$reference_path"
 378        then
 379                is_absolute_path "$reference_path" ||
 380                reference_path="$wt_prefix$reference_path"
 381
 382                reference="--reference=$reference_path"
 383        fi
 384
 385        repo=$1
 386        sm_path=$2
 387
 388        if test -z "$sm_path"; then
 389                sm_path=$(echo "$repo" |
 390                        sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
 391        fi
 392
 393        if test -z "$repo" -o -z "$sm_path"; then
 394                usage
 395        fi
 396
 397        is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
 398
 399        # assure repo is absolute or relative to parent
 400        case "$repo" in
 401        ./*|../*)
 402                test -z "$wt_prefix" ||
 403                die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
 404
 405                # dereference source url relative to parent's url
 406                realrepo=$(resolve_relative_url "$repo") || exit
 407                ;;
 408        *:*|/*)
 409                # absolute url
 410                realrepo=$repo
 411                ;;
 412        *)
 413                die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
 414        ;;
 415        esac
 416
 417        # normalize path:
 418        # multiple //; leading ./; /./; /../; trailing /
 419        sm_path=$(printf '%s/\n' "$sm_path" |
 420                sed -e '
 421                        s|//*|/|g
 422                        s|^\(\./\)*||
 423                        s|/\./|/|g
 424                        :start
 425                        s|\([^/]*\)/\.\./||
 426                        tstart
 427                        s|/*$||
 428                ')
 429        git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
 430        die "$(eval_gettext "'\$sm_path' already exists in the index")"
 431
 432        if test -z "$force" && ! git add --dry-run --ignore-missing "$sm_path" > /dev/null 2>&1
 433        then
 434                eval_gettextln "The following path is ignored by one of your .gitignore files:
 435\$sm_path
 436Use -f if you really want to add it." >&2
 437                exit 1
 438        fi
 439
 440        if test -n "$custom_name"
 441        then
 442                sm_name="$custom_name"
 443        else
 444                sm_name="$sm_path"
 445        fi
 446
 447        # perhaps the path exists and is already a git repo, else clone it
 448        if test -e "$sm_path"
 449        then
 450                if test -d "$sm_path"/.git -o -f "$sm_path"/.git
 451                then
 452                        eval_gettextln "Adding existing repo at '\$sm_path' to the index"
 453                else
 454                        die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
 455                fi
 456
 457        else
 458                if test -d ".git/modules/$sm_name"
 459                then
 460                        if test -z "$force"
 461                        then
 462                                echo >&2 "$(eval_gettext "A git directory for '\$sm_name' is found locally with remote(s):")"
 463                                GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^,"  ", -e s,' (fetch)',, >&2
 464                                echo >&2 "$(eval_gettext "If you want to reuse this local git directory instead of cloning again from")"
 465                                echo >&2 "  $realrepo"
 466                                echo >&2 "$(eval_gettext "use the '--force' option. If the local git directory is not the correct repo")"
 467                                die "$(eval_gettext "or you are unsure what this means choose another name with the '--name' option.")"
 468                        else
 469                                echo "$(eval_gettext "Reactivating local git directory for submodule '\$sm_name'.")"
 470                        fi
 471                fi
 472                module_clone "$sm_path" "$sm_name" "$realrepo" "$reference" "$depth" || exit
 473                (
 474                        clear_local_git_env
 475                        cd "$sm_path" &&
 476                        # ash fails to wordsplit ${branch:+-b "$branch"...}
 477                        case "$branch" in
 478                        '') git checkout -f -q ;;
 479                        ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
 480                        esac
 481                ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
 482        fi
 483        git config submodule."$sm_name".url "$realrepo"
 484
 485        git add $force "$sm_path" ||
 486        die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
 487
 488        git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
 489        git config -f .gitmodules submodule."$sm_name".url "$repo" &&
 490        if test -n "$branch"
 491        then
 492                git config -f .gitmodules submodule."$sm_name".branch "$branch"
 493        fi &&
 494        git add --force .gitmodules ||
 495        die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
 496}
 497
 498#
 499# Execute an arbitrary command sequence in each checked out
 500# submodule
 501#
 502# $@ = command to execute
 503#
 504cmd_foreach()
 505{
 506        # parse $args after "submodule ... foreach".
 507        while test $# -ne 0
 508        do
 509                case "$1" in
 510                -q|--quiet)
 511                        GIT_QUIET=1
 512                        ;;
 513                --recursive)
 514                        recursive=1
 515                        ;;
 516                -*)
 517                        usage
 518                        ;;
 519                *)
 520                        break
 521                        ;;
 522                esac
 523                shift
 524        done
 525
 526        toplevel=$(pwd)
 527
 528        # dup stdin so that it can be restored when running the external
 529        # command in the subshell (and a recursive call to this function)
 530        exec 3<&0
 531
 532        module_list |
 533        while read mode sha1 stage sm_path
 534        do
 535                die_if_unmatched "$mode"
 536                if test -e "$sm_path"/.git
 537                then
 538                        displaypath=$(relative_path "$sm_path")
 539                        say "$(eval_gettext "Entering '\$prefix\$displaypath'")"
 540                        name=$(module_name "$sm_path")
 541                        (
 542                                prefix="$prefix$sm_path/"
 543                                clear_local_git_env
 544                                cd "$sm_path" &&
 545                                sm_path=$(relative_path "$sm_path") &&
 546                                # we make $path available to scripts ...
 547                                path=$sm_path &&
 548                                eval "$@" &&
 549                                if test -n "$recursive"
 550                                then
 551                                        cmd_foreach "--recursive" "$@"
 552                                fi
 553                        ) <&3 3<&- ||
 554                        die "$(eval_gettext "Stopping at '\$prefix\$displaypath'; script returned non-zero status.")"
 555                fi
 556        done
 557}
 558
 559#
 560# Register submodules in .git/config
 561#
 562# $@ = requested paths (default to all)
 563#
 564cmd_init()
 565{
 566        # parse $args after "submodule ... init".
 567        while test $# -ne 0
 568        do
 569                case "$1" in
 570                -q|--quiet)
 571                        GIT_QUIET=1
 572                        ;;
 573                --)
 574                        shift
 575                        break
 576                        ;;
 577                -*)
 578                        usage
 579                        ;;
 580                *)
 581                        break
 582                        ;;
 583                esac
 584                shift
 585        done
 586
 587        module_list "$@" |
 588        while read mode sha1 stage sm_path
 589        do
 590                die_if_unmatched "$mode"
 591                name=$(module_name "$sm_path") || exit
 592
 593                displaypath=$(relative_path "$sm_path")
 594
 595                # Copy url setting when it is not set yet
 596                if test -z "$(git config "submodule.$name.url")"
 597                then
 598                        url=$(git config -f .gitmodules submodule."$name".url)
 599                        test -z "$url" &&
 600                        die "$(eval_gettext "No url found for submodule path '\$displaypath' in .gitmodules")"
 601
 602                        # Possibly a url relative to parent
 603                        case "$url" in
 604                        ./*|../*)
 605                                url=$(resolve_relative_url "$url") || exit
 606                                ;;
 607                        esac
 608                        git config submodule."$name".url "$url" ||
 609                        die "$(eval_gettext "Failed to register url for submodule path '\$displaypath'")"
 610
 611                        say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$displaypath'")"
 612                fi
 613
 614                # Copy "update" setting when it is not set yet
 615                if upd="$(git config -f .gitmodules submodule."$name".update)" &&
 616                   test -n "$upd" &&
 617                   test -z "$(git config submodule."$name".update)"
 618                then
 619                        case "$upd" in
 620                        checkout | rebase | merge | none)
 621                                ;; # known modes of updating
 622                        *)
 623                                echo >&2 "warning: unknown update mode '$upd' suggested for submodule '$name'"
 624                                upd=none
 625                                ;;
 626                        esac
 627                        git config submodule."$name".update "$upd" ||
 628                        die "$(eval_gettext "Failed to register update mode for submodule path '\$displaypath'")"
 629                fi
 630        done
 631}
 632
 633#
 634# Unregister submodules from .git/config and remove their work tree
 635#
 636# $@ = requested paths (use '.' to deinit all submodules)
 637#
 638cmd_deinit()
 639{
 640        # parse $args after "submodule ... deinit".
 641        while test $# -ne 0
 642        do
 643                case "$1" in
 644                -f|--force)
 645                        force=$1
 646                        ;;
 647                -q|--quiet)
 648                        GIT_QUIET=1
 649                        ;;
 650                --)
 651                        shift
 652                        break
 653                        ;;
 654                -*)
 655                        usage
 656                        ;;
 657                *)
 658                        break
 659                        ;;
 660                esac
 661                shift
 662        done
 663
 664        if test $# = 0
 665        then
 666                die "$(eval_gettext "Use '.' if you really want to deinitialize all submodules")"
 667        fi
 668
 669        module_list "$@" |
 670        while read mode sha1 stage sm_path
 671        do
 672                die_if_unmatched "$mode"
 673                name=$(module_name "$sm_path") || exit
 674
 675                displaypath=$(relative_path "$sm_path")
 676
 677                # Remove the submodule work tree (unless the user already did it)
 678                if test -d "$sm_path"
 679                then
 680                        # Protect submodules containing a .git directory
 681                        if test -d "$sm_path/.git"
 682                        then
 683                                echo >&2 "$(eval_gettext "Submodule work tree '\$displaypath' contains a .git directory")"
 684                                die "$(eval_gettext "(use 'rm -rf' if you really want to remove it including all of its history)")"
 685                        fi
 686
 687                        if test -z "$force"
 688                        then
 689                                git rm -qn "$sm_path" ||
 690                                die "$(eval_gettext "Submodule work tree '\$displaypath' contains local modifications; use '-f' to discard them")"
 691                        fi
 692                        rm -rf "$sm_path" &&
 693                        say "$(eval_gettext "Cleared directory '\$displaypath'")" ||
 694                        say "$(eval_gettext "Could not remove submodule work tree '\$displaypath'")"
 695                fi
 696
 697                mkdir "$sm_path" || say "$(eval_gettext "Could not create empty submodule directory '\$displaypath'")"
 698
 699                # Remove the .git/config entries (unless the user already did it)
 700                if test -n "$(git config --get-regexp submodule."$name\.")"
 701                then
 702                        # Remove the whole section so we have a clean state when
 703                        # the user later decides to init this submodule again
 704                        url=$(git config submodule."$name".url)
 705                        git config --remove-section submodule."$name" 2>/dev/null &&
 706                        say "$(eval_gettext "Submodule '\$name' (\$url) unregistered for path '\$displaypath'")"
 707                fi
 708        done
 709}
 710
 711#
 712# Update each submodule path to correct revision, using clone and checkout as needed
 713#
 714# $@ = requested paths (default to all)
 715#
 716cmd_update()
 717{
 718        # parse $args after "submodule ... update".
 719        orig_flags=
 720        while test $# -ne 0
 721        do
 722                case "$1" in
 723                -q|--quiet)
 724                        GIT_QUIET=1
 725                        ;;
 726                -i|--init)
 727                        init=1
 728                        ;;
 729                --remote)
 730                        remote=1
 731                        ;;
 732                -N|--no-fetch)
 733                        nofetch=1
 734                        ;;
 735                -f|--force)
 736                        force=$1
 737                        ;;
 738                -r|--rebase)
 739                        update="rebase"
 740                        ;;
 741                --reference)
 742                        case "$2" in '') usage ;; esac
 743                        reference="--reference=$2"
 744                        orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 745                        shift
 746                        ;;
 747                --reference=*)
 748                        reference="$1"
 749                        ;;
 750                -m|--merge)
 751                        update="merge"
 752                        ;;
 753                --recursive)
 754                        recursive=1
 755                        ;;
 756                --checkout)
 757                        update="checkout"
 758                        ;;
 759                --depth)
 760                        case "$2" in '') usage ;; esac
 761                        depth="--depth=$2"
 762                        shift
 763                        ;;
 764                --depth=*)
 765                        depth=$1
 766                        ;;
 767                --)
 768                        shift
 769                        break
 770                        ;;
 771                -*)
 772                        usage
 773                        ;;
 774                *)
 775                        break
 776                        ;;
 777                esac
 778                orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 779                shift
 780        done
 781
 782        if test -n "$init"
 783        then
 784                cmd_init "--" "$@" || return
 785        fi
 786
 787        cloned_modules=
 788        module_list "$@" | {
 789        err=
 790        while read mode sha1 stage sm_path
 791        do
 792                die_if_unmatched "$mode"
 793                if test "$stage" = U
 794                then
 795                        echo >&2 "Skipping unmerged submodule $prefix$sm_path"
 796                        continue
 797                fi
 798                name=$(module_name "$sm_path") || exit
 799                url=$(git config submodule."$name".url)
 800                branch=$(get_submodule_config "$name" branch master)
 801                if ! test -z "$update"
 802                then
 803                        update_module=$update
 804                else
 805                        update_module=$(git config submodule."$name".update)
 806                        case "$update_module" in
 807                        '')
 808                                ;; # Unset update mode
 809                        checkout | rebase | merge | none)
 810                                ;; # Known update modes
 811                        !*)
 812                                ;; # Custom update command
 813                        *)
 814                                die "$(eval_gettext "Invalid update mode '$update_module' for submodule '$name'")"
 815                                ;;
 816                        esac
 817                fi
 818
 819                displaypath=$(relative_path "$prefix$sm_path")
 820
 821                if test "$update_module" = "none"
 822                then
 823                        echo "Skipping submodule '$displaypath'"
 824                        continue
 825                fi
 826
 827                if test -z "$url"
 828                then
 829                        # Only mention uninitialized submodules when its
 830                        # path have been specified
 831                        test "$#" != "0" &&
 832                        say "$(eval_gettext "Submodule path '\$displaypath' not initialized
 833Maybe you want to use 'update --init'?")"
 834                        continue
 835                fi
 836
 837                if ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
 838                then
 839                        module_clone "$sm_path" "$name" "$url" "$reference" "$depth" || exit
 840                        cloned_modules="$cloned_modules;$name"
 841                        subsha1=
 842                else
 843                        subsha1=$(clear_local_git_env; cd "$sm_path" &&
 844                                git rev-parse --verify HEAD) ||
 845                        die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
 846                fi
 847
 848                if test -n "$remote"
 849                then
 850                        if test -z "$nofetch"
 851                        then
 852                                # Fetch remote before determining tracking $sha1
 853                                (clear_local_git_env; cd "$sm_path" && git-fetch) ||
 854                                die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
 855                        fi
 856                        remote_name=$(clear_local_git_env; cd "$sm_path" && get_default_remote)
 857                        sha1=$(clear_local_git_env; cd "$sm_path" &&
 858                                git rev-parse --verify "${remote_name}/${branch}") ||
 859                        die "$(eval_gettext "Unable to find current ${remote_name}/${branch} revision in submodule path '\$sm_path'")"
 860                fi
 861
 862                if test "$subsha1" != "$sha1" -o -n "$force"
 863                then
 864                        subforce=$force
 865                        # If we don't already have a -f flag and the submodule has never been checked out
 866                        if test -z "$subsha1" -a -z "$force"
 867                        then
 868                                subforce="-f"
 869                        fi
 870
 871                        if test -z "$nofetch"
 872                        then
 873                                # Run fetch only if $sha1 isn't present or it
 874                                # is not reachable from a ref.
 875                                (clear_local_git_env; cd "$sm_path" &&
 876                                        ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
 877                                         test -z "$rev") || git-fetch)) ||
 878                                die "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
 879                        fi
 880
 881                        # Is this something we just cloned?
 882                        case ";$cloned_modules;" in
 883                        *";$name;"*)
 884                                # then there is no local change to integrate
 885                                update_module= ;;
 886                        esac
 887
 888                        must_die_on_failure=
 889                        case "$update_module" in
 890                        rebase)
 891                                command="git rebase"
 892                                die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
 893                                say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
 894                                must_die_on_failure=yes
 895                                ;;
 896                        merge)
 897                                command="git merge"
 898                                die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
 899                                say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
 900                                must_die_on_failure=yes
 901                                ;;
 902                        !*)
 903                                command="${update_module#!}"
 904                                die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule  path '\$prefix\$sm_path'")"
 905                                say_msg="$(eval_gettext "Submodule path '\$prefix\$sm_path': '\$command \$sha1'")"
 906                                must_die_on_failure=yes
 907                                ;;
 908                        *)
 909                                command="git checkout $subforce -q"
 910                                die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
 911                                say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
 912                                ;;
 913                        esac
 914
 915                        if (clear_local_git_env; cd "$sm_path" && $command "$sha1")
 916                        then
 917                                say "$say_msg"
 918                        elif test -n "$must_die_on_failure"
 919                        then
 920                                die_with_status 2 "$die_msg"
 921                        else
 922                                err="${err};$die_msg"
 923                                continue
 924                        fi
 925                fi
 926
 927                if test -n "$recursive"
 928                then
 929                        (
 930                                prefix="$prefix$sm_path/"
 931                                clear_local_git_env
 932                                cd "$sm_path" &&
 933                                eval cmd_update "$orig_flags"
 934                        )
 935                        res=$?
 936                        if test $res -gt 0
 937                        then
 938                                die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
 939                                if test $res -eq 1
 940                                then
 941                                        err="${err};$die_msg"
 942                                        continue
 943                                else
 944                                        die_with_status $res "$die_msg"
 945                                fi
 946                        fi
 947                fi
 948        done
 949
 950        if test -n "$err"
 951        then
 952                OIFS=$IFS
 953                IFS=';'
 954                for e in $err
 955                do
 956                        if test -n "$e"
 957                        then
 958                                echo >&2 "$e"
 959                        fi
 960                done
 961                IFS=$OIFS
 962                exit 1
 963        fi
 964        }
 965}
 966
 967set_name_rev () {
 968        revname=$( (
 969                clear_local_git_env
 970                cd "$1" && {
 971                        git describe "$2" 2>/dev/null ||
 972                        git describe --tags "$2" 2>/dev/null ||
 973                        git describe --contains "$2" 2>/dev/null ||
 974                        git describe --all --always "$2"
 975                }
 976        ) )
 977        test -z "$revname" || revname=" ($revname)"
 978}
 979#
 980# Show commit summary for submodules in index or working tree
 981#
 982# If '--cached' is given, show summary between index and given commit,
 983# or between working tree and given commit
 984#
 985# $@ = [commit (default 'HEAD'),] requested paths (default all)
 986#
 987cmd_summary() {
 988        summary_limit=-1
 989        for_status=
 990        diff_cmd=diff-index
 991
 992        # parse $args after "submodule ... summary".
 993        while test $# -ne 0
 994        do
 995                case "$1" in
 996                --cached)
 997                        cached="$1"
 998                        ;;
 999                --files)
1000                        files="$1"
1001                        ;;
1002                --for-status)
1003                        for_status="$1"
1004                        ;;
1005                -n|--summary-limit)
1006                        summary_limit="$2"
1007                        isnumber "$summary_limit" || usage
1008                        shift
1009                        ;;
1010                --summary-limit=*)
1011                        summary_limit="${1#--summary-limit=}"
1012                        isnumber "$summary_limit" || usage
1013                        ;;
1014                --)
1015                        shift
1016                        break
1017                        ;;
1018                -*)
1019                        usage
1020                        ;;
1021                *)
1022                        break
1023                        ;;
1024                esac
1025                shift
1026        done
1027
1028        test $summary_limit = 0 && return
1029
1030        if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
1031        then
1032                head=$rev
1033                test $# = 0 || shift
1034        elif test -z "$1" -o "$1" = "HEAD"
1035        then
1036                # before the first commit: compare with an empty tree
1037                head=$(git hash-object -w -t tree --stdin </dev/null)
1038                test -z "$1" || shift
1039        else
1040                head="HEAD"
1041        fi
1042
1043        if [ -n "$files" ]
1044        then
1045                test -n "$cached" &&
1046                die "$(gettext "The --cached option cannot be used with the --files option")"
1047                diff_cmd=diff-files
1048                head=
1049        fi
1050
1051        cd_to_toplevel
1052        eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
1053        # Get modified modules cared by user
1054        modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
1055                sane_egrep '^:([0-7]* )?160000' |
1056                while read mod_src mod_dst sha1_src sha1_dst status sm_path
1057                do
1058                        # Always show modules deleted or type-changed (blob<->module)
1059                        test $status = D -o $status = T && echo "$sm_path" && continue
1060                        # Respect the ignore setting for --for-status.
1061                        if test -n "$for_status"
1062                        then
1063                                name=$(module_name "$sm_path")
1064                                ignore_config=$(get_submodule_config "$name" ignore none)
1065                                test $status != A -a $ignore_config = all && continue
1066                        fi
1067                        # Also show added or modified modules which are checked out
1068                        GIT_DIR="$sm_path/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
1069                        echo "$sm_path"
1070                done
1071        )
1072
1073        test -z "$modules" && return
1074
1075        git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
1076        sane_egrep '^:([0-7]* )?160000' |
1077        cut -c2- |
1078        while read mod_src mod_dst sha1_src sha1_dst status name
1079        do
1080                if test -z "$cached" &&
1081                        test $sha1_dst = 0000000000000000000000000000000000000000
1082                then
1083                        case "$mod_dst" in
1084                        160000)
1085                                sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
1086                                ;;
1087                        100644 | 100755 | 120000)
1088                                sha1_dst=$(git hash-object $name)
1089                                ;;
1090                        000000)
1091                                ;; # removed
1092                        *)
1093                                # unexpected type
1094                                eval_gettextln "unexpected mode \$mod_dst" >&2
1095                                continue ;;
1096                        esac
1097                fi
1098                missing_src=
1099                missing_dst=
1100
1101                test $mod_src = 160000 &&
1102                ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
1103                missing_src=t
1104
1105                test $mod_dst = 160000 &&
1106                ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
1107                missing_dst=t
1108
1109                display_name=$(relative_path "$name")
1110
1111                total_commits=
1112                case "$missing_src,$missing_dst" in
1113                t,)
1114                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_src")"
1115                        ;;
1116                ,t)
1117                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_dst")"
1118                        ;;
1119                t,t)
1120                        errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
1121                        ;;
1122                *)
1123                        errmsg=
1124                        total_commits=$(
1125                        if test $mod_src = 160000 -a $mod_dst = 160000
1126                        then
1127                                range="$sha1_src...$sha1_dst"
1128                        elif test $mod_src = 160000
1129                        then
1130                                range=$sha1_src
1131                        else
1132                                range=$sha1_dst
1133                        fi
1134                        GIT_DIR="$name/.git" \
1135                        git rev-list --first-parent $range -- | wc -l
1136                        )
1137                        total_commits=" ($(($total_commits + 0)))"
1138                        ;;
1139                esac
1140
1141                sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
1142                sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
1143                if test $status = T
1144                then
1145                        blob="$(gettext "blob")"
1146                        submodule="$(gettext "submodule")"
1147                        if test $mod_dst = 160000
1148                        then
1149                                echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
1150                        else
1151                                echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
1152                        fi
1153                else
1154                        echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
1155                fi
1156                if test -n "$errmsg"
1157                then
1158                        # Don't give error msg for modification whose dst is not submodule
1159                        # i.e. deleted or changed to blob
1160                        test $mod_dst = 160000 && echo "$errmsg"
1161                else
1162                        if test $mod_src = 160000 -a $mod_dst = 160000
1163                        then
1164                                limit=
1165                                test $summary_limit -gt 0 && limit="-$summary_limit"
1166                                GIT_DIR="$name/.git" \
1167                                git log $limit --pretty='format:  %m %s' \
1168                                --first-parent $sha1_src...$sha1_dst
1169                        elif test $mod_dst = 160000
1170                        then
1171                                GIT_DIR="$name/.git" \
1172                                git log --pretty='format:  > %s' -1 $sha1_dst
1173                        else
1174                                GIT_DIR="$name/.git" \
1175                                git log --pretty='format:  < %s' -1 $sha1_src
1176                        fi
1177                        echo
1178                fi
1179                echo
1180        done
1181}
1182#
1183# List all submodules, prefixed with:
1184#  - submodule not initialized
1185#  + different revision checked out
1186#
1187# If --cached was specified the revision in the index will be printed
1188# instead of the currently checked out revision.
1189#
1190# $@ = requested paths (default to all)
1191#
1192cmd_status()
1193{
1194        # parse $args after "submodule ... status".
1195        while test $# -ne 0
1196        do
1197                case "$1" in
1198                -q|--quiet)
1199                        GIT_QUIET=1
1200                        ;;
1201                --cached)
1202                        cached=1
1203                        ;;
1204                --recursive)
1205                        recursive=1
1206                        ;;
1207                --)
1208                        shift
1209                        break
1210                        ;;
1211                -*)
1212                        usage
1213                        ;;
1214                *)
1215                        break
1216                        ;;
1217                esac
1218                shift
1219        done
1220
1221        module_list "$@" |
1222        while read mode sha1 stage sm_path
1223        do
1224                die_if_unmatched "$mode"
1225                name=$(module_name "$sm_path") || exit
1226                url=$(git config submodule."$name".url)
1227                displaypath=$(relative_path "$prefix$sm_path")
1228                if test "$stage" = U
1229                then
1230                        say "U$sha1 $displaypath"
1231                        continue
1232                fi
1233                if test -z "$url" || ! test -d "$sm_path"/.git -o -f "$sm_path"/.git
1234                then
1235                        say "-$sha1 $displaypath"
1236                        continue;
1237                fi
1238                if git diff-files --ignore-submodules=dirty --quiet -- "$sm_path"
1239                then
1240                        set_name_rev "$sm_path" "$sha1"
1241                        say " $sha1 $displaypath$revname"
1242                else
1243                        if test -z "$cached"
1244                        then
1245                                sha1=$(clear_local_git_env; cd "$sm_path" && git rev-parse --verify HEAD)
1246                        fi
1247                        set_name_rev "$sm_path" "$sha1"
1248                        say "+$sha1 $displaypath$revname"
1249                fi
1250
1251                if test -n "$recursive"
1252                then
1253                        (
1254                                prefix="$displaypath/"
1255                                clear_local_git_env
1256                                cd "$sm_path" &&
1257                                eval cmd_status
1258                        ) ||
1259                        die "$(eval_gettext "Failed to recurse into submodule path '\$sm_path'")"
1260                fi
1261        done
1262}
1263#
1264# Sync remote urls for submodules
1265# This makes the value for remote.$remote.url match the value
1266# specified in .gitmodules.
1267#
1268cmd_sync()
1269{
1270        while test $# -ne 0
1271        do
1272                case "$1" in
1273                -q|--quiet)
1274                        GIT_QUIET=1
1275                        shift
1276                        ;;
1277                --recursive)
1278                        recursive=1
1279                        shift
1280                        ;;
1281                --)
1282                        shift
1283                        break
1284                        ;;
1285                -*)
1286                        usage
1287                        ;;
1288                *)
1289                        break
1290                        ;;
1291                esac
1292        done
1293        cd_to_toplevel
1294        module_list "$@" |
1295        while read mode sha1 stage sm_path
1296        do
1297                die_if_unmatched "$mode"
1298                name=$(module_name "$sm_path")
1299                url=$(git config -f .gitmodules --get submodule."$name".url)
1300
1301                # Possibly a url relative to parent
1302                case "$url" in
1303                ./*|../*)
1304                        # rewrite foo/bar as ../.. to find path from
1305                        # submodule work tree to superproject work tree
1306                        up_path="$(echo "$sm_path" | sed "s/[^/][^/]*/../g")" &&
1307                        # guarantee a trailing /
1308                        up_path=${up_path%/}/ &&
1309                        # path from submodule work tree to submodule origin repo
1310                        sub_origin_url=$(resolve_relative_url "$url" "$up_path") &&
1311                        # path from superproject work tree to submodule origin repo
1312                        super_config_url=$(resolve_relative_url "$url") || exit
1313                        ;;
1314                *)
1315                        sub_origin_url="$url"
1316                        super_config_url="$url"
1317                        ;;
1318                esac
1319
1320                if git config "submodule.$name.url" >/dev/null 2>/dev/null
1321                then
1322                        displaypath=$(relative_path "$prefix$sm_path")
1323                        say "$(eval_gettext "Synchronizing submodule url for '\$displaypath'")"
1324                        git config submodule."$name".url "$super_config_url"
1325
1326                        if test -e "$sm_path"/.git
1327                        then
1328                        (
1329                                clear_local_git_env
1330                                cd "$sm_path"
1331                                remote=$(get_default_remote)
1332                                git config remote."$remote".url "$sub_origin_url"
1333
1334                                if test -n "$recursive"
1335                                then
1336                                        prefix="$prefix$sm_path/"
1337                                        eval cmd_sync
1338                                fi
1339                        )
1340                        fi
1341                fi
1342        done
1343}
1344
1345# This loop parses the command line arguments to find the
1346# subcommand name to dispatch.  Parsing of the subcommand specific
1347# options are primarily done by the subcommand implementations.
1348# Subcommand specific options such as --branch and --cached are
1349# parsed here as well, for backward compatibility.
1350
1351while test $# != 0 && test -z "$command"
1352do
1353        case "$1" in
1354        add | foreach | init | deinit | update | status | summary | sync)
1355                command=$1
1356                ;;
1357        -q|--quiet)
1358                GIT_QUIET=1
1359                ;;
1360        -b|--branch)
1361                case "$2" in
1362                '')
1363                        usage
1364                        ;;
1365                esac
1366                branch="$2"; shift
1367                ;;
1368        --cached)
1369                cached="$1"
1370                ;;
1371        --)
1372                break
1373                ;;
1374        -*)
1375                usage
1376                ;;
1377        *)
1378                break
1379                ;;
1380        esac
1381        shift
1382done
1383
1384# No command word defaults to "status"
1385if test -z "$command"
1386then
1387    if test $# = 0
1388    then
1389        command=status
1390    else
1391        usage
1392    fi
1393fi
1394
1395# "-b branch" is accepted only by "add"
1396if test -n "$branch" && test "$command" != add
1397then
1398        usage
1399fi
1400
1401# "--cached" is accepted only by "status" and "summary"
1402if test -n "$cached" && test "$command" != status -a "$command" != summary
1403then
1404        usage
1405fi
1406
1407"cmd_$command" "$@"