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