git-submodule.sh

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