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