git.oblomov.eu Git - git/blob - 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] (--all| [--] <path>...)
  12    or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--[no-]recommend-shallow] [--reference <repository>] [--recursive] [--] [<path>...]
  13    or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
  14    or: $dashless [--quiet] foreach [--recursive] <command>
  15    or: $dashless [--quiet] sync [--recursive] [--] [<path>...]
  16    or: $dashless [--quiet] absorbgitdirs [--] [<path>...]"
  17 OPTIONS_SPEC=
  18 SUBDIRECTORY_OK=Yes
  19 . git-sh-setup
  20 . git-parse-remote
  21 require_work_tree
  22 wt_prefix=$(git rev-parse --show-prefix)
  23 cd_to_toplevel
  24
  25 # Tell the rest of git that any URLs we get don't come
  26 # directly from the user, so it can apply policy as appropriate.
  27 GIT_PROTOCOL_FROM_USER=0
  28 export GIT_PROTOCOL_FROM_USER
  29
  30 command=
  31 branch=
  32 force=
  33 reference=
  34 cached=
  35 recursive=
  36 init=
  37 files=
  38 remote=
  39 nofetch=
  40 update=
  41 prefix=
  42 custom_name=
  43 depth=
  44 progress=
  45 dissociate=
  46
  47 die_if_unmatched ()
  48 {
  49         if test "$1" = "#unmatched"
  50         then
  51                 exit ${2:-1}
  52         fi
  53 }
  54
  55 #
  56 # Print a submodule configuration setting
  57 #
  58 # $1 = submodule name
  59 # $2 = option name
  60 # $3 = default value
  61 #
  62 # Checks in the usual git-config places first (for overrides),
  63 # otherwise it falls back on .gitmodules.  This allows you to
  64 # distribute project-wide defaults in .gitmodules, while still
  65 # customizing individual repositories if necessary.  If the option is
  66 # not in .gitmodules either, print a default value.
  67 #
  68 get_submodule_config () {
  69         name="$1"
  70         option="$2"
  71         default="$3"
  72         value=$(git config submodule."$name"."$option")
  73         if test -z "$value"
  74         then
  75                 value=$(git config -f .gitmodules submodule."$name"."$option")
  76         fi
  77         printf '%s' "${value:-$default}"
  78 }
  79
  80 isnumber()
  81 {
  82         n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
  83 }
  84
  85 # Given a full hex object ID, is this the zero OID?
  86 is_zero_oid () {
  87         echo "$1" | sane_egrep '^0+$' >/dev/null 2>&1
  88 }
  89
  90 # Sanitize the local git environment for use within a submodule. We
  91 # can't simply use clear_local_git_env since we want to preserve some
  92 # of the settings from GIT_CONFIG_PARAMETERS.
  93 sanitize_submodule_env()
  94 {
  95         save_config=$GIT_CONFIG_PARAMETERS
  96         clear_local_git_env
  97         GIT_CONFIG_PARAMETERS=$save_config
  98         export GIT_CONFIG_PARAMETERS
  99 }
 100
 101 #
 102 # Add a new submodule to the working tree, .gitmodules and the index
 103 #
 104 # $@ = repo path
 105 #
 106 # optional branch is stored in global branch variable
 107 #
 108 cmd_add()
 109 {
 110         # parse $args after "submodule ... add".
 111         reference_path=
 112         while test $# -ne 0
 113         do
 114                 case "$1" in
 115                 -b | --branch)
 116                         case "$2" in '') usage ;; esac
 117                         branch=$2
 118                         shift
 119                         ;;
 120                 -f | --force)
 121                         force=$1
 122                         ;;
 123                 -q|--quiet)
 124                         GIT_QUIET=1
 125                         ;;
 126                 --progress)
 127                         progress=1
 128                         ;;
 129                 --reference)
 130                         case "$2" in '') usage ;; esac
 131                         reference_path=$2
 132                         shift
 133                         ;;
 134                 --reference=*)
 135                         reference_path="${1#--reference=}"
 136                         ;;
 137                 --dissociate)
 138                         dissociate=1
 139                         ;;
 140                 --name)
 141                         case "$2" in '') usage ;; esac
 142                         custom_name=$2
 143                         shift
 144                         ;;
 145                 --depth)
 146                         case "$2" in '') usage ;; esac
 147                         depth="--depth=$2"
 148                         shift
 149                         ;;
 150                 --depth=*)
 151                         depth=$1
 152                         ;;
 153                 --)
 154                         shift
 155                         break
 156                         ;;
 157                 -*)
 158                         usage
 159                         ;;
 160                 *)
 161                         break
 162                         ;;
 163                 esac
 164                 shift
 165         done
 166
 167         if test -n "$reference_path"
 168         then
 169                 is_absolute_path "$reference_path" ||
 170                 reference_path="$wt_prefix$reference_path"
 171
 172                 reference="--reference=$reference_path"
 173         fi
 174
 175         repo=$1
 176         sm_path=$2
 177
 178         if test -z "$sm_path"; then
 179                 sm_path=$(printf '%s\n' "$repo" |
 180                         sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
 181         fi
 182
 183         if test -z "$repo" || test -z "$sm_path"; then
 184                 usage
 185         fi
 186
 187         is_absolute_path "$sm_path" || sm_path="$wt_prefix$sm_path"
 188
 189         # assure repo is absolute or relative to parent
 190         case "$repo" in
 191         ./*|../*)
 192                 test -z "$wt_prefix" ||
 193                 die "$(gettext "Relative path can only be used from the toplevel of the working tree")"
 194
 195                 # dereference source url relative to parent's url
 196                 realrepo=$(git submodule--helper resolve-relative-url "$repo") || exit
 197                 ;;
 198         *:*|/*)
 199                 # absolute url
 200                 realrepo=$repo
 201                 ;;
 202         *)
 203                 die "$(eval_gettext "repo URL: '\$repo' must be absolute or begin with ./|../")"
 204         ;;
 205         esac
 206
 207         # normalize path:
 208         # multiple //; leading ./; /./; /../; trailing /
 209         sm_path=$(printf '%s/\n' "$sm_path" |
 210                 sed -e '
 211                         s|//*|/|g
 212                         s|^\(\./\)*||
 213                         s|/\(\./\)*|/|g
 214                         :start
 215                         s|\([^/]*\)/\.\./||
 216                         tstart
 217                         s|/*$||
 218                 ')
 219         if test -z "$force"
 220         then
 221                 git ls-files --error-unmatch "$sm_path" > /dev/null 2>&1 &&
 222                 die "$(eval_gettext "'\$sm_path' already exists in the index")"
 223         else
 224                 git ls-files -s "$sm_path" | sane_grep -v "^160000" > /dev/null 2>&1 &&
 225                 die "$(eval_gettext "'\$sm_path' already exists in the index and is not a submodule")"
 226         fi
 227
 228         if test -z "$force" &&
 229                 ! git add --dry-run --ignore-missing --no-warn-embedded-repo "$sm_path" > /dev/null 2>&1
 230         then
 231                 eval_gettextln "The following path is ignored by one of your .gitignore files:
 232 \$sm_path
 233 Use -f if you really want to add it." >&2
 234                 exit 1
 235         fi
 236
 237         if test -n "$custom_name"
 238         then
 239                 sm_name="$custom_name"
 240         else
 241                 sm_name="$sm_path"
 242         fi
 243
 244         if ! git submodule--helper check-name "$sm_name"
 245         then
 246                 die "$(eval_gettext "'$sm_name' is not a valid submodule name")"
 247         fi
 248
 249         # perhaps the path exists and is already a git repo, else clone it
 250         if test -e "$sm_path"
 251         then
 252                 if test -d "$sm_path"/.git || test -f "$sm_path"/.git
 253                 then
 254                         eval_gettextln "Adding existing repo at '\$sm_path' to the index"
 255                 else
 256                         die "$(eval_gettext "'\$sm_path' already exists and is not a valid git repo")"
 257                 fi
 258
 259         else
 260                 if test -d ".git/modules/$sm_name"
 261                 then
 262                         if test -z "$force"
 263                         then
 264                                 eval_gettextln >&2 "A git directory for '\$sm_name' is found locally with remote(s):"
 265                                 GIT_DIR=".git/modules/$sm_name" GIT_WORK_TREE=. git remote -v | grep '(fetch)' | sed -e s,^,"  ", -e s,' (fetch)',, >&2
 266                                 die "$(eval_gettextln "\
 267 If you want to reuse this local git directory instead of cloning again from
 268   \$realrepo
 269 use the '--force' option. If the local git directory is not the correct repo
 270 or you are unsure what this means choose another name with the '--name' option.")"
 271                         else
 272                                 eval_gettextln "Reactivating local git directory for submodule '\$sm_name'."
 273                         fi
 274                 fi
 275                 git submodule--helper clone ${GIT_QUIET:+--quiet} ${progress:+"--progress"} --prefix "$wt_prefix" --path "$sm_path" --name "$sm_name" --url "$realrepo" ${reference:+"$reference"} ${dissociate:+"--dissociate"} ${depth:+"$depth"} || exit
 276                 (
 277                         sanitize_submodule_env
 278                         cd "$sm_path" &&
 279                         # ash fails to wordsplit ${branch:+-b "$branch"...}
 280                         case "$branch" in
 281                         '') git checkout -f -q ;;
 282                         ?*) git checkout -f -q -B "$branch" "origin/$branch" ;;
 283                         esac
 284                 ) || die "$(eval_gettext "Unable to checkout submodule '\$sm_path'")"
 285         fi
 286         git config submodule."$sm_name".url "$realrepo"
 287
 288         git add --no-warn-embedded-repo $force "$sm_path" ||
 289         die "$(eval_gettext "Failed to add submodule '\$sm_path'")"
 290
 291         git config -f .gitmodules submodule."$sm_name".path "$sm_path" &&
 292         git config -f .gitmodules submodule."$sm_name".url "$repo" &&
 293         if test -n "$branch"
 294         then
 295                 git config -f .gitmodules submodule."$sm_name".branch "$branch"
 296         fi &&
 297         git add --force .gitmodules ||
 298         die "$(eval_gettext "Failed to register submodule '\$sm_path'")"
 299
 300         # NEEDSWORK: In a multi-working-tree world, this needs to be
 301         # set in the per-worktree config.
 302         if git config --get submodule.active >/dev/null
 303         then
 304                 # If the submodule being adding isn't already covered by the
 305                 # current configured pathspec, set the submodule's active flag
 306                 if ! git submodule--helper is-active "$sm_path"
 307                 then
 308                         git config submodule."$sm_name".active "true"
 309                 fi
 310         else
 311                 git config submodule."$sm_name".active "true"
 312         fi
 313 }
 314
 315 #
 316 # Execute an arbitrary command sequence in each checked out
 317 # submodule
 318 #
 319 # $@ = command to execute
 320 #
 321 cmd_foreach()
 322 {
 323         # parse $args after "submodule ... foreach".
 324         while test $# -ne 0
 325         do
 326                 case "$1" in
 327                 -q|--quiet)
 328                         GIT_QUIET=1
 329                         ;;
 330                 --recursive)
 331                         recursive=1
 332                         ;;
 333                 -*)
 334                         usage
 335                         ;;
 336                 *)
 337                         break
 338                         ;;
 339                 esac
 340                 shift
 341         done
 342
 343         git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper foreach ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
 344 }
 345
 346 #
 347 # Register submodules in .git/config
 348 #
 349 # $@ = requested paths (default to all)
 350 #
 351 cmd_init()
 352 {
 353         # parse $args after "submodule ... init".
 354         while test $# -ne 0
 355         do
 356                 case "$1" in
 357                 -q|--quiet)
 358                         GIT_QUIET=1
 359                         ;;
 360                 --)
 361                         shift
 362                         break
 363                         ;;
 364                 -*)
 365                         usage
 366                         ;;
 367                 *)
 368                         break
 369                         ;;
 370                 esac
 371                 shift
 372         done
 373
 374         git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper init ${GIT_QUIET:+--quiet}  "$@"
 375 }
 376
 377 #
 378 # Unregister submodules from .git/config and remove their work tree
 379 #
 380 cmd_deinit()
 381 {
 382         # parse $args after "submodule ... deinit".
 383         deinit_all=
 384         while test $# -ne 0
 385         do
 386                 case "$1" in
 387                 -f|--force)
 388                         force=$1
 389                         ;;
 390                 -q|--quiet)
 391                         GIT_QUIET=1
 392                         ;;
 393                 --all)
 394                         deinit_all=t
 395                         ;;
 396                 --)
 397                         shift
 398                         break
 399                         ;;
 400                 -*)
 401                         usage
 402                         ;;
 403                 *)
 404                         break
 405                         ;;
 406                 esac
 407                 shift
 408         done
 409
 410         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${GIT_QUIET:+--quiet} ${prefix:+--prefix "$prefix"} ${force:+--force} ${deinit_all:+--all} "$@"
 411 }
 412
 413 is_tip_reachable () (
 414         sanitize_submodule_env &&
 415         cd "$1" &&
 416         rev=$(git rev-list -n 1 "$2" --not --all 2>/dev/null) &&
 417         test -z "$rev"
 418 )
 419
 420 fetch_in_submodule () (
 421         sanitize_submodule_env &&
 422         cd "$1" &&
 423         case "$2" in
 424         '')
 425                 git fetch ;;
 426         *)
 427                 shift
 428                 git fetch $(get_default_remote) "$@" ;;
 429         esac
 430 )
 431
 432 #
 433 # Update each submodule path to correct revision, using clone and checkout as needed
 434 #
 435 # $@ = requested paths (default to all)
 436 #
 437 cmd_update()
 438 {
 439         # parse $args after "submodule ... update".
 440         while test $# -ne 0
 441         do
 442                 case "$1" in
 443                 -q|--quiet)
 444                         GIT_QUIET=1
 445                         ;;
 446                 -v)
 447                         GIT_QUIET=0
 448                         ;;
 449                 --progress)
 450                         progress=1
 451                         ;;
 452                 -i|--init)
 453                         init=1
 454                         ;;
 455                 --remote)
 456                         remote=1
 457                         ;;
 458                 -N|--no-fetch)
 459                         nofetch=1
 460                         ;;
 461                 -f|--force)
 462                         force=$1
 463                         ;;
 464                 -r|--rebase)
 465                         update="rebase"
 466                         ;;
 467                 --reference)
 468                         case "$2" in '') usage ;; esac
 469                         reference="--reference=$2"
 470                         shift
 471                         ;;
 472                 --reference=*)
 473                         reference="$1"
 474                         ;;
 475                 --dissociate)
 476                         dissociate=1
 477                         ;;
 478                 -m|--merge)
 479                         update="merge"
 480                         ;;
 481                 --recursive)
 482                         recursive=1
 483                         ;;
 484                 --checkout)
 485                         update="checkout"
 486                         ;;
 487                 --recommend-shallow)
 488                         recommend_shallow="--recommend-shallow"
 489                         ;;
 490                 --no-recommend-shallow)
 491                         recommend_shallow="--no-recommend-shallow"
 492                         ;;
 493                 --depth)
 494                         case "$2" in '') usage ;; esac
 495                         depth="--depth=$2"
 496                         shift
 497                         ;;
 498                 --depth=*)
 499                         depth=$1
 500                         ;;
 501                 -j|--jobs)
 502                         case "$2" in '') usage ;; esac
 503                         jobs="--jobs=$2"
 504                         shift
 505                         ;;
 506                 --jobs=*)
 507                         jobs=$1
 508                         ;;
 509                 --)
 510                         shift
 511                         break
 512                         ;;
 513                 -*)
 514                         usage
 515                         ;;
 516                 *)
 517                         break
 518                         ;;
 519                 esac
 520                 shift
 521         done
 522
 523         if test -n "$init"
 524         then
 525                 cmd_init "--" "$@" || return
 526         fi
 527
 528         {
 529         git submodule--helper update-clone ${GIT_QUIET:+--quiet} \
 530                 ${progress:+"--progress"} \
 531                 ${wt_prefix:+--prefix "$wt_prefix"} \
 532                 ${prefix:+--recursive-prefix "$prefix"} \
 533                 ${update:+--update "$update"} \
 534                 ${reference:+"$reference"} \
 535                 ${dissociate:+"--dissociate"} \
 536                 ${depth:+--depth "$depth"} \
 537                 $recommend_shallow \
 538                 $jobs \
 539                 "$@" || echo "#unmatched" $?
 540         } | {
 541         err=
 542         while read -r quickabort sha1 just_cloned sm_path
 543         do
 544                 die_if_unmatched "$quickabort" "$sha1"
 545
 546                 git submodule--helper ensure-core-worktree "$sm_path"
 547
 548                 update_module=$(git submodule--helper update-module-mode $just_cloned "$sm_path" $update)
 549
 550                 displaypath=$(git submodule--helper relative-path "$prefix$sm_path" "$wt_prefix")
 551
 552                 if test $just_cloned -eq 1
 553                 then
 554                         subsha1=
 555                 else
 556                         subsha1=$(sanitize_submodule_env; cd "$sm_path" &&
 557                                 git rev-parse --verify HEAD) ||
 558                         die "$(eval_gettext "Unable to find current revision in submodule path '\$displaypath'")"
 559                 fi
 560
 561                 if test -n "$remote"
 562                 then
 563                         branch=$(git submodule--helper remote-branch "$sm_path")
 564                         if test -z "$nofetch"
 565                         then
 566                                 # Fetch remote before determining tracking $sha1
 567                                 fetch_in_submodule "$sm_path" $depth ||
 568                                 die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'")"
 569                         fi
 570                         remote_name=$(sanitize_submodule_env; cd "$sm_path" && get_default_remote)
 571                         sha1=$(sanitize_submodule_env; cd "$sm_path" &&
 572                                 git rev-parse --verify "${remote_name}/${branch}") ||
 573                         die "$(eval_gettext "Unable to find current \${remote_name}/\${branch} revision in submodule path '\$sm_path'")"
 574                 fi
 575
 576                 if test "$subsha1" != "$sha1" || test -n "$force"
 577                 then
 578                         subforce=$force
 579                         # If we don't already have a -f flag and the submodule has never been checked out
 580                         if test -z "$subsha1" && test -z "$force"
 581                         then
 582                                 subforce="-f"
 583                         fi
 584
 585                         if test -z "$nofetch"
 586                         then
 587                                 # Run fetch only if $sha1 isn't present or it
 588                                 # is not reachable from a ref.
 589                                 is_tip_reachable "$sm_path" "$sha1" ||
 590                                 fetch_in_submodule "$sm_path" $depth ||
 591                                 say "$(eval_gettext "Unable to fetch in submodule path '\$displaypath'")"
 592
 593                                 # Now we tried the usual fetch, but $sha1 may
 594                                 # not be reachable from any of the refs
 595                                 is_tip_reachable "$sm_path" "$sha1" ||
 596                                 fetch_in_submodule "$sm_path" $depth "$sha1" ||
 597                                 die "$(eval_gettext "Fetched in submodule path '\$displaypath', but it did not contain \$sha1. Direct fetching of that commit failed.")"
 598                         fi
 599
 600                         must_die_on_failure=
 601                         case "$update_module" in
 602                         checkout)
 603                                 command="git checkout $subforce -q"
 604                                 die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$displaypath'")"
 605                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': checked out '\$sha1'")"
 606                                 ;;
 607                         rebase)
 608                                 command="git rebase"
 609                                 die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$displaypath'")"
 610                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': rebased into '\$sha1'")"
 611                                 must_die_on_failure=yes
 612                                 ;;
 613                         merge)
 614                                 command="git merge"
 615                                 die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$displaypath'")"
 616                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': merged in '\$sha1'")"
 617                                 must_die_on_failure=yes
 618                                 ;;
 619                         !*)
 620                                 command="${update_module#!}"
 621                                 die_msg="$(eval_gettext "Execution of '\$command \$sha1' failed in submodule path '\$displaypath'")"
 622                                 say_msg="$(eval_gettext "Submodule path '\$displaypath': '\$command \$sha1'")"
 623                                 must_die_on_failure=yes
 624                                 ;;
 625                         *)
 626                                 die "$(eval_gettext "Invalid update mode '$update_module' for submodule path '$path'")"
 627                         esac
 628
 629                         if (sanitize_submodule_env; cd "$sm_path" && $command "$sha1")
 630                         then
 631                                 say "$say_msg"
 632                         elif test -n "$must_die_on_failure"
 633                         then
 634                                 die_with_status 2 "$die_msg"
 635                         else
 636                                 err="${err};$die_msg"
 637                                 continue
 638                         fi
 639                 fi
 640
 641                 if test -n "$recursive"
 642                 then
 643                         (
 644                                 prefix=$(git submodule--helper relative-path "$prefix$sm_path/" "$wt_prefix")
 645                                 wt_prefix=
 646                                 sanitize_submodule_env
 647                                 cd "$sm_path" &&
 648                                 eval cmd_update
 649                         )
 650                         res=$?
 651                         if test $res -gt 0
 652                         then
 653                                 die_msg="$(eval_gettext "Failed to recurse into submodule path '\$displaypath'")"
 654                                 if test $res -ne 2
 655                                 then
 656                                         err="${err};$die_msg"
 657                                         continue
 658                                 else
 659                                         die_with_status $res "$die_msg"
 660                                 fi
 661                         fi
 662                 fi
 663         done
 664
 665         if test -n "$err"
 666         then
 667                 OIFS=$IFS
 668                 IFS=';'
 669                 for e in $err
 670                 do
 671                         if test -n "$e"
 672                         then
 673                                 echo >&2 "$e"
 674                         fi
 675                 done
 676                 IFS=$OIFS
 677                 exit 1
 678         fi
 679         }
 680 }
 681
 682 #
 683 # Show commit summary for submodules in index or working tree
 684 #
 685 # If '--cached' is given, show summary between index and given commit,
 686 # or between working tree and given commit
 687 #
 688 # $@ = [commit (default 'HEAD'),] requested paths (default all)
 689 #
 690 cmd_summary() {
 691         summary_limit=-1
 692         for_status=
 693         diff_cmd=diff-index
 694
 695         # parse $args after "submodule ... summary".
 696         while test $# -ne 0
 697         do
 698                 case "$1" in
 699                 --cached)
 700                         cached="$1"
 701                         ;;
 702                 --files)
 703                         files="$1"
 704                         ;;
 705                 --for-status)
 706                         for_status="$1"
 707                         ;;
 708                 -n|--summary-limit)
 709                         summary_limit="$2"
 710                         isnumber "$summary_limit" || usage
 711                         shift
 712                         ;;
 713                 --summary-limit=*)
 714                         summary_limit="${1#--summary-limit=}"
 715                         isnumber "$summary_limit" || usage
 716                         ;;
 717                 --)
 718                         shift
 719                         break
 720                         ;;
 721                 -*)
 722                         usage
 723                         ;;
 724                 *)
 725                         break
 726                         ;;
 727                 esac
 728                 shift
 729         done
 730
 731         test $summary_limit = 0 && return
 732
 733         if rev=$(git rev-parse -q --verify --default HEAD ${1+"$1"})
 734         then
 735                 head=$rev
 736                 test $# = 0 || shift
 737         elif test -z "$1" || test "$1" = "HEAD"
 738         then
 739                 # before the first commit: compare with an empty tree
 740                 head=$(git hash-object -w -t tree --stdin </dev/null)
 741                 test -z "$1" || shift
 742         else
 743                 head="HEAD"
 744         fi
 745
 746         if [ -n "$files" ]
 747         then
 748                 test -n "$cached" &&
 749                 die "$(gettext "The --cached option cannot be used with the --files option")"
 750                 diff_cmd=diff-files
 751                 head=
 752         fi
 753
 754         cd_to_toplevel
 755         eval "set $(git rev-parse --sq --prefix "$wt_prefix" -- "$@")"
 756         # Get modified modules cared by user
 757         modules=$(git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- "$@" |
 758                 sane_egrep '^:([0-7]* )?160000' |
 759                 while read -r mod_src mod_dst sha1_src sha1_dst status sm_path
 760                 do
 761                         # Always show modules deleted or type-changed (blob<->module)
 762                         if test "$status" = D || test "$status" = T
 763                         then
 764                                 printf '%s\n' "$sm_path"
 765                                 continue
 766                         fi
 767                         # Respect the ignore setting for --for-status.
 768                         if test -n "$for_status"
 769                         then
 770                                 name=$(git submodule--helper name "$sm_path")
 771                                 ignore_config=$(get_submodule_config "$name" ignore none)
 772                                 test $status != A && test $ignore_config = all && continue
 773                         fi
 774                         # Also show added or modified modules which are checked out
 775                         GIT_DIR="$sm_path/.git" git rev-parse --git-dir >/dev/null 2>&1 &&
 776                         printf '%s\n' "$sm_path"
 777                 done
 778         )
 779
 780         test -z "$modules" && return
 781
 782         git $diff_cmd $cached --ignore-submodules=dirty --raw $head -- $modules |
 783         sane_egrep '^:([0-7]* )?160000' |
 784         cut -c2- |
 785         while read -r mod_src mod_dst sha1_src sha1_dst status name
 786         do
 787                 if test -z "$cached" &&
 788                         is_zero_oid $sha1_dst
 789                 then
 790                         case "$mod_dst" in
 791                         160000)
 792                                 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
 793                                 ;;
 794                         100644 | 100755 | 120000)
 795                                 sha1_dst=$(git hash-object $name)
 796                                 ;;
 797                         000000)
 798                                 ;; # removed
 799                         *)
 800                                 # unexpected type
 801                                 eval_gettextln "unexpected mode \$mod_dst" >&2
 802                                 continue ;;
 803                         esac
 804                 fi
 805                 missing_src=
 806                 missing_dst=
 807
 808                 test $mod_src = 160000 &&
 809                 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null &&
 810                 missing_src=t
 811
 812                 test $mod_dst = 160000 &&
 813                 ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null &&
 814                 missing_dst=t
 815
 816                 display_name=$(git submodule--helper relative-path "$name" "$wt_prefix")
 817
 818                 total_commits=
 819                 case "$missing_src,$missing_dst" in
 820                 t,)
 821                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_src")"
 822                         ;;
 823                 ,t)
 824                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commit \$sha1_dst")"
 825                         ;;
 826                 t,t)
 827                         errmsg="$(eval_gettext "  Warn: \$display_name doesn't contain commits \$sha1_src and \$sha1_dst")"
 828                         ;;
 829                 *)
 830                         errmsg=
 831                         total_commits=$(
 832                         if test $mod_src = 160000 && test $mod_dst = 160000
 833                         then
 834                                 range="$sha1_src...$sha1_dst"
 835                         elif test $mod_src = 160000
 836                         then
 837                                 range=$sha1_src
 838                         else
 839                                 range=$sha1_dst
 840                         fi
 841                         GIT_DIR="$name/.git" \
 842                         git rev-list --first-parent $range -- | wc -l
 843                         )
 844                         total_commits=" ($(($total_commits + 0)))"
 845                         ;;
 846                 esac
 847
 848                 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
 849                 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
 850                 if test $status = T
 851                 then
 852                         blob="$(gettext "blob")"
 853                         submodule="$(gettext "submodule")"
 854                         if test $mod_dst = 160000
 855                         then
 856                                 echo "* $display_name $sha1_abbr_src($blob)->$sha1_abbr_dst($submodule)$total_commits:"
 857                         else
 858                                 echo "* $display_name $sha1_abbr_src($submodule)->$sha1_abbr_dst($blob)$total_commits:"
 859                         fi
 860                 else
 861                         echo "* $display_name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
 862                 fi
 863                 if test -n "$errmsg"
 864                 then
 865                         # Don't give error msg for modification whose dst is not submodule
 866                         # i.e. deleted or changed to blob
 867                         test $mod_dst = 160000 && echo "$errmsg"
 868                 else
 869                         if test $mod_src = 160000 && test $mod_dst = 160000
 870                         then
 871                                 limit=
 872                                 test $summary_limit -gt 0 && limit="-$summary_limit"
 873                                 GIT_DIR="$name/.git" \
 874                                 git log $limit --pretty='format:  %m %s' \
 875                                 --first-parent $sha1_src...$sha1_dst
 876                         elif test $mod_dst = 160000
 877                         then
 878                                 GIT_DIR="$name/.git" \
 879                                 git log --pretty='format:  > %s' -1 $sha1_dst
 880                         else
 881                                 GIT_DIR="$name/.git" \
 882                                 git log --pretty='format:  < %s' -1 $sha1_src
 883                         fi
 884                         echo
 885                 fi
 886                 echo
 887         done
 888 }
 889 #
 890 # List all submodules, prefixed with:
 891 #  - submodule not initialized
 892 #  + different revision checked out
 893 #
 894 # If --cached was specified the revision in the index will be printed
 895 # instead of the currently checked out revision.
 896 #
 897 # $@ = requested paths (default to all)
 898 #
 899 cmd_status()
 900 {
 901         # parse $args after "submodule ... status".
 902         while test $# -ne 0
 903         do
 904                 case "$1" in
 905                 -q|--quiet)
 906                         GIT_QUIET=1
 907                         ;;
 908                 --cached)
 909                         cached=1
 910                         ;;
 911                 --recursive)
 912                         recursive=1
 913                         ;;
 914                 --)
 915                         shift
 916                         break
 917                         ;;
 918                 -*)
 919                         usage
 920                         ;;
 921                 *)
 922                         break
 923                         ;;
 924                 esac
 925                 shift
 926         done
 927
 928         git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper status ${GIT_QUIET:+--quiet} ${cached:+--cached} ${recursive:+--recursive} "$@"
 929 }
 930 #
 931 # Sync remote urls for submodules
 932 # This makes the value for remote.$remote.url match the value
 933 # specified in .gitmodules.
 934 #
 935 cmd_sync()
 936 {
 937         while test $# -ne 0
 938         do
 939                 case "$1" in
 940                 -q|--quiet)
 941                         GIT_QUIET=1
 942                         shift
 943                         ;;
 944                 --recursive)
 945                         recursive=1
 946                         shift
 947                         ;;
 948                 --)
 949                         shift
 950                         break
 951                         ;;
 952                 -*)
 953                         usage
 954                         ;;
 955                 *)
 956                         break
 957                         ;;
 958                 esac
 959         done
 960
 961         git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper sync ${GIT_QUIET:+--quiet} ${recursive:+--recursive} "$@"
 962 }
 963
 964 cmd_absorbgitdirs()
 965 {
 966         git submodule--helper absorb-git-dirs --prefix "$wt_prefix" "$@"
 967 }
 968
 969 # This loop parses the command line arguments to find the
 970 # subcommand name to dispatch.  Parsing of the subcommand specific
 971 # options are primarily done by the subcommand implementations.
 972 # Subcommand specific options such as --branch and --cached are
 973 # parsed here as well, for backward compatibility.
 974
 975 while test $# != 0 && test -z "$command"
 976 do
 977         case "$1" in
 978         add | foreach | init | deinit | update | status | summary | sync | absorbgitdirs)
 979                 command=$1
 980                 ;;
 981         -q|--quiet)
 982                 GIT_QUIET=1
 983                 ;;
 984         -b|--branch)
 985                 case "$2" in
 986                 '')
 987                         usage
 988                         ;;
 989                 esac
 990                 branch="$2"; shift
 991                 ;;
 992         --cached)
 993                 cached="$1"
 994                 ;;
 995         --)
 996                 break
 997                 ;;
 998         -*)
 999                 usage
1000                 ;;
1001         *)
1002                 break
1003                 ;;
1004         esac
1005         shift
1006 done
1007
1008 # No command word defaults to "status"
1009 if test -z "$command"
1010 then
1011     if test $# = 0
1012     then
1013         command=status
1014     else
1015         usage
1016     fi
1017 fi
1018
1019 # "-b branch" is accepted only by "add"
1020 if test -n "$branch" && test "$command" != add
1021 then
1022         usage
1023 fi
1024
1025 # "--cached" is accepted only by "status" and "summary"
1026 if test -n "$cached" && test "$command" != status && test "$command" != summary
1027 then
1028         usage
1029 fi
1030
1031 "cmd_$command" "$@"