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 [--filter=<filter-spec>]] [--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 require_work_tree
  24 wt_prefix=$(git rev-parse --show-prefix)
  25 cd_to_toplevel
  26
  27 # Tell the rest of git that any URLs we get don't come
  28 # directly from the user, so it can apply policy as appropriate.
  29 GIT_PROTOCOL_FROM_USER=0
  30 export GIT_PROTOCOL_FROM_USER
  31
  32 command=
  33 quiet=
  34 branch=
  35 force=
  36 reference=
  37 cached=
  38 recursive=
  39 init=
  40 require_init=
  41 files=
  42 remote=
  43 nofetch=
  44 rebase=
  45 merge=
  46 checkout=
  47 custom_name=
  48 depth=
  49 progress=
  50 dissociate=
  51 single_branch=
  52 jobs=
  53 recommend_shallow=
  54 filter=
  55
  56 isnumber()
  57 {
  58         n=$(($1 + 0)) 2>/dev/null && test "$n" = "$1"
  59 }
  60
  61 #
  62 # Add a new submodule to the working tree, .gitmodules and the index
  63 #
  64 # $@ = repo path
  65 #
  66 # optional branch is stored in global branch variable
  67 #
  68 cmd_add()
  69 {
  70         # parse $args after "submodule ... add".
  71         reference_path=
  72         while test $# -ne 0
  73         do
  74                 case "$1" in
  75                 -b | --branch)
  76                         case "$2" in '') usage ;; esac
  77                         branch=$2
  78                         shift
  79                         ;;
  80                 -f | --force)
  81                         force=$1
  82                         ;;
  83                 -q|--quiet)
  84                         quiet=1
  85                         ;;
  86                 --progress)
  87                         progress=1
  88                         ;;
  89                 --reference)
  90                         case "$2" in '') usage ;; esac
  91                         reference_path=$2
  92                         shift
  93                         ;;
  94                 --reference=*)
  95                         reference_path="${1#--reference=}"
  96                         ;;
  97                 --dissociate)
  98                         dissociate=1
  99                         ;;
 100                 --name)
 101                         case "$2" in '') usage ;; esac
 102                         custom_name=$2
 103                         shift
 104                         ;;
 105                 --depth)
 106                         case "$2" in '') usage ;; esac
 107                         depth="--depth=$2"
 108                         shift
 109                         ;;
 110                 --depth=*)
 111                         depth=$1
 112                         ;;
 113                 --)
 114                         shift
 115                         break
 116                         ;;
 117                 -*)
 118                         usage
 119                         ;;
 120                 *)
 121                         break
 122                         ;;
 123                 esac
 124                 shift
 125         done
 126
 127         if test -z "$1"
 128         then
 129                 usage
 130         fi
 131
 132         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper add ${quiet:+--quiet} ${force:+--force} ${progress:+"--progress"} ${branch:+--branch "$branch"} ${reference_path:+--reference "$reference_path"} ${dissociate:+--dissociate} ${custom_name:+--name "$custom_name"} ${depth:+"$depth"} -- "$@"
 133 }
 134
 135 #
 136 # Execute an arbitrary command sequence in each checked out
 137 # submodule
 138 #
 139 # $@ = command to execute
 140 #
 141 cmd_foreach()
 142 {
 143         # parse $args after "submodule ... foreach".
 144         while test $# -ne 0
 145         do
 146                 case "$1" in
 147                 -q|--quiet)
 148                         quiet=1
 149                         ;;
 150                 --recursive)
 151                         recursive=1
 152                         ;;
 153                 -*)
 154                         usage
 155                         ;;
 156                 *)
 157                         break
 158                         ;;
 159                 esac
 160                 shift
 161         done
 162
 163         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper foreach ${quiet:+--quiet} ${recursive:+--recursive} -- "$@"
 164 }
 165
 166 #
 167 # Register submodules in .git/config
 168 #
 169 # $@ = requested paths (default to all)
 170 #
 171 cmd_init()
 172 {
 173         # parse $args after "submodule ... init".
 174         while test $# -ne 0
 175         do
 176                 case "$1" in
 177                 -q|--quiet)
 178                         quiet=1
 179                         ;;
 180                 --)
 181                         shift
 182                         break
 183                         ;;
 184                 -*)
 185                         usage
 186                         ;;
 187                 *)
 188                         break
 189                         ;;
 190                 esac
 191                 shift
 192         done
 193
 194         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper init ${quiet:+--quiet} -- "$@"
 195 }
 196
 197 #
 198 # Unregister submodules from .git/config and remove their work tree
 199 #
 200 cmd_deinit()
 201 {
 202         # parse $args after "submodule ... deinit".
 203         deinit_all=
 204         while test $# -ne 0
 205         do
 206                 case "$1" in
 207                 -f|--force)
 208                         force=$1
 209                         ;;
 210                 -q|--quiet)
 211                         quiet=1
 212                         ;;
 213                 --all)
 214                         deinit_all=t
 215                         ;;
 216                 --)
 217                         shift
 218                         break
 219                         ;;
 220                 -*)
 221                         usage
 222                         ;;
 223                 *)
 224                         break
 225                         ;;
 226                 esac
 227                 shift
 228         done
 229
 230         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper deinit ${quiet:+--quiet} ${force:+--force} ${deinit_all:+--all} -- "$@"
 231 }
 232
 233 #
 234 # Update each submodule path to correct revision, using clone and checkout as needed
 235 #
 236 # $@ = requested paths (default to all)
 237 #
 238 cmd_update()
 239 {
 240         # parse $args after "submodule ... update".
 241         while test $# -ne 0
 242         do
 243                 case "$1" in
 244                 -q|--quiet)
 245                         quiet=1
 246                         ;;
 247                 -v|--verbose)
 248                         quiet=0
 249                         ;;
 250                 --progress)
 251                         progress=1
 252                         ;;
 253                 -i|--init)
 254                         init=1
 255                         ;;
 256                 --require-init)
 257                         require_init=1
 258                         ;;
 259                 --remote)
 260                         remote=1
 261                         ;;
 262                 -N|--no-fetch)
 263                         nofetch=1
 264                         ;;
 265                 -f|--force)
 266                         force=$1
 267                         ;;
 268                 -r|--rebase)
 269                         rebase=1
 270                         ;;
 271                 --reference)
 272                         case "$2" in '') usage ;; esac
 273                         reference="--reference=$2"
 274                         shift
 275                         ;;
 276                 --reference=*)
 277                         reference="$1"
 278                         ;;
 279                 --dissociate)
 280                         dissociate=1
 281                         ;;
 282                 -m|--merge)
 283                         merge=1
 284                         ;;
 285                 --recursive)
 286                         recursive=1
 287                         ;;
 288                 --checkout)
 289                         checkout=1
 290                         ;;
 291                 --recommend-shallow)
 292                         recommend_shallow="--recommend-shallow"
 293                         ;;
 294                 --no-recommend-shallow)
 295                         recommend_shallow="--no-recommend-shallow"
 296                         ;;
 297                 --depth)
 298                         case "$2" in '') usage ;; esac
 299                         depth="--depth=$2"
 300                         shift
 301                         ;;
 302                 --depth=*)
 303                         depth=$1
 304                         ;;
 305                 -j|--jobs)
 306                         case "$2" in '') usage ;; esac
 307                         jobs="--jobs=$2"
 308                         shift
 309                         ;;
 310                 --jobs=*)
 311                         jobs=$1
 312                         ;;
 313                 --single-branch)
 314                         single_branch="--single-branch"
 315                         ;;
 316                 --no-single-branch)
 317                         single_branch="--no-single-branch"
 318                         ;;
 319                 --filter)
 320                         case "$2" in '') usage ;; esac
 321                         filter="--filter=$2"
 322                         shift
 323                         ;;
 324                 --filter=*)
 325                         filter="$1"
 326                         ;;
 327                 --)
 328                         shift
 329                         break
 330                         ;;
 331                 -*)
 332                         usage
 333                         ;;
 334                 *)
 335                         break
 336                         ;;
 337                 esac
 338                 shift
 339         done
 340
 341         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper update \
 342                 ${quiet:+--quiet} \
 343                 ${force:+--force} \
 344                 ${progress:+"--progress"} \
 345                 ${remote:+--remote} \
 346                 ${recursive:+--recursive} \
 347                 ${init:+--init} \
 348                 ${nofetch:+--no-fetch} \
 349                 ${rebase:+--rebase} \
 350                 ${merge:+--merge} \
 351                 ${checkout:+--checkout} \
 352                 ${reference:+"$reference"} \
 353                 ${dissociate:+"--dissociate"} \
 354                 ${depth:+"$depth"} \
 355                 ${require_init:+--require-init} \
 356                 ${dissociate:+"--dissociate"} \
 357                 $single_branch \
 358                 $recommend_shallow \
 359                 $jobs \
 360                 $filter \
 361                 -- \
 362                 "$@"
 363 }
 364
 365 #
 366 # Configures a submodule's default branch
 367 #
 368 # $@ = requested path
 369 #
 370 cmd_set_branch() {
 371         default=
 372         branch=
 373
 374         while test $# -ne 0
 375         do
 376                 case "$1" in
 377                 -q|--quiet)
 378                         # we don't do anything with this but we need to accept it
 379                         ;;
 380                 -d|--default)
 381                         default=1
 382                         ;;
 383                 -b|--branch)
 384                         case "$2" in '') usage ;; esac
 385                         branch=$2
 386                         shift
 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"} submodule--helper set-branch ${quiet:+--quiet} ${branch:+--branch "$branch"} ${default:+--default} -- "$@"
 403 }
 404
 405 #
 406 # Configures a submodule's remote url
 407 #
 408 # $@ = requested path, requested url
 409 #
 410 cmd_set_url() {
 411         while test $# -ne 0
 412         do
 413                 case "$1" in
 414                 -q|--quiet)
 415                         quiet=1
 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 set-url ${quiet:+--quiet} -- "$@"
 432 }
 433
 434 #
 435 # Show commit summary for submodules in index or working tree
 436 #
 437 # If '--cached' is given, show summary between index and given commit,
 438 # or between working tree and given commit
 439 #
 440 # $@ = [commit (default 'HEAD'),] requested paths (default all)
 441 #
 442 cmd_summary() {
 443         summary_limit=-1
 444         for_status=
 445         diff_cmd=diff-index
 446
 447         # parse $args after "submodule ... summary".
 448         while test $# -ne 0
 449         do
 450                 case "$1" in
 451                 --cached)
 452                         cached=1
 453                         ;;
 454                 --files)
 455                         files="$1"
 456                         ;;
 457                 --for-status)
 458                         for_status="$1"
 459                         ;;
 460                 -n|--summary-limit)
 461                         summary_limit="$2"
 462                         isnumber "$summary_limit" || usage
 463                         shift
 464                         ;;
 465                 --summary-limit=*)
 466                         summary_limit="${1#--summary-limit=}"
 467                         isnumber "$summary_limit" || usage
 468                         ;;
 469                 --)
 470                         shift
 471                         break
 472                         ;;
 473                 -*)
 474                         usage
 475                         ;;
 476                 *)
 477                         break
 478                         ;;
 479                 esac
 480                 shift
 481         done
 482
 483         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper summary ${files:+--files} ${cached:+--cached} ${for_status:+--for-status} ${summary_limit:+-n $summary_limit} -- "$@"
 484 }
 485 #
 486 # List all submodules, prefixed with:
 487 #  - submodule not initialized
 488 #  + different revision checked out
 489 #
 490 # If --cached was specified the revision in the index will be printed
 491 # instead of the currently checked out revision.
 492 #
 493 # $@ = requested paths (default to all)
 494 #
 495 cmd_status()
 496 {
 497         # parse $args after "submodule ... status".
 498         while test $# -ne 0
 499         do
 500                 case "$1" in
 501                 -q|--quiet)
 502                         quiet=1
 503                         ;;
 504                 --cached)
 505                         cached=1
 506                         ;;
 507                 --recursive)
 508                         recursive=1
 509                         ;;
 510                 --)
 511                         shift
 512                         break
 513                         ;;
 514                 -*)
 515                         usage
 516                         ;;
 517                 *)
 518                         break
 519                         ;;
 520                 esac
 521                 shift
 522         done
 523
 524         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper status ${quiet:+--quiet} ${cached:+--cached} ${recursive:+--recursive} -- "$@"
 525 }
 526 #
 527 # Sync remote urls for submodules
 528 # This makes the value for remote.$remote.url match the value
 529 # specified in .gitmodules.
 530 #
 531 cmd_sync()
 532 {
 533         while test $# -ne 0
 534         do
 535                 case "$1" in
 536                 -q|--quiet)
 537                         quiet=1
 538                         shift
 539                         ;;
 540                 --recursive)
 541                         recursive=1
 542                         shift
 543                         ;;
 544                 --)
 545                         shift
 546                         break
 547                         ;;
 548                 -*)
 549                         usage
 550                         ;;
 551                 *)
 552                         break
 553                         ;;
 554                 esac
 555         done
 556
 557         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper sync ${quiet:+--quiet} ${recursive:+--recursive} -- "$@"
 558 }
 559
 560 cmd_absorbgitdirs()
 561 {
 562         git ${wt_prefix:+-C "$wt_prefix"} submodule--helper absorbgitdirs "$@"
 563 }
 564
 565 # This loop parses the command line arguments to find the
 566 # subcommand name to dispatch.  Parsing of the subcommand specific
 567 # options are primarily done by the subcommand implementations.
 568 # Subcommand specific options such as --branch and --cached are
 569 # parsed here as well, for backward compatibility.
 570
 571 while test $# != 0 && test -z "$command"
 572 do
 573         case "$1" in
 574         add | foreach | init | deinit | update | set-branch | set-url | status | summary | sync | absorbgitdirs)
 575                 command=$1
 576                 ;;
 577         -q|--quiet)
 578                 quiet=1
 579                 ;;
 580         --cached)
 581                 cached=1
 582                 ;;
 583         --)
 584                 break
 585                 ;;
 586         -*)
 587                 usage
 588                 ;;
 589         *)
 590                 break
 591                 ;;
 592         esac
 593         shift
 594 done
 595
 596 # No command word defaults to "status"
 597 if test -z "$command"
 598 then
 599     if test $# = 0
 600     then
 601         command=status
 602     else
 603         usage
 604     fi
 605 fi
 606
 607 # "--cached" is accepted only by "status" and "summary"
 608 if test -n "$cached" && test "$command" != status && test "$command" != summary
 609 then
 610         usage
 611 fi
 612
 613 "cmd_$(echo $command | sed -e s/-/_/g)" "$@"