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