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                 (
 227                         eval_gettext "The following path is ignored by one of your .gitignore files:
 228 \$path
 229 Use -f if you really want to add it." &&
 230                         echo
 231                 ) >&2
 232                 exit 1
 233         fi
 234
 235         # perhaps the path exists and is already a git repo, else clone it
 236         if test -e "$path"
 237         then
 238                 if test -d "$path"/.git -o -f "$path"/.git
 239                 then
 240                         eval_gettext "Adding existing repo at '\$path' to the index"; echo
 241                 else
 242                         die "$(eval_gettext "'\$path' already exists and is not a valid git repo")"
 243                 fi
 244
 245                 case "$repo" in
 246                 ./*|../*)
 247                         url=$(resolve_relative_url "$repo") || exit
 248                     ;;
 249                 *)
 250                         url="$repo"
 251                         ;;
 252                 esac
 253                 git config submodule."$path".url "$url"
 254         else
 255
 256                 module_clone "$path" "$realrepo" "$reference" || exit
 257                 (
 258                         clear_local_git_env
 259                         cd "$path" &&
 260                         # ash fails to wordsplit ${branch:+-b "$branch"...}
 261                         case "$branch" in
 262                         '') git checkout -f -q ;;
 263                         ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
 264                         esac
 265                 ) || die "$(eval_gettext "Unable to checkout submodule '\$path'")"
 266         fi
 267
 268         git add $force "$path" ||
 269         die "$(eval_gettext "Failed to add submodule '\$path'")"
 270
 271         git config -f .gitmodules submodule."$path".path "$path" &&
 272         git config -f .gitmodules submodule."$path".url "$repo" &&
 273         git add --force .gitmodules ||
 274         die "$(eval_gettext "Failed to register submodule '\$path'")"
 275 }
 276
 277 #
 278 # Execute an arbitrary command sequence in each checked out
 279 # submodule
 280 #
 281 # $@ = command to execute
 282 #
 283 cmd_foreach()
 284 {
 285         # parse $args after "submodule ... foreach".
 286         while test $# -ne 0
 287         do
 288                 case "$1" in
 289                 -q|--quiet)
 290                         GIT_QUIET=1
 291                         ;;
 292                 --recursive)
 293                         recursive=1
 294                         ;;
 295                 -*)
 296                         usage
 297                         ;;
 298                 *)
 299                         break
 300                         ;;
 301                 esac
 302                 shift
 303         done
 304
 305         toplevel=$(pwd)
 306
 307         module_list |
 308         while read mode sha1 stage path
 309         do
 310                 if test -e "$path"/.git
 311                 then
 312                         say "$(eval_gettext "Entering '\$prefix\$path'")"
 313                         name=$(module_name "$path")
 314                         (
 315                                 prefix="$prefix$path/"
 316                                 clear_local_git_env
 317                                 cd "$path" &&
 318                                 eval "$@" &&
 319                                 if test -n "$recursive"
 320                                 then
 321                                         cmd_foreach "--recursive" "$@"
 322                                 fi
 323                         ) ||
 324                         die "$(eval_gettext "Stopping at '\$path'; script returned non-zero status.")"
 325                 fi
 326         done
 327 }
 328
 329 #
 330 # Register submodules in .git/config
 331 #
 332 # $@ = requested paths (default to all)
 333 #
 334 cmd_init()
 335 {
 336         # parse $args after "submodule ... init".
 337         while test $# -ne 0
 338         do
 339                 case "$1" in
 340                 -q|--quiet)
 341                         GIT_QUIET=1
 342                         ;;
 343                 --)
 344                         shift
 345                         break
 346                         ;;
 347                 -*)
 348                         usage
 349                         ;;
 350                 *)
 351                         break
 352                         ;;
 353                 esac
 354                 shift
 355         done
 356
 357         module_list "$@" |
 358         while read mode sha1 stage path
 359         do
 360                 # Skip already registered paths
 361                 name=$(module_name "$path") || exit
 362                 url=$(git config submodule."$name".url)
 363                 test -z "$url" || continue
 364
 365                 url=$(git config -f .gitmodules submodule."$name".url)
 366                 test -z "$url" &&
 367                 die "$(eval_gettext "No url found for submodule path '\$path' in .gitmodules")"
 368
 369                 # Possibly a url relative to parent
 370                 case "$url" in
 371                 ./*|../*)
 372                         url=$(resolve_relative_url "$url") || exit
 373                         ;;
 374                 esac
 375
 376                 git config submodule."$name".url "$url" ||
 377                 die "$(eval_gettext "Failed to register url for submodule path '\$path'")"
 378
 379                 upd="$(git config -f .gitmodules submodule."$name".update)"
 380                 test -z "$upd" ||
 381                 git config submodule."$name".update "$upd" ||
 382                 die "$(eval_gettext "Failed to register update mode for submodule path '\$path'")"
 383
 384                 say "$(eval_gettext "Submodule '\$name' (\$url) registered for path '\$path'")"
 385         done
 386 }
 387
 388 #
 389 # Update each submodule path to correct revision, using clone and checkout as needed
 390 #
 391 # $@ = requested paths (default to all)
 392 #
 393 cmd_update()
 394 {
 395         # parse $args after "submodule ... update".
 396         orig_flags=
 397         while test $# -ne 0
 398         do
 399                 case "$1" in
 400                 -q|--quiet)
 401                         GIT_QUIET=1
 402                         ;;
 403                 -i|--init)
 404                         init=1
 405                         ;;
 406                 -N|--no-fetch)
 407                         nofetch=1
 408                         ;;
 409                 -f|--force)
 410                         force=$1
 411                         ;;
 412                 -r|--rebase)
 413                         update="rebase"
 414                         ;;
 415                 --reference)
 416                         case "$2" in '') usage ;; esac
 417                         reference="--reference=$2"
 418                         orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 419                         shift
 420                         ;;
 421                 --reference=*)
 422                         reference="$1"
 423                         ;;
 424                 -m|--merge)
 425                         update="merge"
 426                         ;;
 427                 --recursive)
 428                         recursive=1
 429                         ;;
 430                 --)
 431                         shift
 432                         break
 433                         ;;
 434                 -*)
 435                         usage
 436                         ;;
 437                 *)
 438                         break
 439                         ;;
 440                 esac
 441                 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 442                 shift
 443         done
 444
 445         if test -n "$init"
 446         then
 447                 cmd_init "--" "$@" || return
 448         fi
 449
 450         cloned_modules=
 451         module_list "$@" |
 452         while read mode sha1 stage path
 453         do
 454                 if test "$stage" = U
 455                 then
 456                         echo >&2 "Skipping unmerged submodule $path"
 457                         continue
 458                 fi
 459                 name=$(module_name "$path") || exit
 460                 url=$(git config submodule."$name".url)
 461                 update_module=$(git config submodule."$name".update)
 462                 if test -z "$url"
 463                 then
 464                         # Only mention uninitialized submodules when its
 465                         # path have been specified
 466                         test "$#" != "0" &&
 467                         say "$(eval_gettext "Submodule path '\$path' not initialized
 468 Maybe you want to use 'update --init'?")"
 469                         continue
 470                 fi
 471
 472                 if ! test -d "$path"/.git -o -f "$path"/.git
 473                 then
 474                         module_clone "$path" "$url" "$reference"|| exit
 475                         cloned_modules="$cloned_modules;$name"
 476                         subsha1=
 477                 else
 478                         subsha1=$(clear_local_git_env; cd "$path" &&
 479                                 git rev-parse --verify HEAD) ||
 480                         die "$(eval_gettext "Unable to find current revision in submodule path '\$path'")"
 481                 fi
 482
 483                 if ! test -z "$update"
 484                 then
 485                         update_module=$update
 486                 fi
 487
 488                 if test "$subsha1" != "$sha1"
 489                 then
 490                         subforce=$force
 491                         # If we don't already have a -f flag and the submodule has never been checked out
 492                         if test -z "$subsha1" -a -z "$force"
 493                         then
 494                                 subforce="-f"
 495                         fi
 496
 497                         if test -z "$nofetch"
 498                         then
 499                                 # Run fetch only if $sha1 isn't present or it
 500                                 # is not reachable from a ref.
 501                                 (clear_local_git_env; cd "$path" &&
 502                                         ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
 503                                          test -z "$rev") || git-fetch)) ||
 504                                 die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
 505                         fi
 506
 507                         # Is this something we just cloned?
 508                         case ";$cloned_modules;" in
 509                         *";$name;"*)
 510                                 # then there is no local change to integrate
 511                                 update_module= ;;
 512                         esac
 513
 514                         case "$update_module" in
 515                         rebase)
 516                                 command="git rebase"
 517                                 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$path'")"
 518                                 say_msg="$(eval_gettext "Submodule path '\$path': rebased into '\$sha1'")"
 519                                 ;;
 520                         merge)
 521                                 command="git merge"
 522                                 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$path'")"
 523                                 say_msg="$(eval_gettext "Submodule path '\$path': merged in '\$sha1'")"
 524                                 ;;
 525                         *)
 526                                 command="git checkout $subforce -q"
 527                                 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$path'")"
 528                                 say_msg="$(eval_gettext "Submodule path '\$path': checked out '\$sha1'")"
 529                                 ;;
 530                         esac
 531
 532                         (clear_local_git_env; cd "$path" && $command "$sha1") || die $die_msg
 533                         say $say_msg
 534                 fi
 535
 536                 if test -n "$recursive"
 537                 then
 538                         (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") ||
 539                         die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
 540                 fi
 541         done
 542 }
 543
 544 set_name_rev () {
 545         revname=$( (
 546                 clear_local_git_env
 547                 cd "$1" && {
 548                         git describe "$2" 2>/dev/null ||
 549                         git describe --tags "$2" 2>/dev/null ||
 550                         git describe --contains "$2" 2>/dev/null ||
 551                         git describe --all --always "$2"
 552                 }
 553         ) )
 554         test -z "$revname" || revname=" ($revname)"
 555 }
 556 #
 557 # Show commit summary for submodules in index or working tree
 558 #
 559 # If '--cached' is given, show summary between index and given commit,
 560 # or between working tree and given commit
 561 #
 562 # $@ = [commit (default 'HEAD'),] requested paths (default all)
 563 #
 564 cmd_summary() {
 565         summary_limit=-1
 566         for_status=
 567         diff_cmd=diff-index
 568
 569         # parse $args after "submodule ... summary".
 570         while test $# -ne 0
 571         do
 572                 case "$1" in
 573                 --cached)
 574                         cached="$1"
 575                         ;;
 576                 --files)
 577                         files="$1"
 578                         ;;
 579                 --for-status)
 580                         for_status="$1"
 581                         ;;
 582                 -n|--summary-limit)
 583                         if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
 584                         then
 585                                 :
 586                         else
 587                                 usage
 588                         fi
 589                         shift
 590                         ;;
 591                 --)
 592                         shift
 593                         break
 594                         ;;
 595                 -*)
 596                         usage
 597                         ;;
 598                 *)
 599                         break
 600                         ;;
 601                 esac
 602                 shift
 603         done
 604
 605         test $summary_limit = 0 && return
 606
 607         if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
 608         then
 609                 head=$rev
 610                 test $# = 0 || shift
 611         elif test -z "$1" -o "$1" = "HEAD"
 612         then
 613                 # before the first commit: compare with an empty tree
 614                 head=$(git hash-object -w -t tree --stdin </dev/null)
 615                 test -z "$1" || shift
 616         else
 617                 head="HEAD"
 618         fi
 619
 620         if [ -n "$files" ]
 621         then
 622                 test -n "$cached" &&
 623                 die "$(gettext -- "--cached cannot be used with --files")"
 624                 diff_cmd=diff-files
 625                 head=
 626         fi
 627
 628         cd_to_toplevel
 629         # Get modified modules cared by user
 630         modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
 631                 sane_egrep '^:([0-7]* )?160000' |
 632                 while read mod_src mod_dst sha1_src sha1_dst status name
 633                 do
 634                         # Always show modules deleted or type-changed (blob<->module)
 635                         test $status = D -o $status = T && echo "$name" && continue
 636                         # Also show added or modified modules which are checked out
 637                         GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
 638                         echo "$name"
 639                 done
 640         )
 641
 642         test -z "$modules" && return
 643
 644         git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
 645         sane_egrep '^:([0-7]* )?160000' |
 646         cut -c2- |
 647         while read mod_src mod_dst sha1_src sha1_dst status name
 648         do
 649                 if test -z "$cached" &&
 650                         test $sha1_dst = 0000000000000000000000000000000000000000
 651                 then
 652                         case "$mod_dst" in
 653                         160000)
 654                                 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
 655                                 ;;
 656                         100644 | 100755 | 120000)
 657                                 sha1_dst=$(git hash-object $name)
 658                                 ;;
 659                         000000)
 660                                 ;; # removed
 661                         *)
 662                                 # unexpected type
 663                                 (
 664                                         eval_gettext "unexpected mode \$mod_dst" &&
 665                                         echo
 666                                 ) >&2
 667                                 continue ;;
 668                         esac
 669                 fi
 670                 missing_src=
 671                 missing_dst=
 672
 673                 test $mod_src = 160000 &&
 674                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
 675                 missing_src=t
 676
 677                 test $mod_dst = 160000 &&
 678                 ! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
 679                 missing_dst=t
 680
 681                 total_commits=
 682                 case "$missing_src,$missing_dst" in
 683                 t,)
 684                         errmsg="$(eval_gettext "  Warn: \$name doesn't contain commit \$sha1_src")"
 685                         ;;
 686                 ,t)
 687                         errmsg="$(eval_gettext "  Warn: \$name doesn't contain commit \$sha1_dst")"
 688                         ;;
 689                 t,t)
 690                         errmsg="$(eval_gettext "  Warn: \$name doesn't contain commits \$sha1_src and \$sha1_dst")"
 691                         ;;
 692                 *)
 693                         errmsg=
 694                         total_commits=$(
 695                         if test $mod_src = 160000 -a $mod_dst = 160000
 696                         then
 697                                 range="$sha1_src...$sha1_dst"
 698                         elif test $mod_src = 160000
 699                         then
 700                                 range=$sha1_src
 701                         else
 702                                 range=$sha1_dst
 703                         fi
 704                         GIT_DIR="$name/.git" \
 705                         git rev-list --first-parent $range -- | wc -l
 706                         )
 707                         total_commits=" ($(($total_commits + 0)))"
 708                         ;;
 709                 esac
 710
 711                 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
 712                 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
 713                 if test $status = T
 714                 then
 715                         blob="$(gettext "blob")"
 716                         submodule="$(gettext "submodule")"
 717                         if test $mod_dst = 160000
 718                         then
 719                                 echo "* $name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
 720                         else
 721                                 echo "* $name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
 722                         fi
 723                 else
 724                         echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
 725                 fi
 726                 if test -n "$errmsg"
 727                 then
 728                         # Don't give error msg for modification whose dst is not submodule
 729                         # i.e. deleted or changed to blob
 730                         test $mod_dst = 160000 && echo "$errmsg"
 731                 else
 732                         if test $mod_src = 160000 -a $mod_dst = 160000
 733                         then
 734                                 limit=
 735                                 test $summary_limit -gt 0 && limit="-$summary_limit"
 736                                 GIT_DIR="$name/.git" \
 737                                 git log $limit --pretty='format:  %m %s' \
 738                                 --first-parent $sha1_src...$sha1_dst
 739                         elif test $mod_dst = 160000
 740                         then
 741                                 GIT_DIR="$name/.git" \
 742                                 git log --pretty='format:  > %s' -1 $sha1_dst
 743                         else
 744                                 GIT_DIR="$name/.git" \
 745                                 git log --pretty='format:  < %s' -1 $sha1_src
 746                         fi
 747                         echo
 748                 fi
 749                 echo
 750         done |
 751         if test -n "$for_status"; then
 752                 if [ -n "$files" ]; then
 753                         gettext "# Submodules changed but not updated:"; echo
 754                 else
 755                         gettext "# Submodule changes to be committed:"; echo
 756                 fi
 757                 echo "#"
 758                 sed -e 's|^|# |' -e 's|^# $|#|'
 759         else
 760                 cat
 761         fi
 762 }
 763 #
 764 # List all submodules, prefixed with:
 765 #  - submodule not initialized
 766 #  + different revision checked out
 767 #
 768 # If --cached was specified the revision in the index will be printed
 769 # instead of the currently checked out revision.
 770 #
 771 # $@ = requested paths (default to all)
 772 #
 773 cmd_status()
 774 {
 775         # parse $args after "submodule ... status".
 776         orig_flags=
 777         while test $# -ne 0
 778         do
 779                 case "$1" in
 780                 -q|--quiet)
 781                         GIT_QUIET=1
 782                         ;;
 783                 --cached)
 784                         cached=1
 785                         ;;
 786                 --recursive)
 787                         recursive=1
 788                         ;;
 789                 --)
 790                         shift
 791                         break
 792                         ;;
 793                 -*)
 794                         usage
 795                         ;;
 796                 *)
 797                         break
 798                         ;;
 799                 esac
 800                 orig_flags="$orig_flags $(git rev-parse --sq-quote "$1")"
 801                 shift
 802         done
 803
 804         module_list "$@" |
 805         while read mode sha1 stage path
 806         do
 807                 name=$(module_name "$path") || exit
 808                 url=$(git config submodule."$name".url)
 809                 displaypath="$prefix$path"
 810                 if test "$stage" = U
 811                 then
 812                         say "U$sha1 $displaypath"
 813                         continue
 814                 fi
 815                 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
 816                 then
 817                         say "-$sha1 $displaypath"
 818                         continue;
 819                 fi
 820                 set_name_rev "$path" "$sha1"
 821                 if git diff-files --ignore-submodules=dirty --quiet -- "$path"
 822                 then
 823                         say " $sha1 $displaypath$revname"
 824                 else
 825                         if test -z "$cached"
 826                         then
 827                                 sha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD)
 828                                 set_name_rev "$path" "$sha1"
 829                         fi
 830                         say "+$sha1 $displaypath$revname"
 831                 fi
 832
 833                 if test -n "$recursive"
 834                 then
 835                         (
 836                                 prefix="$displaypath/"
 837                                 clear_local_git_env
 838                                 cd "$path" &&
 839                                 eval cmd_status "$orig_args"
 840                         ) ||
 841                         die "$(eval_gettext "Failed to recurse into submodule path '\$path'")"
 842                 fi
 843         done
 844 }
 845 #
 846 # Sync remote urls for submodules
 847 # This makes the value for remote.$remote.url match the value
 848 # specified in .gitmodules.
 849 #
 850 cmd_sync()
 851 {
 852         while test $# -ne 0
 853         do
 854                 case "$1" in
 855                 -q|--quiet)
 856                         GIT_QUIET=1
 857                         shift
 858                         ;;
 859                 --)
 860                         shift
 861                         break
 862                         ;;
 863                 -*)
 864                         usage
 865                         ;;
 866                 *)
 867                         break
 868                         ;;
 869                 esac
 870         done
 871         cd_to_toplevel
 872         module_list "$@" |
 873         while read mode sha1 stage path
 874         do
 875                 name=$(module_name "$path")
 876                 url=$(git config -f .gitmodules --get submodule."$name".url)
 877
 878                 # Possibly a url relative to parent
 879                 case "$url" in
 880                 ./*|../*)
 881                         url=$(resolve_relative_url "$url") || exit
 882                         ;;
 883                 esac
 884
 885                 say "$(eval_gettext "Synchronizing submodule url for '\$name'")"
 886                 git config submodule."$name".url "$url"
 887
 888                 if test -e "$path"/.git
 889                 then
 890                 (
 891                         clear_local_git_env
 892                         cd "$path"
 893                         remote=$(get_default_remote)
 894                         git config remote."$remote".url "$url"
 895                 )
 896                 fi
 897         done
 898 }
 899
 900 # This loop parses the command line arguments to find the
 901 # subcommand name to dispatch.  Parsing of the subcommand specific
 902 # options are primarily done by the subcommand implementations.
 903 # Subcommand specific options such as --branch and --cached are
 904 # parsed here as well, for backward compatibility.
 905
 906 while test $# != 0 && test -z "$command"
 907 do
 908         case "$1" in
 909         add | foreach | init | update | status | summary | sync)
 910                 command=$1
 911                 ;;
 912         -q|--quiet)
 913                 GIT_QUIET=1
 914                 ;;
 915         -b|--branch)
 916                 case "$2" in
 917                 '')
 918                         usage
 919                         ;;
 920                 esac
 921                 branch="$2"; shift
 922                 ;;
 923         --cached)
 924                 cached="$1"
 925                 ;;
 926         --)
 927                 break
 928                 ;;
 929         -*)
 930                 usage
 931                 ;;
 932         *)
 933                 break
 934                 ;;
 935         esac
 936         shift
 937 done
 938
 939 # No command word defaults to "status"
 940 test -n "$command" || command=status
 941
 942 # "-b branch" is accepted only by "add"
 943 if test -n "$branch" && test "$command" != add
 944 then
 945         usage
 946 fi
 947
 948 # "--cached" is accepted only by "status" and "summary"
 949 if test -n "$cached" && test "$command" != status -a "$command" != summary
 950 then
 951         usage
 952 fi
 953
 954 "cmd_$command" "$@"