git-submodule.sh

   1 #!/bin/sh
   2 #
   3 # git-submodules.sh: add, init, update or list git submodules
   4 #
   5 # Copyright (c) 2007 Lars Hjemli
   6
   7 dashless=$(basename "$0" | sed -e 's/-/ /')
   8 USAGE="[--quiet] add [-b branch] [-f|--force] [--reference <repository>] [--] <repository> [<path>]
   9    or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
  10    or: $dashless [--quiet] init [--] [<path>...]
  11    or: $dashless [--quiet] update [--init] [-N|--no-fetch] [-f|--force] [--rebase] [--reference <repository>] [--merge] [--recursive] [--] [<path>...]
  12    or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
  13    or: $dashless [--quiet] foreach [--recursive] <command>
  14    or: $dashless [--quiet] sync [--] [<path>...]"
  15 OPTIONS_SPEC=
  16 . git-sh-setup
  17 . git-sh-i18n
  18 . git-parse-remote
  19 require_work_tree
  20
  21 command=
  22 branch=
  23 force=
  24 reference=
  25 cached=
  26 recursive=
  27 init=
  28 files=
  29 nofetch=
  30 update=
  31 prefix=
  32
  33 # Resolve relative url by appending to parent's url
  34 resolve_relative_url ()
  35 {
  36         remote=$(get_default_remote)
  37         remoteurl=$(git config "remote.$remote.url") ||
  38                 die "$(eval_gettext "remote (\$remote) does not have a url defined in .git/config")"
  39         url="$1"
  40         remoteurl=${remoteurl%/}
  41         sep=/
  42         while test -n "$url"
  43         do
  44                 case "$url" in
  45                 ../*)
  46                         url="${url#../}"
  47                         case "$remoteurl" in
  48                         */*)
  49                                 remoteurl="${remoteurl%/*}"
  50                                 ;;
  51                         *:*)
  52                                 remoteurl="${remoteurl%:*}"
  53                                 sep=:
  54                                 ;;
  55                         *)
  56                                 die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")"
  57                                 ;;
  58                         esac
  59                         ;;
  60                 ./*)
  61                         url="${url#./}"
  62                         ;;
  63                 *)
  64                         break;;
  65                 esac
  66         done
  67         echo "$remoteurl$sep${url%/}"
  68 }
  69
  70 #
  71 # Get submodule info for registered submodules
  72 # $@ = path to limit submodule list
  73 #
  74 module_list()
  75 {
  76         git ls-files --error-unmatch --stage -- "$@" |
  77         perl -e '
  78         my %unmerged = ();
  79         my ($null_sha1) = ("0" x 40);
  80         while (<STDIN>) {
  81                 chomp;
  82                 my ($mode, $sha1, $stage, $path) =
  83                         /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/;
  84                 next unless $mode eq "160000";
  85                 if ($stage ne "0") {
  86                         if (!$unmerged{$path}++) {
  87                                 print "$mode $null_sha1 U\t$path\n";
  88                         }
  89                         next;
  90                 }
  91                 print "$_\n";
  92         }
  93         '
  94 }
  95
  96 #
  97 # Map submodule path to submodule name
  98 #
  99 # $1 = path
 100 #
 101 module_name()
 102 {
 103         # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
 104         re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
 105         name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
 106                 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
 107        test -z "$name" &&
 108        die "$(eval_gettext "No submodule mapping found in .gitmodules for path '\$path'")"
 109        echo "$name"
 110 }
 111
 112 #
 113 # Clone a submodule
 114 #
 115 # Prior to calling, cmd_update checks that a possibly existing
 116 # path is not a git repository.
 117 # Likewise, cmd_add checks that path does not exist at all,
 118 # since it is the location of a new submodule.
 119 #
 120 module_clone()
 121 {
 122         path=$1
 123         url=$2
 124         reference="$3"
 125
 126         if test -n "$reference"
 127         then
 128                 git-clone "$reference" -n "$url" "$path"
 129         else
 130                 git-clone -n "$url" "$path"
 131         fi ||
 132         die "$(eval_gettext "Clone of '\$url' into submodule path '\$path' failed")"
 133 }
 134
 135 #
 136 # Add a new submodule to the working tree, .gitmodules and the index
 137 #
 138 # $@ = repo path
 139 #
 140 # optional branch is stored in global branch variable
 141 #
 142 cmd_add()
 143 {
 144         # parse $args after "submodule ... add".
 145         while test $# -ne 0
 146         do
 147                 case "$1" in
 148                 -b | --branch)
 149                         case "$2" in '') usage ;; esac
 150                         branch=$2
 151                         shift
 152                         ;;
 153                 -f | --force)
 154                         force=$1
 155                         ;;
 156                 -q|--quiet)
 157                         GIT_QUIET=1
 158                         ;;
 159                 --reference)
 160                         case "$2" in '') usage ;; esac
 161                         reference="--reference=$2"
 162                         shift
 163                         ;;
 164                 --reference=*)
 165                         reference="$1"
 166                         shift
 167                         ;;
 168                 --)
 169                         shift
 170                         break
 171                         ;;
 172                 -*)
 173                         usage
 174                         ;;
 175                 *)
 176                         break
 177                         ;;
 178                 esac
 179                 shift
 180         done
 181
 182         repo=$1
 183         path=$2
 184
 185         if test -z "$path"; then
 186                 path=$(echo "$repo" |
 187                         sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
 188         fi
 189
 190         if test -z "$repo" -o -z "$path"; then
 191                 usage
 192         fi
 193
 194         # assure repo is absolute or relative to parent
 195         case "$repo" in
 196         ./*|../*)
 197                 # dereference source url relative to parent's url
 198                 realrepo=$(resolve_relative_url "$repo") || exit
 199                 ;;
 200         *:*|/*)
 201                 # absolute url
 202                 realrepo=$repo
 203                 ;;
 204         *)
 205                 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
 206         ;;
 207         esac
 208
 209         # normalize path:
 210         # multiple //; leading ./; /./; /../; trailing /
 211         path=$(printf '%s/\n' "$path" |
 212                 sed -e '
 213                         s|//*|/|g
 214                         s|^\(\./\)*||
 215                         s|/\./|/|g
 216                         :start
 217                         s|\([^/]*\)/\.\./||
 218                         tstart
 219                         s|/*$||
 220                 ')
 221         git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
 222         die "$(eval_gettext "'\$path' already exists in the index")"
 223
 224         if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1
 225         then
 226                 cat >&2 <<EOF
 227 The following path is ignored by one of your .gitignore files:
 228 $(gettext $path)
 229 Use -f if you really want to add it.
 230 EOF
 231                 exit 1
 232         fi
 233
 234         # perhaps the path exists and is already a git repo, else clone it
 235         if test -e "$path"
 236         then
 237                 if test -d "$path"/.git -o -f "$path"/.git
 238                 then
 239                         eval_gettext "Adding existing repo at '\$path' to the index"; echo
 240                 else
 241                         die "$(eval_gettext "'\$path' already exists and is not a valid git repo")"
 242                 fi
 243
 244                 case "$repo" in
 245                 ./*|../*)
 246                         url=$(resolve_relative_url "$repo") || exit
 247                     ;;
 248                 *)
 249                         url="$repo"
 250                         ;;
 251                 esac
 252                 git config submodule."$path".url "$url"
 253         else
 254
 255                 module_clone "$path" "$realrepo" "$reference" || exit
 256                 (
 257                         clear_local_git_env
 258                         cd "$path" &&
 259                         # ash fails to wordsplit ${branch:+-b "$branch"...}
 260                         case "$branch" in
 261                         '') git checkout -f -q ;;
 262                         ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
 263                         esac
 264                 ) || die "$(eval_gettext "Unable to checkout submodule '\$path'")"
 265         fi
 266
 267         git add $force "$path" ||
 268         die "$(eval_gettext "Failed to add submodule '\$path'")"
 269
 270         git config -f .gitmodules submodule."$path".path "$path" &&
 271         git config -f .gitmodules submodule."$path".url "$repo" &&
 272         git add --force .gitmodules ||
 273         die "$(eval_gettext "Failed to register submodule '\$path'")"
 274 }
 275
 276 #
 277 # Execute an arbitrary command sequence in each checked out
 278 # submodule
 279 #
 280 # $@ = command to execute
 281 #
 282 cmd_foreach()
 283 {
 284         # parse $args after "submodule ... foreach".
 285         while test $# -ne 0
 286         do
 287                 case "$1" in
 288                 -q|--quiet)
 289                         GIT_QUIET=1
 290                         ;;
 291                 --recursive)
 292                         recursive=1
 293                         ;;
 294                 -*)
 295                         usage
 296                         ;;
 297                 *)
 298                         break
 299                         ;;
 300                 esac
 301                 shift
 302         done
 303
 304         toplevel=$(pwd)
 305
 306         module_list |
 307         while read mode sha1 stage path
 308         do
 309                 if test -e "$path"/.git
 310                 then
 311                         say "$(eval_gettext "Entering '\$prefix\$path'")"
 312                         name=$(module_name "$path")
 313                         (
 314                                 prefix="$prefix$path/"
 315                                 clear_local_git_env
 316                                 cd "$path" &&
 317                                 eval "$@" &&
 318                                 if test -n "$recursive"
 319                                 then
 320                                         cmd_foreach "--recursive" "$@"
 321                                 fi
 322                         ) ||
 323                         die "$(eval_gettext "Stopping at '\$path'; script returned non-zero status.")"
 324                 fi
 325         done
 326 }
 327
 328 #
 329 # Register submodules in .git/config
 330 #
 331 # $@ = requested paths (default to all)
 332 #
 333 cmd_init()
 334 {
 335         # parse $args after "submodule ... init".
 336         while test $# -ne 0
 337         do
 338                 case "$1" in
 339                 -q|--quiet)
 340                         GIT_QUIET=1
 341                         ;;
 342                 --)
 343                         shift
 344                         break
 345                         ;;
 346                 -*)
 347                         usage
 348                         ;;
 349                 *)
 350                         break
 351                         ;;
 352                 esac
 353                 shift
 354         done
 355
 356         module_list "$@" |
 357         while read mode sha1 stage path
 358         do
 359                 # Skip already registered paths
 360                 name=$(module_name "$path") || exit
 361                 url=$(git config submodule."$name".url)
 362                 test -z "$url" || continue
 363
 364                 url=$(git config -f .gitmodules submodule."$name".url)
 365                 test -z "$url" &&
 366                 die "$(eval_gettext "No url found for submodule path '\$path' in .gitmodules")"
 367
 368                 # Possibly a url relative to parent
 369                 case "$url" in
 370                 ./*|../*)
 371                         url=$(resolve_relative_url "$url") || exit
 372                         ;;
 373                 esac
 374
 375                 git config submodule."$name".url "$url" ||
 376                 die "$(eval_gettext "Failed to register url for submodule path '\$path'")"
 377
 378                 upd="$(git config -f .gitmodules submodule."$name".update)"
 379                 test -z "$upd" ||
 380                 git config submodule."$name".update "$upd" ||
 381                 die "$(eval_gettext "Failed to register update mode for submodule path '\$path'")"
 382
 383                 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$path'")"
 384         done
 385 }
 386
 387 #
 388 # Update each submodule path to correct revision, using clone and checkout as needed
 389 #
 390 # $@ = requested paths (default to all)
 391 #
 392 cmd_update()
 393 {
 394         # parse $args after "submodule ... update".
 395         orig_flags=
 396         while test $# -ne 0
 397         do
 398                 case "$1" in
 399                 -q|--quiet)
 400                         GIT_QUIET=1
 401                         ;;
 402                 -i|--init)
 403                         init=1
 404                         ;;
 405                 -N|--no-fetch)
 406                         nofetch=1
 407                         ;;
 408                 -f|--force)
 409                         force=$1
 410                         ;;
 411                 -r|--rebase)
 412                         update="rebase"
 413                         ;;
 414                 --reference)
 415                         case "$2" in '') usage ;; esac
 416                         reference="--reference=$2"
 417                         orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 418                         shift
 419                         ;;
 420                 --reference=*)
 421                         reference="$1"
 422                         ;;
 423                 -m|--merge)
 424                         update="merge"
 425                         ;;
 426                 --recursive)
 427                         recursive=1
 428                         ;;
 429                 --)
 430                         shift
 431                         break
 432                         ;;
 433                 -*)
 434                         usage
 435                         ;;
 436                 *)
 437                         break
 438                         ;;
 439                 esac
 440                 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 441                 shift
 442         done
 443
 444         if test -n "$init"
 445         then
 446                 cmd_init "--" "$@" || return
 447         fi
 448
 449         cloned_modules=
 450         module_list "$@" |
 451         while read mode sha1 stage path
 452         do
 453                 if test "$stage" = U
 454                 then
 455                         echo >&2 "Skipping unmerged submodule $path"
 456                         continue
 457                 fi
 458                 name=$(module_name "$path") || exit
 459                 url=$(git config submodule."$name".url)
 460                 update_module=$(git config submodule."$name".update)
 461                 if test -z "$url"
 462                 then
 463                         # Only mention uninitialized submodules when its
 464                         # path have been specified
 465                         test "$#" != "0" &&
 466                         say "$(eval_gettext "Submodule path '\$path' not initialized
 467 Maybe you want to use 'update --init'?")"
 468                         continue
 469                 fi
 470
 471                 if ! test -d "$path"/.git -o -f "$path"/.git
 472                 then
 473                         module_clone "$path" "$url" "$reference"|| exit
 474                         cloned_modules="$cloned_modules;$name"
 475                         subsha1=
 476                 else
 477                         subsha1=$(clear_local_git_env; cd "$path" &&
 478                                 git rev-parse --verify HEAD) ||
 479                         die "$(eval_gettext "Unable to find current revision in submodule path '\$path'")"
 480                 fi
 481
 482                 if ! test -z "$update"
 483                 then
 484                         update_module=$update
 485                 fi
 486
 487                 if test "$subsha1" != "$sha1"
 488                 then
 489                         subforce=$force
 490                         # If we don't already have a -f flag and the submodule has never been checked out
 491                         if test -z "$subsha1" -a -z "$force"
 492                         then
 493                                 subforce="-f"
 494                         fi
 495
 496                         if test -z "$nofetch"
 497                         then
 498                                 # Run fetch only if $sha1 isn't present or it
 499                                 # is not reachable from a ref.
 500                                 (clear_local_git_env; cd "$path" &&
 501                                         ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
 502                                          test -z "$rev") || git-fetch)) ||
 503                                 die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
 504                         fi
 505
 506                         # Is this something we just cloned?
 507                         case ";$cloned_modules;" in
 508                         *";$name;"*)
 509                                 # then there is no local change to integrate
 510                                 update_module= ;;
 511                         esac
 512
 513                         case "$update_module" in
 514                         rebase)
 515                                 command="git rebase"
 516                                 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$path'")"
 517                                 say_msg="$(eval_gettext "Submodule path '\$path': rebased into '\$sha1'")"
 518                                 ;;
 519                         merge)
 520                                 command="git merge"
 521                                 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$path'")"
 522                                 say_msg="$(eval_gettext "Submodule path '\$path': merged in '\$sha1'")"
 523                                 ;;
 524                         *)
 525                                 command="git checkout $subforce -q"
 526                                 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$path'")"
 527                                 say_msg="$(eval_gettext "Submodule path '\$path': checked out '\$sha1'")"
 528                                 ;;
 529                         esac
 530
 531                         (clear_local_git_env; cd "$path" && $command "$sha1") || die $die_msg
 532                         say $say_msg
 533                 fi
 534
 535                 if test -n "$recursive"
 536                 then
 537                         (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") ||
 538                         die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
 539                 fi
 540         done
 541 }
 542
 543 set_name_rev () {
 544         revname=$( (
 545                 clear_local_git_env
 546                 cd "$1" && {
 547                         git describe "$2" 2>/dev/null ||
 548                         git describe --tags "$2" 2>/dev/null ||
 549                         git describe --contains "$2" 2>/dev/null ||
 550                         git describe --all --always "$2"
 551                 }
 552         ) )
 553         test -z "$revname" || revname=" ($revname)"
 554 }
 555 #
 556 # Show commit summary for submodules in index or working tree
 557 #
 558 # If '--cached' is given, show summary between index and given commit,
 559 # or between working tree and given commit
 560 #
 561 # $@ = [commit (default 'HEAD'),] requested paths (default all)
 562 #
 563 cmd_summary() {
 564         summary_limit=-1
 565         for_status=
 566         diff_cmd=diff-index
 567
 568         # parse $args after "submodule ... summary".
 569         while test $# -ne 0
 570         do
 571                 case "$1" in
 572                 --cached)
 573                         cached="$1"
 574                         ;;
 575                 --files)
 576                         files="$1"
 577                         ;;
 578                 --for-status)
 579                         for_status="$1"
 580                         ;;
 581                 -n|--summary-limit)
 582                         if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
 583                         then
 584                                 :
 585                         else
 586                                 usage
 587                         fi
 588                         shift
 589                         ;;
 590                 --)
 591                         shift
 592                         break
 593                         ;;
 594                 -*)
 595                         usage
 596                         ;;
 597                 *)
 598                         break
 599                         ;;
 600                 esac
 601                 shift
 602         done
 603
 604         test $summary_limit = 0 && return
 605
 606         if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
 607         then
 608                 head=$rev
 609                 test $# = 0 || shift
 610         elif test -z "$1" -o "$1" = "HEAD"
 611         then
 612                 # before the first commit: compare with an empty tree
 613                 head=$(git hash-object -w -t tree --stdin </dev/null)
 614                 test -z "$1" || shift
 615         else
 616                 head="HEAD"
 617         fi
 618
 619         if [ -n "$files" ]
 620         then
 621                 test -n "$cached" &&
 622                 die "$(gettext -- "--cached cannot be used with --files")"
 623                 diff_cmd=diff-files
 624                 head=
 625         fi
 626
 627         cd_to_toplevel
 628         # Get modified modules cared by user
 629         modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
 630                 sane_egrep '^:([0-7]* )?160000' |
 631                 while read mod_src mod_dst sha1_src sha1_dst status name
 632                 do
 633                         # Always show modules deleted or type-changed (blob<->module)
 634                         test $status = D -o $status = T && echo "$name" && continue
 635                         # Also show added or modified modules which are checked out
 636                         GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
 637                         echo "$name"
 638                 done
 639         )
 640
 641         test -z "$modules" && return
 642
 643         git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
 644         sane_egrep '^:([0-7]* )?160000' |
 645         cut -c2- |
 646         while read mod_src mod_dst sha1_src sha1_dst status name
 647         do
 648                 if test -z "$cached" &&
 649                         test $sha1_dst = 0000000000000000000000000000000000000000
 650                 then
 651                         case "$mod_dst" in
 652                         160000)
 653                                 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
 654                                 ;;
 655                         100644 | 100755 | 120000)
 656                                 sha1_dst=$(git hash-object $name)
 657                                 ;;
 658                         000000)
 659                                 ;; # removed
 660                         *)
 661                                 # unexpected type
 662                                 (
 663                                         eval_gettext "unexpected mode \$mod_dst" &&
 664                                         echo
 665                                 ) >&2
 666                                 continue ;;
 667                         esac
 668                 fi
 669                 missing_src=
 670                 missing_dst=
 671
 672                 test $mod_src = 160000 &&
 673                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
 674                 missing_src=t
 675
 676                 test $mod_dst = 160000 &&
 677                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
 678                 missing_dst=t
 679
 680                 total_commits=
 681                 case "$missing_src,$missing_dst" in
 682                 t,)
 683                         errmsg="$(eval_gettext "  Warn: \$name doesn't contain commit \$sha1_src")"
 684                         ;;
 685                 ,t)
 686                         errmsg="$(eval_gettext "  Warn: \$name doesn't contain commit \$sha1_dst")"
 687                         ;;
 688                 t,t)
 689                         errmsg="$(eval_gettext "  Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
 690                         ;;
 691                 *)
 692                         errmsg=
 693                         total_commits=$(
 694                         if test $mod_src = 160000 -a $mod_dst = 160000
 695                         then
 696                                 range="$sha1_src...$sha1_dst"
 697                         elif test $mod_src = 160000
 698                         then
 699                                 range=$sha1_src
 700                         else
 701                                 range=$sha1_dst
 702                         fi
 703                         GIT_DIR="$name/.git" \
 704                         git rev-list --first-parent $range -- | wc -l
 705                         )
 706                         total_commits=" ($(($total_commits + 0)))"
 707                         ;;
 708                 esac
 709
 710                 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
 711                 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
 712                 if test $status = T
 713                 then
 714                         blob="$(gettext "blob")"
 715                         submodule="$(gettext "submodule")"
 716                         if test $mod_dst = 160000
 717                         then
 718                                 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
 719                         else
 720                                 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
 721                         fi
 722                 else
 723                         echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
 724                 fi
 725                 if test -n "$errmsg"
 726                 then
 727                         # Don't give error msg for modification whose dst is not submodule
 728                         # i.e. deleted or changed to blob
 729                         test $mod_dst = 160000 && echo "$errmsg"
 730                 else
 731                         if test $mod_src = 160000 -a $mod_dst = 160000
 732                         then
 733                                 limit=
 734                                 test $summary_limit -gt 0 && limit="-$summary_limit"
 735                                 GIT_DIR="$name/.git" \
 736                                 git log $limit --pretty='format:  %m %s' \
 737                                 --first-parent $sha1_src...$sha1_dst
 738                         elif test $mod_dst = 160000
 739                         then
 740                                 GIT_DIR="$name/.git" \
 741                                 git log --pretty='format:  > %s' -1 $sha1_dst
 742                         else
 743                                 GIT_DIR="$name/.git" \
 744                                 git log --pretty='format:  < %s' -1 $sha1_src
 745                         fi
 746                         echo
 747                 fi
 748                 echo
 749         done |
 750         if test -n "$for_status"; then
 751                 if [ -n "$files" ]; then
 752                         status_msg="$(gettext "# Submodules changed but not updated:")"
 753                 else
 754                         status_msg="$(gettext "# Submodule changes to be committed:")"
 755                 fi
 756                 status_sed=$(sed -e 's|^|# |' -e 's|^# $|#|')
 757                 cat <<EOF
 758 $status_msg
 759 #
 760 $status_sed
 761 EOF
 762         else
 763                 cat
 764         fi
 765 }
 766 #
 767 # List all submodules, prefixed with:
 768 #  - submodule not initialized
 769 #  + different revision checked out
 770 #
 771 # If --cached was specified the revision in the index will be printed
 772 # instead of the currently checked out revision.
 773 #
 774 # $@ = requested paths (default to all)
 775 #
 776 cmd_status()
 777 {
 778         # parse $args after "submodule ... status".
 779         orig_flags=
 780         while test $# -ne 0
 781         do
 782                 case "$1" in
 783                 -q|--quiet)
 784                         GIT_QUIET=1
 785                         ;;
 786                 --cached)
 787                         cached=1
 788                         ;;
 789                 --recursive)
 790                         recursive=1
 791                         ;;
 792                 --)
 793                         shift
 794                         break
 795                         ;;
 796                 -*)
 797                         usage
 798                         ;;
 799                 *)
 800                         break
 801                         ;;
 802                 esac
 803                 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 804                 shift
 805         done
 806
 807         module_list "$@" |
 808         while read mode sha1 stage path
 809         do
 810                 name=$(module_name "$path") || exit
 811                 url=$(git config submodule."$name".url)
 812                 displaypath="$prefix$path"
 813                 if test "$stage" = U
 814                 then
 815                         say "U$sha1 $displaypath"
 816                         continue
 817                 fi
 818                 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
 819                 then
 820                         say "-$sha1 $displaypath"
 821                         continue;
 822                 fi
 823                 set_name_rev "$path" "$sha1"
 824                 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
 825                 then
 826                         say " $sha1 $displaypath$revname"
 827                 else
 828                         if test -z "$cached"
 829                         then
 830                                 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
 831                                 set_name_rev "$path" "$sha1"
 832                         fi
 833                         say "+$sha1 $displaypath$revname"
 834                 fi
 835
 836                 if test -n "$recursive"
 837                 then
 838                         (
 839                                 prefix="$displaypath/"
 840                                 clear_local_git_env
 841                                 cd "$path" &&
 842                                 eval cmd_status "$orig_args"
 843                         ) ||
 844                         die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
 845                 fi
 846         done
 847 }
 848 #
 849 # Sync remote urls for submodules
 850 # This makes the value for remote.$remote.url match the value
 851 # specified in .gitmodules.
 852 #
 853 cmd_sync()
 854 {
 855         while test $# -ne 0
 856         do
 857                 case "$1" in
 858                 -q|--quiet)
 859                         GIT_QUIET=1
 860                         shift
 861                         ;;
 862                 --)
 863                         shift
 864                         break
 865                         ;;
 866                 -*)
 867                         usage
 868                         ;;
 869                 *)
 870                         break
 871                         ;;
 872                 esac
 873         done
 874         cd_to_toplevel
 875         module_list "$@" |
 876         while read mode sha1 stage path
 877         do
 878                 name=$(module_name "$path")
 879                 url=$(git config -f .gitmodules --get submodule."$name".url)
 880
 881                 # Possibly a url relative to parent
 882                 case "$url" in
 883                 ./*|../*)
 884                         url=$(resolve_relative_url "$url") || exit
 885                         ;;
 886                 esac
 887
 888                 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
 889                 git config submodule."$name".url "$url"
 890
 891                 if test -e "$path"/.git
 892                 then
 893                 (
 894                         clear_local_git_env
 895                         cd "$path"
 896                         remote=$(get_default_remote)
 897                         git config remote."$remote".url "$url"
 898                 )
 899                 fi
 900         done
 901 }
 902
 903 # This loop parses the command line arguments to find the
 904 # subcommand name to dispatch.  Parsing of the subcommand specific
 905 # options are primarily done by the subcommand implementations.
 906 # Subcommand specific options such as --branch and --cached are
 907 # parsed here as well, for backward compatibility.
 908
 909 while test $# != 0 && test -z "$command"
 910 do
 911         case "$1" in
 912         add | foreach | init | update | status | summary | sync)
 913                 command=$1
 914                 ;;
 915         -q|--quiet)
 916                 GIT_QUIET=1
 917                 ;;
 918         -b|--branch)
 919                 case "$2" in
 920                 '')
 921                         usage
 922                         ;;
 923                 esac
 924                 branch="$2"; shift
 925                 ;;
 926         --cached)
 927                 cached="$1"
 928                 ;;
 929         --)
 930                 break
 931                 ;;
 932         -*)
 933                 usage
 934                 ;;
 935         *)
 936                 break
 937                 ;;
 938         esac
 939         shift
 940 done
 941
 942 # No command word defaults to "status"
 943 test -n "$command" || command=status
 944
 945 # "-b branch" is accepted only by "add"
 946 if test -n "$branch" && test "$command" != add
 947 then
 948         usage
 949 fi
 950
 951 # "--cached" is accepted only by "status" and "summary"
 952 if test -n "$cached" && test "$command" != status -a "$command" != summary
 953 then
 954         usage
 955 fi
 956
 957 "cmd_$command" "$@"