tg.sh

   1 #!/bin/sh
   2 # TopGit - A different patch queue manager
   3 # Copyright (C) 2008 Petr Baudis <pasky@suse.cz>
   4 # Copyright (C) 2014-2018 Kyle J. McKay <mackyle@gmail.com>
   5 # All rights reserved.
   6 # GPLv2
   7
   8 TG_VERSION="0.19.10-PRE"
   9
  10 # Update in Makefile if you add any code that requires a newer version of git
  11 GIT_MINIMUM_VERSION="@mingitver@"
  12
  13 ## SHA-1 pattern
  14
  15 octet='[0-9a-f][0-9a-f]'
  16 octet4="$octet$octet$octet$octet"
  17 octet19="$octet4$octet4$octet4$octet4$octet$octet$octet"
  18 octet20="$octet4$octet4$octet4$octet4$octet4"
  19 nullsha="0000000000000000000000000000000000000000" # :|git mktree|tr 0-9a-f 0
  20 mtblob="e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" # :|git hash-object --stdin -w
  21 tab='   '
  22 lf='
  23 '
  24
  25 ## Auxiliary functions
  26
  27 # some ridiculous sh implementations require 'trap ... EXIT' to be executed
  28 # OUTSIDE ALL FUNCTIONS to work in a sane fashion.  Always trap it and eval
  29 # "${TRAPEXIT_:-exit}" as a substitute.
  30 trapexit_()
  31 {
  32         EXITCODE_=${1:-$?}
  33         trap - EXIT
  34         eval "${TRAPEXIT_:-exit $EXITCODE_}"
  35         exit $EXITCODE_
  36 }
  37 trap 'trapexit_ $?' EXIT
  38
  39 # unset that ignores error code that shouldn't be produced according to POSIX
  40 unset_()
  41 {
  42         { unset "$@"; } >/dev/null 2>&1 || :
  43 }
  44
  45 # Preserves current $? value while triggering a non-zero set -e exit if active
  46 # This works even for shells that sometimes fail to correctly trigger a -e exit
  47 check_exit_code()
  48 {
  49         return $?
  50 }
  51
  52 # This is the POSIX equivalent of which
  53 cmd_path()
  54 (
  55         { "unset" -f command unset unalias "$1"; } >/dev/null 2>&1 || :
  56         { "unalias" -a || unalias -m "*"; } >/dev/null 2>&1 || :
  57         command -v "$1"
  58 )
  59
  60 # helper for wrappers
  61 # note deliberate use of '(' ... ')' rather than '{' ... '}'
  62 exec_lc_all_c()
  63 (
  64         { "unset" -f "$1" || :; } >/dev/null 2>&1 &&
  65         shift &&
  66         LC_ALL="C" &&
  67         export LC_ALL &&
  68         exec "$@"
  69 )
  70
  71 # These tools work better for us with LC_ALL=C and by using these little
  72 # convenience functions LC_ALL=C does not have to appear in the code but
  73 # any Git translations will still appear for Git commands
  74 awk()   { exec_lc_all_c awk @AWK_PATH@  "$@"; }
  75 cat()   { exec_lc_all_c cat cat         "$@"; }
  76 cmp()   { exec_lc_all_c cmp cmp         "$@"; }
  77 cut()   { exec_lc_all_c cut cut         "$@"; }
  78 find()  { exec_lc_all_c find find       "$@"; }
  79 grep()  { exec_lc_all_c grep grep       "$@"; }
  80 join()  { exec_lc_all_c join join       "$@"; }
  81 paste() { exec_lc_all_c paste paste     "$@"; }
  82 sed()   { exec_lc_all_c sed sed         "$@"; }
  83 sort()  { exec_lc_all_c sort sort       "$@"; }
  84 tr()    { exec_lc_all_c tr tr           "$@"; }
  85 wc()    { exec_lc_all_c wc wc           "$@"; }
  86 xargs() { exec_lc_all_c xargs xargs     "$@"; }
  87
  88 # Output arguments without any possible interpretation
  89 # (Avoid misinterpretation of '\' characters or leading "-n", "-E" or "-e")
  90 echol()
  91 {
  92         printf '%s\n' "$*"
  93 }
  94
  95 info()
  96 {
  97         echol "${TG_RECURSIVE}${tgname:-tg}: $*"
  98 }
  99
 100 warn()
 101 {
 102         info "warning: $*" >&2
 103 }
 104
 105 err()
 106 {
 107         info "error: $*" >&2
 108 }
 109
 110 fatal()
 111 {
 112         info "fatal: $*" >&2
 113 }
 114
 115 die()
 116 {
 117         fatal "$@"
 118         exit 1
 119 }
 120
 121 # shift off first arg then return "$*" properly quoted in single-quotes
 122 # if $1 was '' output goes to stdout otherwise it's assigned to $1
 123 # the final \n, if any, is omitted from the result but any others are included
 124 v_quotearg()
 125 {
 126         _quotearg_v="$1"
 127         shift
 128         set -- "$_quotearg_v" \
 129         "sed \"s/'/'\\\\\\''/g;1s/^/'/;\\\$s/\\\$/'/;s/'''/'/g;1s/^''\\(.\\)/\\1/\"" "$*"
 130         unset_ _quotearg_v
 131         if [ -z "$3" ]; then
 132                 if [ -z "$1" ]; then
 133                         echo "''"
 134                 else
 135                         eval "$1=\"''\""
 136                 fi
 137         else
 138                 if [ -z "$1" ]; then
 139                         printf "%s$4" "$3" | eval "$2"
 140                 else
 141                         eval "$1="'"$(printf "%s$4" "$3" | eval "$2")"'
 142                 fi
 143         fi
 144 }
 145
 146 # same as v_quotearg except there's no extra $1 so output always goes to stdout
 147 quotearg()
 148 {
 149         v_quotearg '' "$@"
 150 }
 151
 152 vcmp()
 153 {
 154         # Compare $1 to $3 each of which must match ^[^0-9]*\d*(\.\d*)*.*$
 155         # where only the "\d*" parts in the regex participate in the comparison
 156         # Since EVERY string matches that regex this function is easy to use
 157         # An empty string ('') for $1 or $3 or any "\d*" part is treated as 0
 158         # $2 is a compare op '<', '<=', '=', '==', '!=', '>=', '>'
 159         # Return code is 0 for true, 1 for false (or unknown compare op)
 160         # There is NO difference in behavior between '=' and '=='
 161         # Note that "vcmp 1.8 == 1.8.0.0.0.0" correctly returns 0
 162         set -- "$1" "$2" "$3" "${1%%[0-9]*}" "${3%%[0-9]*}"
 163         set -- "${1#"$4"}" "$2" "${3#"$5"}"
 164         set -- "${1%%[!0-9.]*}" "$2" "${3%%[!0-9.]*}"
 165         while
 166                 vcmp_a_="${1%%.*}"
 167                 vcmp_b_="${3%%.*}"
 168                 [ "z$vcmp_a_" != "z" ] || [ "z$vcmp_b_" != "z" ]
 169         do
 170                 if [ "${vcmp_a_:-0}" -lt "${vcmp_b_:-0}" ]; then
 171                         unset_ vcmp_a_ vcmp_b_
 172                         case "$2" in "<"|"<="|"!=") return 0; esac
 173                         return 1
 174                 elif [ "${vcmp_a_:-0}" -gt "${vcmp_b_:-0}" ]; then
 175                         unset_ vcmp_a_ vcmp_b_
 176                         case "$2" in ">"|">="|"!=") return 0; esac
 177                         return 1;
 178                 fi
 179                 vcmp_a_="${1#$vcmp_a_}"
 180                 vcmp_b_="${3#$vcmp_b_}"
 181                 set -- "${vcmp_a_#.}" "$2" "${vcmp_b_#.}"
 182         done
 183         unset_ vcmp_a_ vcmp_b_
 184         case "$2" in "="|"=="|"<="|">=") return 0; esac
 185         return 1
 186 }
 187
 188 # true if "$1" is an existing dir and is empty except for
 189 # any additional files given as extra arguments.  If "$2"
 190 # is the single character "." then all ".*" files will be
 191 # ignored for the test (plus any further args, if any)
 192 is_empty_dir() {
 193         test -n "$1" && test -d "$1" || return 1
 194         iedd_="$1"
 195         shift
 196         ieddnok_='\.?$'
 197         if [ z"$1" = z"." ]; then
 198                 ieddnok_=
 199                 shift
 200                 while ! case "$1" in "."*) ! :; esac; do shift; done
 201         fi
 202         if [ $# -eq 0 ]; then
 203                 ! \ls -a1 "$iedd_" | grep -q -E -v '^\.'"$ieddnok_"
 204         else
 205                 # we only handle ".git" right now for efficiency
 206                 [ z"$*" = z".git" ] || {
 207                         fatal "[BUG] is_empty_dir not implemented for arguments: $*"
 208                         exit 70
 209                 }
 210                 ! \ls -a1 "$iedd_" | grep -q -E -v -i -e '^\.\.?$' -e '^\.git$'
 211         fi
 212 }
 213
 214 precheck() {
 215         if ! git_version="$(git version)"; then
 216                 die "'git version' failed"
 217         fi
 218         case "$git_version" in [Gg]"it version "*);;*)
 219                 die "'git version' output does not start with 'git version '"
 220         esac
 221
 222         vcmp "$git_version" '>=' "$GIT_MINIMUM_VERSION" ||
 223                 die "git version >= $GIT_MINIMUM_VERSION required but found $git_version instead"
 224 }
 225
 226 case "$1" in version|--version|-V)
 227         echo "TopGit version $TG_VERSION"
 228         exit 0
 229 esac
 230
 231 [ $# -eq 1 ] && [ "$1" = "--make-empty-blob" ] || precheck
 232 [ $# -ne 1 ] || [ "$1" != "precheck" ] || exit 0
 233
 234 cat_depsmsg_internal()
 235 {
 236         _rev="$(ref_exists_rev "refs/heads/$1")" || return 0
 237         if [ -s "$tg_cache_dir/refs/heads/$1/.$2" ]; then
 238                 if read _rev_match && [ "$_rev" = "$_rev_match" ]; then
 239                         _line=
 240                         while IFS= read -r _line || [ -n "$_line" ]; do
 241                                 printf '%s\n' "$_line"
 242                         done
 243                         return 0
 244                 fi <"$tg_cache_dir/refs/heads/$1/.$2"
 245         fi
 246         [ -d "$tg_cache_dir/refs/heads/$1" ] || mkdir -p "$tg_cache_dir/refs/heads/$1" 2>/dev/null || :
 247         if [ -d "$tg_cache_dir/refs/heads/$1" ]; then
 248                 printf '%s\n' "$_rev" >"$tg_cache_dir/refs/heads/$1/.$2"
 249                 _line=
 250                 git cat-file blob "$_rev:.$2" 2>/dev/null |
 251                 while IFS= read -r _line || [ -n "$_line" ]; do
 252                         printf '%s\n' "$_line" >&3
 253                         printf '%s\n' "$_line"
 254                 done 3>>"$tg_cache_dir/refs/heads/$1/.$2"
 255         else
 256                 git cat-file blob "$_rev:.$2" 2>/dev/null
 257         fi
 258 }
 259
 260 # cat_deps BRANCHNAME
 261 # Caches result
 262 cat_deps()
 263 {
 264         cat_depsmsg_internal "$1" topdeps
 265 }
 266
 267 # cat_msg BRANCHNAME
 268 # Caches result
 269 cat_msg()
 270 {
 271         cat_depsmsg_internal "$1" topmsg
 272 }
 273
 274 # cat_file TOPIC:PATH [FROM]
 275 # cat the file PATH from branch TOPIC when FROM is empty.
 276 # FROM can be -i or -w, than the file will be from the index or worktree,
 277 # respectively. The caller should than ensure that HEAD is TOPIC, to make sense.
 278 cat_file()
 279 {
 280         path="$1"
 281         case "$2" in
 282         -w)
 283                 cat "$root_dir/${path#*:}"
 284                 ;;
 285         -i)
 286                 # ':file' means cat from index
 287                 git cat-file blob ":${path#*:}" 2>/dev/null
 288                 ;;
 289         '')
 290                 case "$path" in
 291                 refs/heads/*:.topdeps)
 292                         _temp="${path%:.topdeps}"
 293                         cat_deps "${_temp#refs/heads/}"
 294                         ;;
 295                 refs/heads/*:.topmsg)
 296                         _temp="${path%:.topmsg}"
 297                         cat_msg "${_temp#refs/heads/}"
 298                         ;;
 299                 *)
 300                         git cat-file blob "$path" 2>/dev/null
 301                         ;;
 302                 esac
 303                 ;;
 304         *)
 305                 die "Wrong argument to cat_file: '$2'"
 306                 ;;
 307         esac
 308 }
 309
 310 # if use_alt_temp_odb and tg_use_alt_odb are true try to write the object(s)
 311 # into the temporary alt odb area instead of the usual location
 312 git_temp_alt_odb_cmd()
 313 {
 314         if [ -n "$use_alt_temp_odb" ] && [ -n "$tg_use_alt_odb" ] &&
 315            [ -n "$TG_OBJECT_DIRECTORY" ] &&
 316            [ -f "$TG_OBJECT_DIRECTORY/info/alternates" ]; then
 317                 (
 318                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$TG_PRESERVED_ALTERNATES"
 319                         GIT_OBJECT_DIRECTORY="$TG_OBJECT_DIRECTORY"
 320                         unset_ TG_OBJECT_DIRECTORY TG_PRESERVED_ALTERNATES
 321                         export GIT_ALTERNATE_OBJECT_DIRECTORIES GIT_OBJECT_DIRECTORY
 322                         git "$@"
 323                 )
 324         else
 325                 git "$@"
 326         fi
 327 }
 328
 329 git_write_tree() { git_temp_alt_odb_cmd write-tree "$@"; }
 330 git_mktree() { git_temp_alt_odb_cmd mktree "$@"; }
 331
 332 make_mtblob() {
 333         use_alt_temp_odb=1
 334         tg_use_alt_odb=1
 335         git_temp_alt_odb_cmd hash-object -t blob -w --stdin </dev/null >/dev/null 2>&1
 336 }
 337 # short-circuit this for speed
 338 [ $# -eq 1 ] && [ "$1" = "--make-empty-blob" ] && { make_mtblob || :; exit 0; }
 339
 340 # get tree for the committed topic
 341 get_tree_()
 342 {
 343         echo "refs/heads/$1"
 344 }
 345
 346 # get tree for the base
 347 get_tree_b()
 348 {
 349         echo "refs/$topbases/$1"
 350 }
 351
 352 # get tree for the index
 353 get_tree_i()
 354 {
 355         git_write_tree
 356 }
 357
 358 # get tree for the worktree
 359 get_tree_w()
 360 {
 361         i_tree=$(git_write_tree)
 362         (
 363                 # the file for --index-output needs to sit next to the
 364                 # current index file
 365                 cd "$root_dir"
 366                 : ${GIT_INDEX_FILE:="$git_dir/index"}
 367                 TMP_INDEX="$(mktemp "${GIT_INDEX_FILE}-tg.XXXXXX")"
 368                 git read-tree -m $i_tree --index-output="$TMP_INDEX" &&
 369                 GIT_INDEX_FILE="$TMP_INDEX" &&
 370                 export GIT_INDEX_FILE &&
 371                 git diff --name-only -z HEAD |
 372                         git update-index -z --add --remove --stdin &&
 373                 git_write_tree &&
 374                 rm -f "$TMP_INDEX"
 375         )
 376 }
 377
 378 # get tree for arbitrary ref
 379 get_tree_r()
 380 {
 381         echo "$1"
 382 }
 383
 384 # strip_ref "$(git symbolic-ref HEAD)"
 385 # Output will have a leading refs/heads/ or refs/$topbases/ stripped if present
 386 strip_ref()
 387 {
 388         case "$1" in
 389                 refs/"$topbases"/*)
 390                         echol "${1#refs/$topbases/}"
 391                         ;;
 392                 refs/heads/*)
 393                         echol "${1#refs/heads/}"
 394                         ;;
 395                 *)
 396                         echol "$1"
 397         esac
 398 }
 399
 400 # pretty_tree [-t] NAME [-b | -i | -w | -r]
 401 # Output tree ID of a cleaned-up tree without tg's artifacts.
 402 # NAME will be ignored for -i and -w, but needs to be present
 403 # With -r NAME must be a full ref name to a treeish (it's used as-is)
 404 # If -t is used the tree is written into the alternate temporary objects area
 405 pretty_tree()
 406 {
 407         use_alt_temp_odb=
 408         [ "$1" != "-t" ] || { shift; use_alt_temp_odb=1; }
 409         name="$1"
 410         source="${2#?}"
 411         git ls-tree --full-tree "$(get_tree_$source "$name")" |
 412                 sed -ne '/      \.top.*$/!p' |
 413                 git_mktree
 414 }
 415
 416 # return an empty-tree root commit -- date is either passed in or current
 417 # If passed in "$*" must be epochsecs followed by optional hhmm offset (+0000 default)
 418 # An invalid secs causes the current date to be used, an invalid zone offset
 419 # causes +0000 to be used
 420 make_empty_commit()
 421 (
 422         # the empty tree is guaranteed to always be there even in a repo with
 423         # zero objects, but for completeness we force it to exist as a real object
 424         SECS=
 425         read -r SECS ZONE JUNK <<-EOT || :
 426                 $*
 427                 EOT
 428         case "$SECS" in *[!0-9]*) SECS=; esac
 429         if [ -z "$SECS" ]; then
 430                 MTDATE="$(date '+%s %z')"
 431         else
 432                 case "$ZONE" in
 433                         -[01][0-9][0-5][0-9]|+[01][0-9][0-5][0-9])
 434                                 ;;
 435                         [01][0-9][0-5][0-9])
 436                                 ZONE="+$ZONE"
 437                                 ;;
 438                         *)
 439                                 ZONE="+0000"
 440                 esac
 441                 MTDATE="$SECS $ZONE"
 442         fi
 443         EMPTYID="- <-> $MTDATE"
 444         EMPTYTREE="$(git hash-object -t tree -w --stdin < /dev/null)"
 445         printf '%s\n' "tree $EMPTYTREE" "author $EMPTYID" "committer $EMPTYID" '' |
 446         git hash-object -t commit -w --stdin
 447 )
 448
 449 # standard input is a diff
 450 # standard output is the "+" lines with leading "+ " removed
 451 # beware that old lines followed by the dreaded '\ No newline at end of file'
 452 # will appear to be new lines if lines are added after them
 453 # the git diff --ignore-space-at-eol option can be used to prevent this
 454 diff_added_lines()
 455 {
 456         awk '
 457 BEGIN      { in_hunk = 0; }
 458 /^@@ /     { in_hunk = 1; }
 459 /^\+/      { if (in_hunk == 1) printf("%s\n", substr($0, 2)); }
 460 !/^\\ No newline at end of file/ &&
 461 /^[^@ +-]/ { in_hunk = 0; }
 462 '
 463 }
 464
 465 # $1 is name of new branch to create locally if all of these are true:
 466 #   a) exists as a remote TopGit branch for "$base_remote"
 467 #   b) the branch "name" does not have any invalid characters in it
 468 #   c) neither of the two branch refs (branch or base) exist locally
 469 # returns success only if a new local branch was created (and dumps message)
 470 auto_create_local_remote()
 471 {
 472         case "$1" in ""|*[" $tab$lf~^:\\*?["]*|.*|*/.*|*.|*./|/*|*/|*//*) return 1; esac
 473         [ -n "$base_remote" ] &&
 474         git update-ref --stdin <<-EOT >/dev/null 2>&1 &&
 475                 verify refs/remotes/$base_remote/${topbases#heads/}/$1 refs/remotes/$base_remote/${topbases#heads/}/$1
 476                 verify refs/remotes/$base_remote/$1 refs/remotes/$base_remote/$1
 477                 create refs/$topbases/$1 refs/remotes/$base_remote/${topbases#heads/}/$1^0
 478                 create refs/heads/$1 refs/remotes/$base_remote/$1^0
 479         EOT
 480         { init_reflog "refs/$topbases/$1" || :; } &&
 481         info "topic branch '$1' automatically set up from remote '$base_remote'"
 482 }
 483
 484 # setup_hook NAME
 485 setup_hook()
 486 {
 487         setup_git_dir_is_bare
 488         [ -z "$git_dir_is_bare" ] || return 0
 489         setup_git_hooks_dir
 490         tgname="${0##*/}"
 491         hook_call="\"\$(\"$tgname\" --hooks-path)\"/$1 \"\$@\""
 492         if [ -f "$git_hooks_dir/$1" ] && grep -Fq "$hook_call" "$git_hooks_dir/$1"; then
 493                 # Another job well done!
 494                 return
 495         fi
 496         # Prepare incantation
 497         hook_chain=
 498         if [ -s "$git_hooks_dir/$1" ] && [ -x "$git_hooks_dir/$1" ]; then
 499                 hook_call="$hook_call"' || exit $?'
 500                 if [ -L "$git_hooks_dir/$1" ] || ! sed -n 1p <"$git_hooks_dir/$1" | grep -Fqx "#!@SHELL_PATH@"; then
 501                         chain_num=
 502                         while [ -e "$git_hooks_dir/$1-chain$chain_num" ]; do
 503                                 chain_num=$(( $chain_num + 1 ))
 504                         done
 505                         mv -f "$git_hooks_dir/$1" "$git_hooks_dir/$1-chain$chain_num"
 506                         hook_chain=1
 507                 fi
 508         else
 509                 hook_call="exec $hook_call"
 510                 [ -d "$git_hooks_dir" ] || mkdir -p "$git_hooks_dir" || :
 511         fi
 512         # Don't call hook if tg is not installed
 513         hook_call="if command -v \"$tgname\" >/dev/null 2>&1; then $hook_call; fi"
 514         # Insert call into the hook
 515         {
 516                 echol "#!@SHELL_PATH@"
 517                 echol "$hook_call"
 518                 if [ -n "$hook_chain" ]; then
 519                         echol "exec \"\$0-chain$chain_num\" \"\$@\""
 520                 else
 521                         [ ! -s "$git_hooks_dir/$1" ] || cat "$git_hooks_dir/$1"
 522                 fi
 523         } >"$git_hooks_dir/$1+"
 524         chmod a+x "$git_hooks_dir/$1+"
 525         mv "$git_hooks_dir/$1+" "$git_hooks_dir/$1"
 526 }
 527
 528 # setup_ours (no arguments)
 529 setup_ours()
 530 {
 531         setup_git_dir_is_bare
 532         [ -z "$git_dir_is_bare" ] || return 0
 533         if [ ! -s "$git_common_dir/info/attributes" ] || ! grep -q topmsg "$git_common_dir/info/attributes"; then
 534                 [ -d "$git_common_dir/info" ] || mkdir "$git_common_dir/info"
 535                 {
 536                         echo ".topmsg   merge=ours"
 537                         echo ".topdeps  merge=ours"
 538                 } >>"$git_common_dir/info/attributes"
 539         fi
 540         if ! git config merge.ours.driver >/dev/null; then
 541                 git config merge.ours.name '"always keep ours" merge driver'
 542                 git config merge.ours.driver 'touch %A'
 543         fi
 544 }
 545
 546 # measure_branch NAME [BASE] [EXTRAHEAD...]
 547 measure_branch()
 548 {
 549         _bname="$1"; _base="$2"
 550         shift; shift
 551         [ -n "$_base" ] || _base="refs/$topbases/$(strip_ref "$_bname")"
 552         # The caller should've verified $name is valid
 553         _commits="$(git rev-list --count "$_bname" "$@" ^"$_base" --)"
 554         _nmcommits="$(git rev-list --count --no-merges "$_bname" "$@" ^"$_base" --)"
 555         if [ $_commits -ne 1 ]; then
 556                 _suffix="commits"
 557         else
 558                 _suffix="commit"
 559         fi
 560         echo "$_commits/$_nmcommits $_suffix"
 561 }
 562
 563 # true if $1 is contained by (or the same as) $2
 564 # this is never slower than merge-base --is-ancestor and is often slightly faster
 565 contained_by()
 566 {
 567         [ "$(git rev-list --count --max-count=1 "$1" --not "$2" --)" = "0" ]
 568 }
 569
 570 # branch_contains B1 B2
 571 # Whether B1 is a superset of B2.
 572 branch_contains()
 573 {
 574         _revb1="$(ref_exists_rev "$1")" || return 0
 575         _revb2="$(ref_exists_rev "$2")" || return 0
 576         if [ -s "$tg_cache_dir/$1/.bc/$2/.d" ]; then
 577                 if read _result _rev_matchb1 _rev_matchb2 &&
 578                         [ "$_revb1" = "$_rev_matchb1" ] && [ "$_revb2" = "$_rev_matchb2" ]; then
 579                         return $_result
 580                 fi <"$tg_cache_dir/$1/.bc/$2/.d"
 581         fi
 582         [ -d "$tg_cache_dir/$1/.bc/$2" ] || mkdir -p "$tg_cache_dir/$1/.bc/$2" 2>/dev/null || :
 583         _result=0
 584         contained_by "$_revb2" "$_revb1" || _result=1
 585         if [ -d "$tg_cache_dir/$1/.bc/$2" ]; then
 586                 echo "$_result" "$_revb1" "$_revb2" >"$tg_cache_dir/$1/.bc/$2/.d"
 587         fi
 588         return $_result
 589 }
 590
 591 create_ref_dirs()
 592 {
 593         [ ! -s "$tg_tmp_dir/tg~ref-dirs-created" ] && [ -s "$tg_ref_cache" ] || return 0
 594         mkdir -p "$tg_tmp_dir/cached/refs"
 595         awk '{x=$1; sub(/^refs\//,"",x); if (x != "") {gsub(/[^A-Za-z0-9\/_.+-]/,"\\\\&",x); print x;}}' <"$tg_ref_cache" |
 596         {
 597                 cd "$tg_tmp_dir/cached/refs" &&
 598                 xargs mkdir -p
 599         }
 600         awk -v p="$tg_tmp_dir/cached/" '
 601                 NF == 2 &&
 602                 $1 ~ /^refs\/./ &&
 603                 $2 ~ /^[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]+$/ {
 604                         fn = p $1 "/.ref"
 605                         print "0 " $2 >fn
 606                         close(fn)
 607                 }
 608         ' <"$tg_ref_cache"
 609         echo 1 >"$tg_tmp_dir/tg~ref-dirs-created"
 610 }
 611
 612 # If the first argument is non-empty, stores "1" there if this call created the cache
 613 v_create_ref_cache()
 614 {
 615         [ -n "$tg_ref_cache" ] && ! [ -s "$tg_ref_cache" ] || return 0
 616         _remotespec=
 617         [ -z "$base_remote" ] || _remotespec="refs/remotes/$base_remote"
 618         [ -z "$1" ] || eval "$1=1"
 619         git for-each-ref --format='%(refname) %(objectname)' \
 620                 refs/heads "refs/$topbases" $_remotespec >"$tg_ref_cache"
 621         create_ref_dirs
 622 }
 623
 624 remove_ref_cache()
 625 {
 626         [ -n "$tg_ref_cache" ] && [ -s "$tg_ref_cache" ] || return 0
 627         >"$tg_ref_cache"
 628         >"$tg_ref_cache_br"
 629         >"$tg_ref_cache_rbr"
 630         >"$tg_ref_cache_ann"
 631         >"$tg_ref_cache_dep"
 632 }
 633
 634 # setting tg_ref_cache_only to non-empty will force non-$tg_ref_cache lookups to fail
 635 rev_parse()
 636 {
 637         rev_parse_code_=1
 638         if [ -n "$tg_ref_cache" ] && [ -s "$tg_ref_cache" ]; then
 639                 rev_parse_code_=0
 640                 awk -v r="$1" 'BEGIN {e=1}; $1 == r {print $2; e=0; exit}; END {exit e}' <"$tg_ref_cache" ||
 641                 rev_parse_code_=$?
 642         fi
 643         [ $rev_parse_code_ -ne 0 ] && [ -z "$tg_ref_cache_only" ] || return $rev_parse_code_
 644         git rev-parse --quiet --verify "$1^0" -- 2>/dev/null
 645 }
 646
 647 # ref_exists_rev REF
 648 # Whether REF is a valid ref name
 649 # REF must be fully qualified and start with refs/heads/, refs/$topbases/
 650 # or, if $base_remote is set, refs/remotes/$base_remote/
 651 # Caches result if $tg_read_only and outputs HASH on success
 652 ref_exists_rev()
 653 {
 654         case "$1" in
 655                 refs/*)
 656                         ;;
 657                 $octet20)
 658                         printf '%s' "$1"
 659                         return;;
 660                 *)
 661                         die "ref_exists_rev requires fully-qualified ref name (given: $1)"
 662         esac
 663         [ -n "$tg_read_only" ] || { git rev-parse --quiet --verify "$1^0" -- 2>/dev/null; return; }
 664         _result=
 665         _result_rev=
 666         { read -r _result _result_rev <"$tg_tmp_dir/cached/$1/.ref"; } 2>/dev/null || :
 667         [ -z "$_result" ] || { printf '%s' "$_result_rev"; return $_result; }
 668         _result=0
 669         _result_rev="$(rev_parse "$1")" || _result=$?
 670         [ -d "$tg_tmp_dir/cached/$1" ] || mkdir -p "$tg_tmp_dir/cached/$1" 2>/dev/null
 671         [ ! -d "$tg_tmp_dir/cached/$1" ] ||
 672         echo $_result $_result_rev >"$tg_tmp_dir/cached/$1/.ref" 2>/dev/null || :
 673         printf '%s' "$_result_rev"
 674         return $_result
 675 }
 676
 677 # Same as ref_exists_rev but output is abbreviated hash
 678 # Optional second argument defaults to --short but may be any --short=.../--no-short option
 679 ref_exists_rev_short()
 680 {
 681         case "$1" in
 682                 refs/*)
 683                         ;;
 684                 $octet20)
 685                         ;;
 686                 *)
 687                         die "ref_exists_rev_short requires fully-qualified ref name"
 688         esac
 689         [ -n "$tg_read_only" ] || { git rev-parse --quiet --verify ${2:---short} "$1^0" -- 2>/dev/null; return; }
 690         _result=
 691         _result_rev=
 692         { read -r _result _result_rev <"$tg_tmp_dir/cached/$1/.rfs"; } 2>/dev/null || :
 693         [ -z "$_result" ] || { printf '%s' "$_result_rev"; return $_result; }
 694         _result=0
 695         _result_rev="$(rev_parse "$1")" || _result=$?
 696         if [ $_result -eq 0 ]; then
 697                 _result_rev="$(git rev-parse --verify ${2:---short} --quiet "$_result_rev^0" --)"
 698                 _result=$?
 699         fi
 700         [ -d "$tg_tmp_dir/cached/$1" ] || mkdir -p "$tg_tmp_dir/cached/$1" 2>/dev/null
 701         [ ! -d "$tg_tmp_dir/cached/$1" ] ||
 702         echo $_result $_result_rev >"$tg_tmp_dir/cached/$1/.rfs" 2>/dev/null || :
 703         printf '%s' "$_result_rev"
 704         return $_result
 705 }
 706
 707 # ref_exists REF
 708 # Whether REF is a valid ref name
 709 # REF must be fully qualified and start with refs/heads/, refs/$topbases/
 710 # or, if $base_remote is set, refs/remotes/$base_remote/
 711 # Caches result
 712 ref_exists()
 713 {
 714         ref_exists_rev "$1" >/dev/null
 715 }
 716
 717 # rev_parse_tree REF
 718 # Runs git rev-parse REF^{tree}
 719 # Caches result if $tg_read_only
 720 rev_parse_tree()
 721 {
 722         [ -n "$tg_read_only" ] || { git rev-parse --verify "$1^{tree}" -- 2>/dev/null; return; }
 723         if [ -f "$tg_tmp_dir/cached/$1/.rpt" ]; then
 724                 if IFS= read -r _result <"$tg_tmp_dir/cached/$1/.rpt"; then
 725                         printf '%s\n' "$_result"
 726                         return 0
 727                 fi
 728                 return 1
 729         fi
 730         [ -d "$tg_tmp_dir/cached/$1" ] || mkdir -p "$tg_tmp_dir/cached/$1" 2>/dev/null || :
 731         if [ -d "$tg_tmp_dir/cached/$1" ]; then
 732                 git rev-parse --verify "$1^{tree}" -- >"$tg_tmp_dir/cached/$1/.rpt" 2>/dev/null || :
 733                 if IFS= read -r _result <"$tg_tmp_dir/cached/$1/.rpt"; then
 734                         printf '%s\n' "$_result"
 735                         return 0
 736                 fi
 737                 return 1
 738         fi
 739         git rev-parse --verify "$1^{tree}" -- 2>/dev/null
 740 }
 741
 742 # has_remote BRANCH
 743 # Whether BRANCH has a remote equivalent (accepts ${topbases#heads/}/ too)
 744 has_remote()
 745 {
 746         [ -n "$base_remote" ] && ref_exists "refs/remotes/$base_remote/$1"
 747 }
 748
 749 # Return the verified TopGit branch name for "$2" in "$1" or die with an error.
 750 # If -z "$1" still set return code but do not return result
 751 # As a convenience, if HEAD or @ is given and HEAD is a symbolic ref to
 752 # refs/heads/... then ... will be verified instead.
 753 # if "$3" = "-f" (for fail) then return an error rather than dying.
 754 v_verify_topgit_branch()
 755 {
 756         if [ "$2" = "HEAD" ] || [ "$2" = "@" ]; then
 757                 _verifyname="$(git symbolic-ref HEAD 2>/dev/null)" || :
 758                 [ -n "$_verifyname" ] || [ "$3" = "-f" ] || die "HEAD is not a symbolic ref"
 759                 case "$_verifyname" in refs/"$topbases"/*|refs/heads/*);;*)
 760                         [ "$3" != "-f" ] || return 1
 761                         die "HEAD is not a symbolic ref to the refs/heads namespace"
 762                 esac
 763                 set -- "$1" "$_verifyname" "$3"
 764         fi
 765         case "$2" in
 766                 refs/"$topbases"/*)
 767                         _verifyname="${2#refs/$topbases/}"
 768                         ;;
 769                 refs/heads/*)
 770                         _verifyname="${2#refs/heads/}"
 771                         ;;
 772                 *)
 773                         _verifyname="$2"
 774                         ;;
 775         esac
 776         if ! ref_exists "refs/heads/$_verifyname"; then
 777                 [ "$3" != "-f" ] || return 1
 778                 die "no such branch: $_verifyname"
 779         fi
 780         if ! ref_exists "refs/$topbases/$_verifyname"; then
 781                 [ "$3" != "-f" ] || return 1
 782                 die "not a TopGit-controlled branch: $_verifyname"
 783         fi
 784         [ -z "$1" ] || eval "$1="'"$_verifyname"'
 785 }
 786
 787 # Return the verified TopGit branch name or die with an error.
 788 # As a convenience, if HEAD or @ is given and HEAD is a symbolic ref to
 789 # refs/heads/... then ... will be verified instead.
 790 # if "$2" = "-f" (for fail) then return an error rather than dying.
 791 verify_topgit_branch()
 792 {
 793         v_verify_topgit_branch _verifyname "$@" || return
 794         printf '%s' "$_verifyname"
 795 }
 796
 797 # Caches result
 798 # $1 = branch name (i.e. "t/foo/bar")
 799 # $2 = optional result of rev-parse "refs/heads/$1"
 800 # $3 = optional result of rev-parse "refs/$topbases/$1"
 801 branch_annihilated()
 802 {
 803         _branch_name="$1"
 804         _rev="${2:-$(ref_exists_rev "refs/heads/$_branch_name")}"
 805         _rev_base="${3:-$(ref_exists_rev "refs/$topbases/$_branch_name")}"
 806
 807         _result=
 808         _result_rev=
 809         _result_rev_base=
 810         { read -r _result _result_rev _result_rev_base <"$tg_cache_dir/refs/heads/$_branch_name/.ann"; } 2>/dev/null || :
 811         [ -z "$_result" ] || [ "$_result_rev" != "$_rev" ] || [ "$_result_rev_base" != "$_rev_base" ] || return $_result
 812
 813         # use the merge base in case the base is ahead.
 814         mb="$(git merge-base "$_rev_base" "$_rev" 2>/dev/null)"
 815
 816         test -z "$mb" || test "$(rev_parse_tree "$mb")" = "$(rev_parse_tree "$_rev")"
 817         _result=$?
 818         [ -d "$tg_cache_dir/refs/heads/$_branch_name" ] || mkdir -p "$tg_cache_dir/refs/heads/$_branch_name" 2>/dev/null
 819         [ ! -d "$tg_cache_dir/refs/heads/$_branch_name" ] ||
 820         echo $_result $_rev $_rev_base >"$tg_cache_dir/refs/heads/$_branch_name/.ann" 2>/dev/null || :
 821         return $_result
 822 }
 823
 824 non_annihilated_branches()
 825 {
 826         refscacheopt="${TG_DEBUG:+-p=\"\$tg_ref_cache.pre\" }"
 827         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ] && [ -s "$tg_ref_cache" ]; then
 828                 refscacheopt="$refscacheopt"'-r="$tg_ref_cache" "refs/$topbases"'
 829         fi
 830         eval run_awk_topgit_branches -n "$refscacheopt" '"refs/$topbases" "$@"'
 831 }
 832
 833 # Make sure our tree is clean
 834 # if optional "$1" given also verify that a checkout to "$1" would succeed
 835 ensure_clean_tree()
 836 {
 837         check_status
 838         [ -z "$tg_state$git_state" ] || { do_status; exit 1; }
 839         git update-index --ignore-submodules --refresh ||
 840                 die "the working directory has uncommitted changes (see above) - first commit or reset them"
 841         [ -z "$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)" ] ||
 842                 die "the index has uncommited changes"
 843         [ -z "$1" ] || git read-tree -n -u -m "$1" ||
 844                 die "git checkout \"$1\" would fail"
 845 }
 846
 847 # Make sure .topdeps and .topmsg are "clean"
 848 # They are considered "clean" if each is identical in worktree, index and HEAD
 849 # With "-u" as the argument skip the HEAD check (-u => unborn)
 850 # untracked .topdeps and/or .topmsg files are always considered "dirty" as well
 851 # with -u them just existing constitutes "dirty"
 852 ensure_clean_topfiles()
 853 {
 854         _dirtw=0
 855         _dirti=0
 856         _dirtu=0
 857         _check="$(git diff-files --ignore-submodules --name-only -- :/.topdeps :/.topmsg)" &&
 858         [ -z "$_check" ] || _dirtw=1
 859         if [ "$1" != "-u" ]; then
 860                 _check="$(git diff-index --cached --ignore-submodules --name-only HEAD -- :/.topdeps :/.topmsg)" &&
 861                 [ -z "$_check" ] || _dirti=1
 862         fi
 863         if [ "$_dirti$_dirtw" = "00" ]; then
 864                 v_get_show_cdup
 865                 if [ -e "${git_cdup_result}.topdeps" ] || [ -e "${git_cdup_result}.topmsg" ]; then
 866                         [ "$1" != "-u" ] &&
 867                         _check="$(git status --porcelain --ignored --untracked-files --ignore-submodules -- :/.topdeps :/.topmsg)" &&
 868                         [ -z "$_check" ] || _dirtu=1
 869                 fi
 870         fi
 871         if [ "$_dirtu$_dirti$_dirtw" != "000" ]; then
 872                 git status --ignored --untracked-files --ignore-submodules -- :/.topdeps :/.topmsg || :
 873                 case "$_dirtu$_dirti$_dirtw" in
 874                 001) die "the working directory has uncommitted changes (see above) - first commit or reset them";;
 875                 010) die "the index has uncommited changes (see above)";;
 876                 011) die "the working directory and index have uncommitted changes (see above) - first commit or reset them";;
 877                 100) die "the working directory has untracked files that would be overwritten (see above)";;
 878                 esac
 879         fi
 880 }
 881
 882 # is_sha1 REF
 883 # Whether REF is a SHA1 (compared to a symbolic name).
 884 is_sha1()
 885 {
 886         case "$1" in $octet20) return 0;; esac
 887         return 1
 888 }
 889
 890 # navigate_deps <run_awk_topgit_navigate options and arguments>
 891 # all options and arguments are passed through to run_awk_topgit_navigate
 892 # except for a leading -td= option, if any, which is picked off for deps
 893 # after arranging to feed it a suitable deps list
 894 navigate_deps()
 895 {
 896         dogfer=
 897         dorad=1
 898         userc=
 899         tmpdep=
 900         ratd_opts="${TG_DEBUG:+-p=\"\$tg_ref_cache.pre\" }"
 901         ratn_opts=
 902         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ]; then
 903                 userc=1
 904                 tmprfs="$tg_ref_cache"
 905                 tmptgbr="$tg_ref_cache_br"
 906                 tmpann="$tg_ref_cache_ann"
 907                 tmpdep="$tg_ref_cache_dep"
 908                 [ -s "$tg_ref_cache" ] || dogfer=1
 909                 [ -n "$dogfer" ] || ! [ -s "$tmptgbr" ] || ! [ -f "$tmpann" ] || ! [ -s "$tmpdep" ] || dorad=
 910         else
 911                 ratd_opts="${ratd_opts}-rmr"
 912                 ratn_opts="-rma -rmb"
 913                 tmprfs="$tg_tmp_dir/refs.$$"
 914                 tmpann="$tg_tmp_dir/ann.$$"
 915                 tmptgbr="$tg_tmp_dir/tgbr.$$"
 916                 dogfer=1
 917         fi
 918         refpats="\"refs/heads\" \"refs/\$topbases\""
 919         [ -z "$base_remote" ] || refpats="$refpats \"refs/remotes/\$base_remote\""
 920         [ -z "$dogfer" ] ||
 921         eval git for-each-ref '--format="%(refname) %(objectname)"' "$refpats" >"$tmprfs"
 922         depscmd="run_awk_topgit_deps $ratd_opts"
 923         case "$1" in -td=*)
 924                 userc=
 925                 depscmd="$depscmd $1"
 926                 shift
 927         esac
 928         depscmd="$depscmd"' -a="$tmpann" -b="$tmptgbr" -r="$tmprfs" -s "refs/$topbases"'
 929         if [ -n "$userc" ]; then
 930                 if [ -n "$dorad" ]; then
 931                         eval "$depscmd" >"$tmpdep"
 932                 fi
 933                 depscmd='<"$tmpdep" '
 934         else
 935                 depscmd="$depscmd |"
 936         fi
 937         eval "$depscmd" run_awk_topgit_navigate '-a="$tmpann" -b="$tmptgbr"' "$ratn_opts" '"$@"'
 938 }
 939
 940 # recurse_deps_internal NAME [BRANCHPATH...]
 941 # get recursive list of dependencies with leading 0 if branch exists 1 if missing
 942 # followed by a 1 if the branch is "tgish" (2 if it also has a remote); 0 if not
 943 # followed by a 0 for a non-leaf, 1 for a leaf or 2 for annihilated tgish
 944 # (but missing and remotes are always "0")
 945 # followed by a 0 for no excess visits or a positive number of excess visits
 946 # then the branch name followed by its depedency chain (which might be empty)
 947 # An output line might look like this:
 948 #   0 1 1 0 t/foo/leaf t/foo/int t/stage
 949 # If no_remotes is non-empty, exclude remotes
 950 # If recurse_preorder is non-empty, do a preorder rather than postorder traversal
 951 # If with_top_level is non-empty, include the top-level that's normally omitted
 952 # any branch names in the space-separated recurse_deps_exclude variable
 953 # are skipped (along with their dependencies)
 954 recurse_deps_internal()
 955 {
 956         case " $recurse_deps_exclude " in *" $1 "*) return 0; esac
 957         ratr_opts="${recurse_preorder:+-f} ${with_top_level:+-s}"
 958         dogfer=
 959         dorad=1
 960         userc=
 961         tmpdep=
 962         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ]; then
 963                 userc=1
 964                 tmprfs="$tg_ref_cache"
 965                 tmptgbr="$tg_ref_cache_br"
 966                 tmpann="$tg_ref_cache_ann"
 967                 tmpdep="$tg_ref_cache_dep"
 968                 [ -s "$tg_ref_cache" ] || dogfer=1
 969                 [ -n "$dogfer" ] || ! [ -s "$tmptgbr" ] || ! [ -f "$tmpann" ] || ! [ -s "$tmpdep" ] || dorad=
 970         else
 971                 ratr_opts="$ratr_opts -rmh -rma -rmb"
 972                 tmprfs="$tg_tmp_dir/refs.$$"
 973                 tmpann="$tg_tmp_dir/ann.$$"
 974                 tmptgbr="$tg_tmp_dir/tgbr.$$"
 975                 dogfer=1
 976         fi
 977         refpats="\"refs/heads\" \"refs/\$topbases\""
 978         [ -z "$base_remote" ] || refpats="$refpats \"refs/remotes/\$base_remote\""
 979         tmptgrmtbr=
 980         dorab=1
 981         if [ -z "$no_remotes" ] && [ -n "$base_remote" ]; then
 982                 if [ -n "$userc" ]; then
 983                         tmptgrmtbr="$tg_ref_cache_rbr"
 984                         [ -n "$dogfer" ] || ! [ -s "$tmptgrmtbr" ] || dorab=
 985                 else
 986                         tmptgrmtbr="$tg_tmp_dir/tgrmtbr.$$"
 987                         ratr_opts="$ratr_opts -rmr"
 988                 fi
 989                 ratr_opts="$ratr_opts -r=\"\$tmptgrmtbr\" -u=\":refs/remotes/\$base_remote/\${topbases#heads/}\""
 990         fi
 991         [ -z "$dogfer" ] ||
 992         eval git for-each-ref '--format="%(refname) %(objectname)"' "$refpats" >"$tmprfs"
 993         if [ -n "$tmptgrmtbr" ] && [ -n "$dorab" ]; then
 994                 run_awk_topgit_branches -n -h="refs/remotes/$base_remote" -r="$tmprfs" \
 995                         "refs/remotes/$base_remote/${topbases#heads/}" >"$tmptgrmtbr"
 996         fi
 997         depscmd="run_awk_topgit_deps -s${TG_DEBUG:+ -p=\"\$tg_ref_cache.pre\"}"
 998         depscmd="$depscmd"' -a="$tmpann" -b="$tmptgbr" -r="$tmprfs" "refs/$topbases"'
 999         if [ -n "$userc" ]; then
1000                 if [ -n "$dorad" ]; then
1001                         eval "$depscmd" >"$tmpdep"
1002                 fi
1003                 depscmd='<"$tmpdep" '
1004         else
1005                 depscmd="$depscmd |"
1006         fi
1007         eval "$depscmd" run_awk_topgit_recurse '-a="$tmpann" -b="$tmptgbr"' \
1008                 '-c=1 -h="$tmprfs"' "$ratr_opts" '-x="$recurse_deps_exclude"' '"$@"'
1009 }
1010
1011 # do_eval CMD
1012 # helper for recurse_deps so that a return statement executed inside CMD
1013 # does not return from recurse_deps.  This shouldn't be necessary, but it
1014 # seems that it actually is.
1015 do_eval()
1016 {
1017         eval "$@"
1018 }
1019
1020 # becomes read-only for caching purposes
1021 # assigns new value to tg_read_only
1022 # become_cacheable/undo_become_cacheable calls may be nested
1023 become_cacheable()
1024 {
1025         _old_tg_read_only="$tg_read_only"
1026         if [ -z "$tg_read_only" ]; then
1027                 ! [ -e "$tg_tmp_dir/cached" ] && ! [ -e "$tg_tmp_dir/tg~ref-dirs-created" ] ||
1028                 rm -rf "$tg_tmp_dir/cached" "$tg_tmp_dir/tg~ref-dirs-created"
1029                 tg_read_only=1
1030         fi
1031         _my_ref_cache=
1032         v_create_ref_cache _my_ref_cache
1033         _my_ref_cache="${_my_ref_cache:+1}"
1034         tg_read_only="undo${_my_ref_cache:-0}-$_old_tg_read_only"
1035 }
1036
1037 # restores tg_read_only and ref_cache to state before become_cacheable call
1038 # become_cacheable/undo_bocome_cacheable calls may be nested
1039 undo_become_cacheable()
1040 {
1041         case "$tg_read_only" in
1042                 "undo"[01]"-"*)
1043                         _suffix="${tg_read_only#undo?-}"
1044                         [ "${tg_read_only%$_suffix}" = "undo0-" ] || remove_ref_cache
1045                         tg_read_only="$_suffix"
1046         esac
1047 }
1048
1049 # just call this, no undo, sets tg_read_only= and removes ref cache and cached results
1050 become_non_cacheable()
1051 {
1052         remove_ref_cache
1053         tg_read_only=
1054         ! [ -e "$tg_tmp_dir/cached" ] && ! [ -e "$tg_tmp_dir/tg~ref-dirs-created" ] ||
1055         rm -rf "$tg_tmp_dir/cached" "$tg_tmp_dir/tg~ref-dirs-created"
1056 }
1057
1058 # call this to make sure the current Git repository has an associated work tree
1059 # also make sure we are not in wayback mode
1060 ensure_work_tree()
1061 {
1062         [ -z "$wayback" ] ||
1063         die "the wayback machine cannot be used with the specified options"
1064         setup_git_dir_is_bare
1065         [ -n "$git_dir_is_bare" ] || return 0
1066         die "This operation must be run in a work tree"
1067 }
1068
1069 # call this to make sure Git will not complain about a missing user/email
1070 # result is cached in TG_IDENT_CHECKED and a non-empty value suppresses the check
1071 ensure_ident_available()
1072 {
1073         [ -z "$TG_IDENT_CHECKED" ] || return 0
1074         git var GIT_AUTHOR_IDENT >/dev/null &&
1075         git var GIT_COMMITTER_IDENT >/dev/null || exit
1076         TG_IDENT_CHECKED=1
1077         export TG_IDENT_CHECKED
1078         return 0
1079 }
1080
1081 # recurse_deps [-o=<options string>] CMD NAME [BRANCHPATH...]
1082 # Recursively eval CMD on all dependencies of NAME.
1083 # Dependencies are visited in topological order.
1084 # If <options string> is given, it's eval'd into the recurse_deps_internal
1085 # call just before the "--" that's passed just before NAME
1086 # CMD can refer to the following variables:
1087 #
1088 #   _ret              starts as 0; CMD can change; will be final return result
1089 #   _dep              bare branch name or ":refs/remotes/..." for a remote
1090 #   _name             has $_dep in its .topdeps ("" for top and $with_top_level)
1091 #   _depchain         0+ space-sep branch names (_name first) form a path to top
1092 #   _dep_missing      boolean "1" if no such $_dep ref; "" if ref present
1093 #   _dep_is_leaf      boolean "1" if leaf; "" if not
1094 #   _dep_is_tgish     boolean "1" if tgish; "" if not (which implies no remote)
1095 #   _dep_has_remote   boolean "1" if $_dep has_remote; "" if not
1096 #   _dep_annihilated  boolean "1" if $_dep annihilated; "" if not
1097 #   _dep_xvisits      non-negative integer number of excess visits (often 0)
1098 #
1099 # CMD may use a "return" statement without issue; its return value is ignored,
1100 # but if CMD sets _ret to a negative value, e.g. "-0" or "-1" the enumeration
1101 # will stop immediately and the value with the leading "-" stripped off will
1102 # be the final result code
1103 #
1104 # CMD can refer to $_name for queried branch name,
1105 # $_dep for dependency name,
1106 # $_depchain for space-seperated branch backtrace,
1107 # $_dep_missing boolean to check whether $_dep is present
1108 # and the $_dep_is_tgish and $_dep_annihilated booleans.
1109 # If recurse_preorder is NOT set then the $_dep_is_leaf boolean is also valid.
1110 # It can modify $_ret to affect the return value
1111 # of the whole function.
1112 # If recurse_deps() hits missing dependencies, it will append
1113 # them to space-separated $missing_deps list and skip them
1114 # after calling CMD with _dep_missing set.
1115 # remote dependencies are processed if no_remotes is unset.
1116 # any branch names in the space-separated recurse_deps_exclude variable
1117 # are skipped (along with their dependencies)
1118 #
1119 # If no_remotes is non-empty, exclude remotes
1120 # If recurse_preorder is non-empty, do a preorder rather than postorder traversal
1121 # If with_top_level is non-empty, include the top-level that's normally omitted
1122 # any branch names in the space-separated recurse_deps_exclude variable
1123 # are skipped (along with their dependencies)
1124 recurse_deps()
1125 {
1126         _opts=
1127         case "$1" in -o=*) _opts="${1#-o=}"; shift; esac
1128         _cmd="$1"; shift
1129
1130         _depsfile="$(get_temp tg-depsfile)"
1131         eval recurse_deps_internal "$_opts" -- '"$@"' >"$_depsfile" || :
1132
1133         _ret=0
1134         while read _ismissing _istgish _isleaf _dep_xvisits _dep _name _deppath; do
1135                 _depchain="$_name${_deppath:+ $_deppath}"
1136                 _dep_is_tgish=
1137                 [ "$_istgish" = "0" ] || _dep_is_tgish=1
1138                 _dep_has_remote=
1139                 [ "$_istgish" != "2" ] || _dep_has_remote=1
1140                 _dep_missing=
1141                 if [ "$_ismissing" != "0" ]; then
1142                         _dep_missing=1
1143                         case " $missing_deps " in *" $_dep "*);;*)
1144                                 missing_deps="${missing_deps:+$missing_deps }$_dep"
1145                         esac
1146                 fi
1147                 _dep_annihilated=
1148                 _dep_is_leaf=
1149                 if [ "$_isleaf" = "1" ]; then
1150                         _dep_is_leaf=1
1151                 elif [ "$_isleaf" = "2" ]; then
1152                         _dep_annihilated=1
1153                 fi
1154                 do_eval "$_cmd" || :
1155                 if [ "${_ret#-}" != "$_ret" ]; then
1156                         _ret="${_ret#-}"
1157                         break
1158                 fi
1159         done <"$_depsfile"
1160         rm -f "$_depsfile"
1161         return ${_ret:-0}
1162 }
1163
1164 # find_leaves NAME
1165 # output (one per line) the unique leaves of NAME
1166 # a leaf is either
1167 #   1) a non-tgish dependency
1168 #   2) the base of a tgish dependency with no non-annihilated dependencies
1169 # duplicates are suppressed (by commit rev) and remotes are always ignored
1170 # if a leaf has an exact tag match that will be output
1171 # note that recurse_deps_exclude IS honored for this operation
1172 find_leaves()
1173 {
1174         no_remotes=1
1175         with_top_level=1
1176         recurse_preorder=
1177         seen_leaf_refs=
1178         seen_leaf_revs=
1179         while read _ismissing _istgish _isleaf _dep _name _deppath; do
1180                 [ "$_isleaf" = "1" ] && [ "$_ismissing" = "0" ] || continue
1181                 if [ "$_istgish" != "0" ]; then
1182                         fulldep="refs/$topbases/$_dep"
1183                 else
1184                         fulldep="refs/heads/$_dep"
1185                 fi
1186                 case " $seen_leaf_refs " in *" $fulldep "*);;*)
1187                         seen_leaf_refs="${seen_leaf_refs:+$seen_leaf_refs }$fulldep"
1188                         if fullrev="$(ref_exists_rev "$fulldep")"; then
1189                                 case " $seen_leaf_revs " in *" $fullrev "*);;*)
1190                                         seen_leaf_revs="${seen_leaf_revs:+$seen_leaf_revs }$fullrev"
1191                                         # See if Git knows it by another name
1192                                         if tagname="$(git describe --exact-match "$fullrev" 2>/dev/null)" && [ -n "$tagname" ]; then
1193                                                 echo "refs/tags/$tagname"
1194                                         else
1195                                                 echo "$fulldep"
1196                                         fi
1197                                 esac
1198                         fi
1199                 esac
1200         done <<-EOT
1201         $(recurse_deps_internal -l -o=1 -- "$1")
1202         EOT
1203         with_top_level=
1204 }
1205
1206 # branch_needs_update
1207 # This is a helper function for determining whether given branch
1208 # is up-to-date wrt. its dependencies. It expects input as if it
1209 # is called as a recurse_deps() helper.
1210 # In case the branch does need update, it will echo it together
1211 # with the branch backtrace on the output (see needs_update()
1212 # description for details) and set $_ret to non-zero.
1213 branch_needs_update()
1214 {
1215         if [ -n "$_dep_missing" ]; then
1216                 echo "! $_dep $_depchain"
1217                 return 0
1218         fi
1219
1220         if [ -n "$_dep_is_tgish" ]; then
1221                 [ -z "$_dep_annihilated" ] || return 0
1222
1223                 if [ -n "$_dep_has_remote" ]; then
1224                         branch_contains "refs/heads/$_dep" "refs/remotes/$base_remote/$_dep" || {
1225                                 echo ":refs/remotes/$base_remote/$_dep $_dep $_depchain"
1226                                 _ret=1
1227                         }
1228                 fi
1229                 # We want to sync with our base first and should output this before
1230                 # the remote branch, but the order does not actually matter to tg-update
1231                 # as it just recurses regardless, but it does matter for tg-info (which
1232                 # treats out-of-date bases as though they were already merged in) so
1233                 # we output the remote before the base.
1234                 branch_contains "refs/heads/$_dep" "refs/$topbases/$_dep" || {
1235                         echo ": $_dep $_depchain"
1236                         _ret=1
1237                         return
1238                 }
1239         fi
1240
1241         if [ -n "$_name" ]; then
1242                 case "$_dep" in :*) _fulldep="${_dep#:}";; *) _fulldep="refs/heads/$_dep";; esac
1243                 if ! branch_contains "refs/$topbases/$_name" "$_fulldep"; then
1244                         # Some new commits in _dep
1245                         echo "$_dep $_depchain"
1246                         _ret=1
1247                 fi
1248         fi
1249 }
1250
1251 # needs_update NAME
1252 # This function is recursive; it outputs reverse path from NAME
1253 # to the branch (e.g. B_DIRTY B1 B2 NAME), one path per line,
1254 # inner paths first. Innermost name can be :refs/remotes/<remote>/<name>
1255 # if the head is not in sync with the <remote> branch <name>, ':' if
1256 # the head is not in sync with the base (in this order of priority)
1257 # or '!' if dependency is missing.  Note that the remote branch, base
1258 # order is reversed from the order they will actually be updated in
1259 # order to accomodate tg info which treats out-of-date items that are
1260 # only in the base as already being in the head for status purposes.
1261 # It will also return non-zero status if NAME needs update (seems backwards
1262 # but think of it as non-zero status if any non-missing output lines produced)
1263 # If needs_update() hits missing dependencies, it will append
1264 # them to space-separated $missing_deps list and skip them.
1265 needs_update()
1266 {
1267         recurse_deps branch_needs_update "$1"
1268 }
1269
1270 # append second arg to first arg variable gluing with space if first already set
1271 vplus()
1272 {
1273         eval "$1=\"\${$1:+\$$1 }\$2\""
1274 }
1275
1276 # true if whitespace separated first var name list contains second arg
1277 # use `vcontains 3 "value" "some list"` for a literal list
1278 vcontains()
1279 {
1280         eval case "\" \${$1} \"" in '*" $2 "*) return 0; esac; return 1'
1281 }
1282
1283 # if the $1 var does not already contain $2 it's appended
1284 vsetadd()
1285 {
1286         vcontains "$1" "$2" || vplus "$1" "$2"
1287 }
1288
1289 # reset needs_update_check results to empty
1290 needs_update_check_clear()
1291 {
1292         unset_ needs_update_processed needs_update_behind needs_update_ahead needs_update_partial
1293 }
1294
1295 # needs_update_check NAME...
1296 #
1297 # A faster version of needs_update that always succeeds
1298 # No output and unsuitable for actually performing updates themselves
1299 # If any of NAME... are NOT up-to-date AND they were not already processed
1300 # return status always will be zero however a simple check of
1301 # needs_update_behind after the call will answer the:
1302 #   "are any out of date?": test -n "$needs_update_behind"
1303 #   "is <x> out of date?":  vcontains needs_update_behind "<x>"
1304 #
1305 # Note that results are cumulative and "no_remotes" is honored as well as other
1306 # variables that modify recurse_deps_internal behavior.  See the preceding
1307 # function to reset the results to empty when accumulation should start over.
1308 #
1309 # Unlike needs_update, the branch names are themselves also checked to see if
1310 # they are out-of-date with respect to their bases or remote branches (not just
1311 # their remote bases).  However, this can muddy some status results so this
1312 # can be disabled by setting needs_update_check_no_self to a non-empty value.
1313 #
1314 # Unlike needs_update, here the remote base check is handled together with the
1315 # remote head check so if one is modified the other is too in the same way.
1316 #
1317 # Dependencies are normally considered "behind" if they need an update from
1318 # their base or remote but this can be suppressed by setting the
1319 # needs_update_check_no_same to a non-empty value.  This will NOT prevent
1320 # parents of those dependencies from still being considered behind in such a
1321 # case even though the dependency itself will not be.  Note that setting
1322 # needs_update_check_no_same also implies needs_update_check_no_self.
1323 #
1324 # The following whitespace-separated lists are updated with the results:
1325 #
1326 # The "no_remotes" setting is obeyed but remote names themselves will never
1327 # appear in any of the lists
1328 #
1329 #   needs_update_processed
1330 #       The branch names in here have been processed and will be skipped
1331 #
1332 #   needs_update_behind
1333 #       Any branch named in here needs an update from one or more of its
1334 #       direct or indirect dependencies (i.e. it's "out-of-date")
1335 #
1336 #   needs_update_ahead
1337 #       Any branch named in here is NOT fully contained by at least one of
1338 #       its dependents (i.e. it's a source of "out-of-date (aka dirty)"ness
1339 #
1340 #   needs_update_partial
1341 #       Any branch names in here are either missing themselves or have one
1342 #       or more detected missing dependencies (a completely missing remote
1343 #       branch is never "detected")
1344 needs_update_check()
1345 {
1346         # each head must be processed independently or else there will be
1347         # confusion about who's missing what and which branches actually are
1348         # out of date
1349         tmptgrdi="$tg_tmp_dir/tgrdi.$$"
1350         for nucname in "$@"; do
1351                 ! vcontains needs_update_processed "$nucname" || continue
1352                 # no need to fuss with recurse_deps, just use
1353                 # recurse_deps_internal directly
1354                 recurse_deps_internal -s -o=-1 "$nucname" >"$tmptgrdi"
1355                 while read -r _rdi_m _rdi_t _rdi_l _rdi_v _rdi_node _rdi_parent _rdi_chain; do
1356                         case "$_rdi_node" in ""|:*) continue; esac # empty or checked with remote
1357                         vsetadd needs_update_processed "$_rdi_node"
1358                         if [ "$_rdi_m" != "0" ]; then # missing
1359                                 vsetadd needs_update_partial "$_rdi_node"
1360                                 [ -z "$_rdi_parent" ] || vsetadd needs_update_partial "$_rdi_parent"
1361                                 continue
1362                         fi
1363                         [ "$_rdi_t$_rdi_l" != "12" ] || continue # always skip annihilated
1364                         _rdi_dertee= # :)
1365                         if [ -n "$_rdi_parent" ]; then # not a "self" line
1366                                 ! vcontains needs_update_partial "$_rdi_node" || vsetadd needs_update_partial "$_rdi_parent"
1367                                 ! vcontains needs_update_behind "$_rdi_node" || _rdi_dertee=2
1368                         else
1369                                 [ -z "$needs_update_check_no_self$needs_update_check_no_same" ] || continue # skip self
1370                         fi
1371                         if [ -z "$_rdi_dertee" ]; then
1372                                 if [ "$_rdi_t" != "0" ]; then # tgish
1373                                         if branch_contains "refs/heads/$_rdi_node" "refs/$topbases/$_rdi_node"; then
1374                                                 if [ "$_rdi_t" = "2" ]; then # will never be "2" when no_remotes is set
1375                                                         branch_contains "refs/heads/$_rdi_node" "refs/remotes/$base_remote/$_rdi_node" &&
1376                                                         branch_contains "refs/$topbases/$_rdi_node" "refs/remotes/$base_remote/${topbases#heads/}/$_rdi_node" ||
1377                                                         _rdi_dertee=3
1378                                                 fi
1379                                         else
1380                                                 _rdi_dertee=3
1381                                         fi
1382                                         [ -z "$_rdi_dertee" ] || [ -n "$needs_update_check_no_same" ] || _rdi_dertee=1
1383                                 fi
1384                         fi
1385                         [ z"$_rdi_dertee" != z"1" ] || vsetadd needs_update_behind "$_rdi_node"
1386                         [ -n "$_rdi_parent" ] || continue # self line
1387                         if ! branch_contains "refs/$topbases/$_rdi_parent" "refs/heads/$_rdi_node"; then
1388                                 _rdi_dertee=1
1389                                 vsetadd needs_update_ahead "$_rdi_node"
1390                         fi
1391                         [ -z "$_rdi_dertee" ] || vsetadd needs_update_behind "$_rdi_parent"
1392                 done <"$tmptgrdi"
1393         done
1394 }
1395
1396 # branch_empty NAME [-i | -w]
1397 branch_empty()
1398 {
1399         if [ -z "$2" ]; then
1400                 _rev="$(ref_exists_rev "refs/heads/$1")" || return 0
1401                 _result=
1402                 _result_rev=
1403                 { read -r _result _result_rev <"$tg_cache_dir/refs/heads/$1/.mt"; } 2>/dev/null || :
1404                 [ -z "$_result" ] || [ "$_result_rev" != "$_rev" ] || return $_result
1405                 _result=0
1406                 [ "$(pretty_tree -t "$1" -b)" = "$(pretty_tree -t "$1" $2)" ] || _result=$?
1407                 [ -d "$tg_cache_dir/refs/heads/$1" ] || mkdir -p "$tg_cache_dir/refs/heads/$1" 2>/dev/null
1408                 [ ! -d "$tg_cache_dir/refs/heads/$1" ] || echo $_result $_rev >"$tg_cache_dir/refs/heads/$1/.mt"
1409                 return $_result
1410         else
1411                 [ "$(pretty_tree -t "$1" -b)" = "$(pretty_tree -t "$1" $2)" ]
1412         fi
1413 }
1414
1415 v_get_tdmopt_internal()
1416 {
1417         [ -n "$1" ] && [ -n "$3" ] || return 0
1418         [ "$2" = "-i" ] || [ "$2" = "-w" ] || return 0
1419         ensure_work_tree
1420         _optval=
1421         if v_verify_topgit_branch _tghead "HEAD" -f; then
1422                 if [ "$2" = "-w" ] && [ -f "$root_dir/$3" ] && [ -r "$root_dir/$3" ]; then
1423                         _opthash=
1424                         if _opthash="$(git hash-object -w -t blob --stdin <"$root_dir/$3")" && [ -n "$_opthash" ]; then
1425                                 _optval="$4\"$_tghead:$_opthash\""
1426                         fi
1427                 elif [ "$2" = "-i" ]; then
1428                         if _opthash="$(git rev-parse --quiet --verify ":0:$3" --)" && [ -n "$_opthash" ]; then
1429                                 _optval="$4\"$_tghead:$_opthash\""
1430                         fi
1431                 fi
1432         fi
1433         eval "$1="'"$_optval"'
1434 }
1435
1436 # set var $1 to the correct -td= option for use in an eval for $2 -i or -w mode
1437 v_get_tdopt() { v_get_tdmopt_internal "$1" "$2" ".topdeps" "-td="; }
1438
1439 # set var $1 to the correct -tm= option for use in an eval for $2 -i or -w mode
1440 v_get_tmopt() { v_get_tdmopt_internal "$1" "$2" ".topmsg" "-tm="; }
1441
1442 # checkout_symref_full [-f] FULLREF [SEED]
1443 # Just like git checkout $iowopt -b FULLREF [SEED] except that FULLREF MUST start with
1444 # refs/ and HEAD is ALWAYS set to a symref to it and [SEED] (default is FULLREF)
1445 # MUST be a committish which if present will be used instead of current FULLREF
1446 # (and FULLREF will be updated to it as well in that case)
1447 # Any merge state is always cleared by this function
1448 # With -f it's like git checkout $iowopt -f -b FULLREF (uses read-tree --reset
1449 # instead of -m) but it will clear out any unmerged entries
1450 # As an extension, FULLREF may also be a full hash to create a detached HEAD instead
1451 checkout_symref_full()
1452 {
1453         _mode=-m
1454         _head="HEAD"
1455         if [ "$1" = "-f" ]; then
1456                 _mode="--reset"
1457                 _head=
1458                 shift
1459         fi
1460         _ishash=
1461         case "$1" in
1462                 refs/?*)
1463                         ;;
1464                 $octet20)
1465                         _ishash=1
1466                         [ -z "$2" ] || [ "$1" = "$2" ] ||
1467                                 die "programmer error: invalid checkout_symref_full \"$1\" \"$2\""
1468                         set -- HEAD "$1"
1469                         ;;
1470                 *)
1471                         die "programmer error: invalid checkout_symref_full \"$1\""
1472                         ;;
1473         esac
1474         _seedrev="$(git rev-parse --quiet --verify "${2:-$1}^0" --)" ||
1475                 die "invalid committish: \"${2:-$1}\""
1476         # Clear out any MERGE_HEAD kruft
1477         rm -f "$git_dir/MERGE_HEAD" || :
1478         # We have to do all the hard work ourselves :/
1479         # This is like git checkout -b "$1" "$2"
1480         # (or just git checkout "$1"),
1481         # but never creates a detached HEAD (unless $1 is a hash)
1482         git read-tree -u $_mode $_head "$_seedrev" &&
1483         {
1484                 [ -z "$2" ] && [ "$(git cat-file -t "$1")" = "commit" ] ||
1485                 git update-ref ${_ishash:+--no-deref} "$1" "$_seedrev"
1486         } && {
1487                 [ -n "$_ishash" ] || git symbolic-ref HEAD "$1"
1488         }
1489 }
1490
1491 # switch_to_base NAME [SEED]
1492 switch_to_base()
1493 {
1494         checkout_symref_full "refs/$topbases/$1" "$2"
1495 }
1496
1497 # run editor with arguments
1498 # the editor setting will be cached in $tg_editor (which is eval'd)
1499 # result non-zero if editor fails or GIT_EDITOR cannot be determined
1500 # just in case, noalt_setup will be in effect while the editor is running
1501 run_editor()
1502 {
1503         tg_editor="$GIT_EDITOR"
1504         [ -n "$tg_editor" ] || tg_editor="$(git var GIT_EDITOR)" || return $?
1505         (
1506                 noalt_setup
1507                 eval "$tg_editor" '"$@"'
1508         )
1509 }
1510
1511 # Show the help messages.
1512 do_help()
1513 {
1514         _www=
1515         if [ "$1" = "-w" ]; then
1516                 _www=1
1517                 shift
1518         fi
1519         if [ "$1" = "st" ]; then
1520                 shift
1521                 set -- "status" "$@"
1522         fi
1523         if [ -z "$1" ] ; then
1524                 # This is currently invoked in all kinds of circumstances,
1525                 # including when the user made a usage error. Should we end up
1526                 # providing more than a short help message, then we should
1527                 # differentiate.
1528                 # Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
1529
1530                 ## Build available commands list for help output
1531
1532                 cmds=
1533                 sep=
1534                 for cmd in "$TG_INST_CMDDIR"/tg-[!-]*; do
1535                         ! [ -r "$cmd" ] && continue
1536                         # strip directory part and "tg-" prefix
1537                         cmd="${cmd##*/}"
1538                         cmd="${cmd#tg-}"
1539                         [ "$cmd" != "migrate-bases" ] || continue
1540                         [ "$cmd" != "summary" ] || cmd="st[atus]|$cmd"
1541                         cmds="$cmds$sep$cmd"
1542                         sep="|"
1543                 done
1544
1545                 echo "TopGit version $TG_VERSION - A different patch queue manager"
1546                 echo "Usage: $tgname [-C <dir>] [-r <remote> | -u]" \
1547                         "[-c <name>=<val>] [--[no-]pager|-p] [-w [:]<tgtag>] ($cmds) ..."
1548                 echo "   Or: $tgname help [-w] [<command>]"
1549                 echo "Use \"$tgdisplaydir$tgname help tg\" for overview of TopGit"
1550         elif [ -r "$TG_INST_CMDDIR"/tg-$1 ] || [ -r "$TG_INST_SHAREDIR/tg-$1.txt" ] ; then
1551                 if [ -n "$_www" ]; then
1552                         nohtml=
1553                         if ! [ -r "$TG_INST_SHAREDIR/topgit.html" ]; then
1554                                 echo "${0##*/}: missing html help file:" \
1555                                         "$TG_INST_SHAREDIR/topgit.html" 1>&2
1556                                 nohtml=1
1557                         fi
1558                         if ! [ -r "$TG_INST_SHAREDIR/tg-$1.html" ]; then
1559                                 echo "${0##*/}: missing html help file:" \
1560                                         "$TG_INST_SHAREDIR/tg-$1.html" 1>&2
1561                                 nohtml=1
1562                         fi
1563                         if [ -n "$nohtml" ]; then
1564                                 echo "${0##*/}: use" \
1565                                         "\"${0##*/} help $1\" instead" 1>&2
1566                                 exit 1
1567                         fi
1568                         git web--browse -c help.browser "$TG_INST_SHAREDIR/tg-$1.html"
1569                         exit
1570                 fi
1571                 output()
1572                 {
1573                         if [ -r "$TG_INST_CMDDIR"/tg-$1 ] ; then
1574                                 "$TG_INST_CMDDIR"/tg-$1 -h 2>&1 || :
1575                                 echo
1576                         elif [ "$1" = "help" ]; then
1577                                 echo "Usage: ${tgname:-tg} help [-w] [<command>]"
1578                                 echo
1579                         elif [ "$1" = "status" ] || [ "$1" = "st" ]; then
1580                                 echo "Usage: ${tgname:-tg} @tgsthelpusage@"
1581                                 echo
1582                         fi
1583                         if [ -r "$TG_INST_SHAREDIR/tg-$1.txt" ] ; then
1584                                 cat "$TG_INST_SHAREDIR/tg-$1.txt"
1585                         fi
1586                 }
1587                 page output "$1"
1588         else
1589                 echo "${0##*/}: no help for $1" 1>&2
1590                 do_help
1591                 exit 1
1592         fi
1593 }
1594
1595 check_status()
1596 {
1597         git_state=
1598         git_remove=
1599         tg_state=
1600         tg_remove=
1601         tg_topmerge=
1602         setup_git_dir_is_bare
1603         [ -z "$git_dir_is_bare" ] || return 0
1604
1605         if [ -e "$git_dir/MERGE_HEAD" ]; then
1606                 git_state="merge"
1607         elif [ -e "$git_dir/rebase-apply/applying" ]; then
1608                 git_state="am"
1609                 git_remove="$git_dir/rebase-apply"
1610         elif [ -e "$git_dir/rebase-apply" ]; then
1611                 git_state="rebase"
1612                 git_remove="$git_dir/rebase-apply"
1613         elif [ -e "$git_dir/rebase-merge" ]; then
1614                 git_state="rebase"
1615                 git_remove="$git_dir/rebase-merge"
1616         elif [ -e "$git_dir/CHERRY_PICK_HEAD" ]; then
1617                 git_state="cherry-pick"
1618         elif [ -e "$git_dir/BISECT_LOG" ]; then
1619                 git_state="bisect"
1620         elif [ -e "$git_dir/REVERT_HEAD" ]; then
1621                 git_state="revert"
1622         fi
1623         git_remove="${git_remove#./}"
1624
1625         if [ -e "$git_dir/tg-update" ]; then
1626                 tg_state="update"
1627                 tg_remove="$git_dir/tg-update"
1628                 ! [ -s "$git_dir/tg-update/merging_topfiles" ] || tg_topmerge=1
1629         fi
1630         tg_remove="${tg_remove#./}"
1631 }
1632
1633 # Show status information
1634 do_status()
1635 {
1636         do_status_result=0
1637         do_status_verbose=
1638         do_status_help=
1639         abbrev=refs
1640         pfx=
1641         while [ $# -gt 0 ] && case "$1" in
1642                 --help|-h)
1643                         do_status_help=1
1644                         break;;
1645                 -vv)
1646                         # kludge in this common bundling option
1647                         abbrev=
1648                         do_status_verbose=1
1649                         pfx="## "
1650                         ;;
1651                 --verbose|-v)
1652                         [ -z "$do_status_verbose" ] || abbrev=
1653                         do_status_verbose=1
1654                         pfx="## "
1655                         ;;
1656                 --exit-code)
1657                         do_status_result=2
1658                         ;;
1659                 *)
1660                         die "unknown status argument: $1"
1661                         ;;
1662         esac; do shift; done
1663         if [ -n "$do_status_help" ]; then
1664                 echo "Usage: ${tgname:-tg} @tgsthelpusage@"
1665                 return
1666         fi
1667         check_status
1668         symref="$(git symbolic-ref --quiet HEAD)" || :
1669         headrv="$(git rev-parse --quiet --verify ${abbrev:+--short} HEAD --)" || :
1670         if [ -n "$symref" ]; then
1671                 uprefpart=
1672                 if [ -n "$headrv" ]; then
1673                         upref="$(git rev-parse --symbolic-full-name @{upstream} 2>/dev/null)" || :
1674                         if [ -n "$upref" ]; then
1675                                 uprefpart=" ... ${upref#$abbrev/remotes/}"
1676                                 mbase="$(git merge-base HEAD "$upref")" || :
1677                                 ahead="$(git rev-list --count HEAD ${mbase:+--not} $mbase)" || ahead=0
1678                                 behind="$(git rev-list --count "$upref" ${mbase:+--not} $mbase)" || behind=0
1679                                 [ "$ahead$behind" = "00" ] || uprefpart="$uprefpart ["
1680                                 [ "$ahead" = "0" ] || uprefpart="${uprefpart}ahead $ahead"
1681                                 [ "$ahead" = "0" ] || [ "$behind" = "0" ] || uprefpart="$uprefpart, "
1682                                 [ "$behind" = "0" ] || uprefpart="${uprefpart}behind $behind"
1683                                 [ "$ahead$behind" = "00" ] || uprefpart="$uprefpart]"
1684                         fi
1685                 fi
1686                 echol "${pfx}HEAD -> ${symref#$abbrev/heads/} [${headrv:-unborn}]$uprefpart"
1687         else
1688                 echol "${pfx}HEAD -> ${headrv:-?}"
1689         fi
1690         if [ -n "$tg_state" ]; then
1691                 extra=
1692                 if [ "$tg_state" = "update" ]; then
1693                         IFS= read -r uname <"$git_dir/tg-update/name" || :
1694                         [ -z "$uname" ] ||
1695                         extra="; currently updating branch '$uname'"
1696                 fi
1697                 echol "${pfx}tg $tg_state in progress$extra"
1698                 if [ -s "$git_dir/tg-update/fullcmd" ] && [ -s "$git_dir/tg-update/names" ]; then
1699                         printf "${pfx}You are currently updating as a result of:\n${pfx}  "
1700                         cat "$git_dir/tg-update/fullcmd"
1701                         bcnt="$(( $(wc -w < "$git_dir/tg-update/names") ))"
1702                         if [ $bcnt -gt 1 ]; then
1703                                 pcnt=0
1704                                 ! [ -s "$git_dir/tg-update/processed" ] ||
1705                                 pcnt="$(( $(wc -w < "$git_dir/tg-update/processed") ))"
1706                                 echo "${pfx}$pcnt of $bcnt branches updated so far"
1707                         fi
1708                 fi
1709                 if [ "$tg_state" = "update" ]; then
1710                         echol "${pfx}  (use \"$tgdisplayac update --continue\" to continue)"
1711                         echol "${pfx}  (use \"$tgdisplayac update --skip\" to skip this branch and continue)"
1712                         echol "${pfx}  (use \"$tgdisplayac update --stop\" to stop and retain changes so far)"
1713                         echol "${pfx}  (use \"$tgdisplayac update --abort\" to restore pre-update state)"
1714                 fi
1715         fi
1716         [ -z "$git_state" ] || echo "${pfx}git $git_state in progress"
1717         if [ "$git_state" = "merge" ]; then
1718                 ucnt="$(( $(git ls-files --unmerged --full-name --abbrev :/ | wc -l) ))"
1719                 if [ $ucnt -gt 0 ]; then
1720                         echo "${pfx}"'fix conflicts and then "git commit" the result'
1721                 else
1722                         echo "${pfx}"'all conflicts fixed; run "git commit" to record result'
1723                 fi
1724         fi
1725         if [ -z "$git_state" ]; then
1726                 setup_git_dir_is_bare
1727                 [ -z "$git_dir_is_bare" ] || return 0
1728                 gsp="$(git status --porcelain 2>/dev/null)" || return 0 # bare repository???
1729                 gspcnt=0
1730                 [ -z "$gsp" ] ||
1731                 gspcnt="$(( $(printf '%s\n' "$gsp" | sed -n '/^??/!p' | wc -l) ))"
1732                 untr=
1733                 if [ "$gspcnt" -eq 0 ]; then
1734                         [ -z "$gsp" ] || untr="; non-ignored, untracked files present"
1735                         echo "${pfx}working directory is clean$untr"
1736                         [ -n "$tg_state" ] || do_status_result=0
1737                 else
1738                         echo "${pfx}working directory is DIRTY"
1739                         [ -z "$do_status_verbose" ] || git status --short --untracked-files=no
1740                 fi
1741         fi
1742 }
1743
1744 ## Pager stuff
1745
1746 # isatty FD
1747 isatty()
1748 {
1749         test -t $1
1750 }
1751
1752 # pass "diff" to get pager.diff
1753 # if pager.$1 is a boolean false returns cat
1754 # if set to true or unset fails
1755 # otherwise succeeds and returns the value
1756 get_pager()
1757 {
1758         if _x="$(git config --bool "pager.$1" 2>/dev/null)"; then
1759                 [ "$_x" != "true" ] || return 1
1760                 echo "cat"
1761                 return 0
1762         fi
1763         if _x="$(git config "pager.$1" 2>/dev/null)"; then
1764                 echol "$_x"
1765                 return 0
1766         fi
1767         return 1
1768 }
1769
1770 # setup_pager
1771 # Set TG_PAGER to a valid executable
1772 # After calling, code to be paged should be surrounded with {...} | eval "$TG_PAGER"
1773 # See also the following "page" function for ease of use
1774 # emptypager will be set to 1 (otherwise empty) if TG_PAGER was set to "cat" to not be empty
1775 # Preference is (same as Git):
1776 #   1. GIT_PAGER
1777 #   2. pager.$USE_PAGER_TYPE (but only if USE_PAGER_TYPE is set and so is pager.$USE_PAGER_TYPE)
1778 #   3. core.pager (only if set)
1779 #   4. PAGER
1780 #   5. git var GIT_PAGER
1781 #   6. less
1782 setup_pager()
1783 {
1784         isatty 1 || { emptypager=1; TG_PAGER=cat; return 0; }
1785
1786         emptypager=
1787         if [ -z "$TG_PAGER_IN_USE" ]; then
1788                 # TG_PAGER = GIT_PAGER | PAGER | less
1789                 # NOTE: GIT_PAGER='' is significant
1790                 if [ -n "${GIT_PAGER+set}" ]; then
1791                         TG_PAGER="$GIT_PAGER"
1792                 elif [ -n "$USE_PAGER_TYPE" ] && _dp="$(get_pager "$USE_PAGER_TYPE")"; then
1793                         TG_PAGER="$_dp"
1794                 elif _cp="$(git config core.pager 2>/dev/null)"; then
1795                         TG_PAGER="$_cp"
1796                 elif [ -n "${PAGER+set}" ]; then
1797                         TG_PAGER="$PAGER"
1798                 else
1799                         _gp="$(git var GIT_PAGER 2>/dev/null)" || :
1800                         [ "$_gp" != ":" ] || _gp=
1801                         TG_PAGER="${_gp:-less}"
1802                 fi
1803                 if [ -z "$TG_PAGER" ]; then
1804                         emptypager=1
1805                         TG_PAGER=cat
1806                 fi
1807         else
1808                 emptypager=1
1809                 TG_PAGER=cat
1810         fi
1811
1812         # Set pager default environment variables
1813         # see pager.c:setup_pager
1814         if [ -z "${LESS+set}" ]; then
1815                 LESS="-FRX"
1816                 export LESS
1817         fi
1818         if [ -z "${LV+set}" ]; then
1819                 LV="-c"
1820                 export LV
1821         fi
1822
1823         # this is needed so e.g. $(git diff) will still colorize it's output if
1824         # requested in ~/.gitconfig with color.diff=auto
1825         GIT_PAGER_IN_USE=1
1826         export GIT_PAGER_IN_USE
1827
1828         # this is needed so we don't get nested pagers
1829         TG_PAGER_IN_USE=1
1830         export TG_PAGER_IN_USE
1831 }
1832
1833 # page eval_arg [arg ...]
1834 #
1835 # Calls setup_pager then evals the first argument passing it all the rest
1836 # where the output is piped through eval "$TG_PAGER" unless emptypager is set
1837 # by setup_pager (in which case the output is left as-is).
1838 #
1839 # To handle arbitrary paging duties, collect lines to be paged into a
1840 # function and then call page with the function name or perhaps func_name "$@".
1841 #
1842 # If no arguments at all are passed in do nothing (return with success).
1843 page()
1844 {
1845         [ $# -gt 0 ] || return 0
1846         setup_pager
1847         _evalarg="$1"; shift
1848         if [ -n "$emptypager" ]; then
1849                 eval "$_evalarg" '"$@"'
1850         else
1851                 { eval "$_evalarg" '"$@"';} | eval "$TG_PAGER"
1852         fi
1853 }
1854
1855 # get_temp NAME [-d]
1856 # creates a new temporary file (or directory with -d) in the global
1857 # temporary directory $tg_tmp_dir with pattern prefix NAME
1858 get_temp()
1859 {
1860         mktemp $2 "$tg_tmp_dir/$1.XXXXXX"
1861 }
1862
1863 # automatically called by strftime
1864 # does nothing if already setup
1865 # may be called explicitly if the first call would otherwise be in a subshell
1866 # so that the setup is only done once before subshells start being spawned
1867 setup_strftime()
1868 {
1869         [ -z "$strftime_is_setup" ] || return 0
1870
1871         # date option to format raw epoch seconds values
1872         daterawopt=
1873         _testes='951807788'
1874         _testdt='2000-02-29 07:03:08 UTC'
1875         _testfm='%Y-%m-%d %H:%M:%S %Z'
1876         if [ "$(TZ=UTC date "-d@$_testes" "+$_testfm" 2>/dev/null)" = "$_testdt" ]; then
1877                 daterawopt='-d@'
1878         elif [ "$(TZ=UTC date "-r$_testes" "+$_testfm" 2>/dev/null)" = "$_testdt" ]; then
1879                 daterawopt='-r'
1880         fi
1881         strftime_is_setup=1
1882 }
1883
1884 # $1 => strftime format string to use
1885 # $2 => raw timestamp as seconds since epoch
1886 # $3 => optional time zone string (empty/absent for local time zone)
1887 strftime()
1888 {
1889         setup_strftime
1890         if [ -n "$daterawopt" ]; then
1891                 if [ -n "$3" ]; then
1892                         TZ="$3" date "$daterawopt$2" "+$1"
1893                 else
1894                         date "$daterawopt$2" "+$1"
1895                 fi
1896         else
1897                 if [ -n "$3" ]; then
1898                         TZ="$3" perl -MPOSIX=strftime -le 'print strftime($ARGV[0],localtime($ARGV[1]))' "$1" "$2"
1899                 else
1900                         perl -MPOSIX=strftime -le 'print strftime($ARGV[0],localtime($ARGV[1]))' "$1" "$2"
1901                 fi
1902         fi
1903 }
1904
1905 got_cdup_result=
1906 git_cdup_result=
1907 v_get_show_cdup()
1908 {
1909         if [ -z "$got_cdup_result" ]; then
1910                 git_cdup_result="$(git rev-parse --show-cdup)"
1911                 got_cdup_result=1
1912         fi
1913         [ -z "$1" ] || eval "$1="'"$git_cdup_result"'
1914 }
1915
1916 git_dir_is_bare_setup=
1917 setup_git_dir_is_bare()
1918 {
1919         if [ -z "$git_dir_is_bare_setup" ]; then
1920                 git_dir_is_bare="$(git rev-parse --is-bare-repository)"
1921                 [ z"$git_dir_is_bare" = z"true" ] || git_dir_is_bare=
1922                 git_dir_is_bare_setup=1
1923         fi
1924 }
1925
1926 git_hooks_pat_list="\
1927 [a]pplypatch-ms[g] [p]re-applypatc[h] [p]ost-applypatc[h] [p]re-commi[t] \
1928 [p]repare-commit-ms[g] [c]ommit-ms[g] [p]ost-commi[t] [p]re-rebas[e] \
1929 [p]ost-checkou[t] [p]ost-merg[e] [p]re-pus[h] [p]re-receiv[e] [u]pdat[e] \
1930 [p]ost-receiv[e] [p]ost-updat[e] [p]ush-to-checkou[t] [p]re-auto-g[c] \
1931 [p]ost-rewrit[e]"
1932
1933 # git_hooks_dir must already be set to the value of core.hooksPath which
1934 # exists and is an absolute path.  The first and only argument is the
1935 # "pwd -P" of the $git_hooks_dir directory.  If the core.hooksPath setting
1936 # appears to be "friendly" attempt to alter it to be an absolute path to
1937 # "$git_common_dir/hooks" instead.  A "friendly" core.hooksPath setting
1938 # points to a directory for which "$git_common_dir/hooks" already has
1939 # entries which are symbolic links to the same core.hooksPath items.
1940 # There's no POSIX readlink utility, but there is a 'cmp -s' utility so we
1941 # use that instead to check.  Also the "friendly" core.hooksPath must be
1942 # something that's recognizable as belonging to a "friendly".
1943 maybe_adjust_friendly_hooks_path()
1944 {
1945         case "$1" in */_global/hooks);;*) return 0; esac
1946         [ -n "$1" ] && [ -d "$1" ] && [ -d "$git_common_dir/hooks" ] || return 0
1947         [ -w "$git_common_dir" ] || return 0
1948         ! [ -e "$git_common_dir/config" ] || {
1949         [ -f "$git_common_dir/config" ] && [ -w "$git_common_dir/config" ]
1950         } || return 0
1951         oktoswitch=1
1952         for ghook in $(cd "$1" && eval "echo $git_hooks_pat_list"); do
1953                 case "$ghook" in "["*) continue; esac
1954                 [ -x "$1/$ghook" ] &&
1955                 [ -f "$1/$ghook" ] || continue
1956                 [ -x "$git_common_dir/hooks/$ghook" ] &&
1957                 [ -f "$git_common_dir/hooks/$ghook" ] &&
1958                 cmp -s "$1/$ghook" "$git_common_dir/hooks/$ghook" || {
1959                         oktoswitch=
1960                         break
1961                 }
1962         done
1963         if [ -n "$oktoswitch" ]; then
1964                 # a known "friendly" was detected and the hooks match;
1965                 # go ahead and silently switch the path
1966                 ! git config core.hooksPath "$git_common_dir/hooks" >/dev/null 2>&1 ||
1967                 git_hooks_dir="$git_common_dir/hooks"
1968         fi
1969         unset_ oktoswitch
1970         return 0
1971 }
1972
1973 git_hooks_dir=
1974 setup_git_hooks_dir()
1975 {
1976         [ -z "$git_hooks_dir" ] || return 0
1977         git_hooks_dir="$git_common_dir/hooks"
1978         if vcmp "$git_version" '>=' "2.9" && gchp="$(git config --path --get core.hooksPath 2>/dev/null)" && [ -n "$gchp" ]; then
1979                 case "$gchp" in
1980                         /[!/]*)
1981                                 if [ -d "$gchp" ]; then
1982                                         # if core.hooksPath is just another name for
1983                                         # $git_common_dir/hooks, keep referring to it
1984                                         # by $git_common_dir/hooks
1985                                         abscdh="$(cd "$git_common_dir" && pwd -P)/hooks"
1986                                         abshpd="$(cd "$gchp" && pwd -P)"
1987                                         if [ "$abshpd" != "$abscdh" ]; then
1988                                                 git_hooks_dir="$gchp"
1989                                                 maybe_adjust_friendly_hooks_path "$abshpd"
1990                                         fi
1991                                         unset_ abscdh abshpd
1992                                 else
1993                                         [ -n "$1" ] || warn "ignoring non-existent core.hooksPath: $gchp"
1994                                 fi
1995                                 ;;
1996                         *)
1997                                 [ -n "$1" ] || warn "ignoring non-absolute core.hooksPath: $gchp"
1998                                 ;;
1999                 esac
2000                 unset_ gchp
2001         fi
2002 }
2003
2004 setup_git_dirs()
2005 {
2006         [ -n "$git_dir" ] || git_dir="$(git rev-parse --git-dir)"
2007         if [ -n "$git_dir" ] && [ -d "$git_dir" ]; then
2008                 git_dir="$(cd "$git_dir" && pwd)"
2009         fi
2010         if [ -z "$git_common_dir" ]; then
2011                 if vcmp "$git_version" '>=' "2.5"; then
2012                         # rev-parse --git-common-dir is broken and may give
2013                         # an incorrect result unless the current directory is
2014                         # already set to the top level directory
2015                         v_get_show_cdup
2016                         git_common_dir="$(cd "./$git_cdup_result" && cd "$(git rev-parse --git-common-dir)" && pwd)"
2017                 else
2018                         git_common_dir="$git_dir"
2019                 fi
2020         fi
2021         [ -n "$git_dir" ] && [ -n "$git_common_dir" ] &&
2022         [ -d "$git_dir" ] && [ -d "$git_common_dir" ] || die "Not a git repository"
2023 }
2024
2025 basic_setup_remote()
2026 {
2027         if [ -z "$base_remote" ]; then
2028                 if [ "${TG_EXPLICIT_REMOTE+set}" = "set" ]; then
2029                         base_remote="$TG_EXPLICIT_REMOTE"
2030                 else
2031                         base_remote="$(git config topgit.remote 2>/dev/null)" || :
2032                 fi
2033         fi
2034 }
2035
2036 basic_setup()
2037 {
2038         setup_git_dirs $1
2039         basic_setup_remote
2040         tgsequester="$(git config --bool topgit.sequester 2>/dev/null)" || :
2041         tgnosequester=
2042         [ "$tgsequester" != "false" ] || tgnosequester=1
2043         unset_ tgsequester
2044
2045         # catch errors if topbases is used without being set
2046         unset_ tg_topbases_set
2047         topbases="programmer*:error"
2048         topbasesrx="programmer*:error}"
2049         oldbases="$topbases"
2050 }
2051
2052 tmpdir_cleanup()
2053 {
2054         test -z "$tg_tmp_dir" || ! test -d "$tg_tmp_dir" || ${TG_DEBUG:+echo} rm -rf "$tg_tmp_dir" >&2 || :
2055 }
2056
2057 tmpdir_setup()
2058 {
2059         [ -z "$tg_tmp_dir" ] || return 0
2060         if [ -n "$TG_TMPDIR" ] && [ -d "$TG_TMPDIR" ] && [ -w "$TG_TMPDIR" ] &&
2061            { >"$TG_TMPDIR/.check"; } >/dev/null 2>&1; then
2062                 tg_tmp_dir="$TG_TMPDIR"
2063         else
2064                 tg_tmp_dir=
2065                 TRAPEXIT_='tmpdir_cleanup'
2066                 trap 'trapexit_ 129' HUP
2067                 trap 'trapexit_ 130' INT
2068                 trap 'trapexit_ 131' QUIT
2069                 trap 'trapexit_ 134' ABRT
2070                 trap 'trapexit_ 141' PIPE
2071                 trap 'trapexit_ 143' TERM
2072                 tg_tmp_dir="$(mktemp -d "$git_dir/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
2073                 [ -n "$tg_tmp_dir" ] || tg_tmp_dir="$(mktemp -d "${TMPDIR:-/tmp}/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
2074                 [ -n "$tg_tmp_dir" ] || [ -z "$TMPDIR" ] || tg_tmp_dir="$(mktemp -d "/tmp/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
2075                 [ -z "$tg_tmp_dir" ] || tg_tmp_dir="$(cd "$tg_tmp_dir" && pwd -P)"
2076         fi
2077         [ -n "$tg_tmp_dir" ] && [ -w "$tg_tmp_dir" ] && { >"$tg_tmp_dir/.check"; } >/dev/null 2>&1 ||
2078                 die "could not create a writable temporary directory"
2079
2080         # whenever tg_tmp_dir is != "" these must always be set
2081         tg_ref_cache="$tg_tmp_dir/tg~ref-cache"
2082         tg_ref_cache_br="$tg_ref_cache.br"
2083         tg_ref_cache_rbr="$tg_ref_cache.rbr"
2084         tg_ref_cache_ann="$tg_ref_cache.ann"
2085         tg_ref_cache_dep="$tg_ref_cache.dep"
2086 }
2087
2088 cachedir_setup()
2089 {
2090         [ -z "$tg_cache_dir" ] || return 0
2091         user_id_no="$(id -u)" || :
2092         : "${user_id_no:=_99_}"
2093         tg_cache_dir="$git_common_dir/tg-cache"
2094         [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
2095         [ -z "$tg_cache_dir" ] || tg_cache_dir="$tg_cache_dir/$user_id_no"
2096         [ -z "$tg_cache_dir" ] || [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
2097         [ -z "$tg_cache_dir" ] || { >"$tg_cache_dir/.tgcache"; } >/dev/null 2>&1 || tg_cache_dir=
2098         if [ -z "$tg_cache_dir" ]; then
2099                 tg_cache_dir="$tg_tmp_dir/tg-cache"
2100                 [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
2101                 [ -z "$tg_cache_dir" ] || { >"$tg_cache_dir/.tgcache"; } >/dev/null 2>&1 || tg_cache_dir=
2102         fi
2103         [ -n "$tg_cache_dir" ] ||
2104                 die "could not create a writable tg-cache directory (even a temporary one)"
2105
2106         if [ -n "$2" ]; then
2107                 # allow the wayback machine to share a separate cache
2108                 [ -d "$tg_cache_dir/wayback" ] || mkdir "$tg_cache_dir/wayback" >/dev/null 2>&1 || :
2109                 ! [ -d "$tg_cache_dir/wayback" ] || ! { >"$tg_cache_dir/wayback/.tgcache"; } >/dev/null 2>&1 ||
2110                 tg_cache_dir="$tg_cache_dir/wayback"
2111         fi
2112 }
2113
2114 # set up alternate deb dirs
2115 altodb_setup()
2116 {
2117         # GIT_ALTERNATE_OBJECT_DIRECTORIES can contain double-quoted entries
2118         # since Git v2.11.1; however, it's only necessary for : (or perhaps ;)
2119         # so we avoid it if possible and require v2.11.1 to do it at all
2120         # otherwise just don't make an alternates temporary store in that case;
2121         # it's okay to not have one; everything will still work; the nicety of
2122         # making the temporary tree objects vanish when tg exits just won't
2123         # happen in that case but nothing will break also be sure to reuse
2124         # the parent's if we've been recursively invoked and it's for the
2125         # same repository we were invoked on
2126
2127         tg_use_alt_odb=1
2128         _fullodbdir=
2129         _odbdir="${GIT_OBJECT_DIRECTORY:-$git_common_dir/objects}"
2130         [ -n "$_odbdir" ] && [ -d "$_odbdir" ] && _fullodbdir="$(cd "$_odbdir" && pwd -P)" ||
2131                 die "could not find objects directory"
2132         if [ -n "$TG_OBJECT_DIRECTORY" ] && [ -d "$TG_OBJECT_DIRECTORY/info" ] &&
2133            [ -f "$TG_OBJECT_DIRECTORY/info/alternates" ] && [ -r "$TG_OBJECT_DIRECTORY/info/alternates" ]; then
2134                 if IFS= read -r _otherodbdir <"$TG_OBJECT_DIRECTORY/info/alternates" &&
2135                    [ -n "$_otherodbdir" ] && [ "$_otherodbdir" = "$_fullodbdir" ]; then
2136                         tg_use_alt_odb=2
2137                 fi
2138         fi
2139         _fulltmpdir="$(cd "$tg_tmp_dir" && pwd -P)"
2140         if [ "$tg_use_alt_odb" = "1" ]; then
2141                 # create an alternate objects database to keep the ephemeral objects in
2142                 mkdir -p "$tg_tmp_dir/objects/info"
2143                 TG_OBJECT_DIRECTORY="$_fulltmpdir/objects"
2144                 [ "$_fullodbdir" = "$TG_OBJECT_DIRECTORY" ] ||
2145                 echol "$_fullodbdir" >"$tg_tmp_dir/objects/info/alternates"
2146         fi
2147         case "$_fulltmpdir" in *[";:"]*|'"'*) vcmp "$git_version" '>=' "2.11.1" || tg_use_alt_odb=; esac
2148         if [ "$tg_use_alt_odb" = "1" ]; then
2149                 case "$TG_OBJECT_DIRECTORY" in
2150                         *[";:"]*|'"'*)
2151                                 # surround in "..." and backslash-escape internal '"' and '\\'
2152                                 _altodbdq="\"$(printf '%s\n' "$TG_OBJECT_DIRECTORY" |
2153                                         sed 's/\([""\\]\)/\\\1/g')\""
2154                                 ;;
2155                         *)
2156                                 _altodbdq="$TG_OBJECT_DIRECTORY"
2157                                 ;;
2158                 esac
2159                 TG_PRESERVED_ALTERNATES="$GIT_ALTERNATE_OBJECT_DIRECTORIES"
2160                 if [ -n "$GIT_ALTERNATE_OBJECT_DIRECTORIES" ]; then
2161                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$_altodbdq:$GIT_ALTERNATE_OBJECT_DIRECTORIES"
2162                 else
2163                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$_altodbdq"
2164                 fi
2165                 export TG_PRESERVED_ALTERNATES TG_OBJECT_DIRECTORY GIT_ALTERNATE_OBJECT_DIRECTORIES
2166                 if [ -n "$GIT_OBJECT_DIRECTORY" ]; then
2167                         export GIT_OBJECT_DIRECTORY
2168                 else
2169                         unset_ GIT_OBJECT_DIRECTORY
2170                 fi
2171         fi
2172 }
2173
2174 noalt_setup()
2175 {
2176         if [ "${TG_PRESERVED_ALTERNATES+set}" = "set" ]; then
2177                 GIT_ALTERNATE_OBJECT_DIRECTORIES="$TG_PRESERVED_ALTERNATES"
2178                 if [ -n "$GIT_ALTERNATE_OBJECT_DIRECTORIES" ]; then
2179                         export GIT_ALTERNATE_OBJECT_DIRECTORIES
2180                 else
2181                         unset_ GIT_ALTERNATE_OBJECT_DIRECTORIES
2182                 fi
2183         fi
2184         unset_ TG_TMPDIR TG_OBJECT_DIRECTORY TG_PRESERVED_ALTERNATES tg_use_alt_odb
2185 }
2186
2187 ## Initial setup
2188 initial_setup()
2189 {
2190         # suppress the merge log editor feature since git 1.7.10
2191
2192         GIT_MERGE_AUTOEDIT=no
2193         export GIT_MERGE_AUTOEDIT
2194
2195         basic_setup $1
2196         iowopt=
2197         ! vcmp "$git_version" '>=' "2.5" || iowopt="--ignore-other-worktrees"
2198         gcfbopt=
2199         ! vcmp "$git_version" '>=' "2.6" || gcfbopt="--buffer"
2200         auhopt=
2201         ! vcmp "$git_version" '>=' "2.9" || auhopt="--allow-unrelated-histories"
2202         v_get_show_cdup root_dir
2203         root_dir="${root_dir:-.}"
2204         logrefupdates="$(git config --bool core.logallrefupdates 2>/dev/null)" || :
2205         [ "$logrefupdates" = "true" ] || logrefupdates=
2206
2207         # make sure root_dir doesn't end with a trailing slash.
2208
2209         root_dir="${root_dir%/}"
2210
2211         # create global temporary and cache directories, usually inside GIT_DIR
2212
2213         tmpdir_setup
2214         unset_ TG_TMPDIR
2215         cachedir_setup
2216
2217         # the wayback machine directory serves as its own "altodb"
2218         [ -n "$wayback" ] || altodb_setup
2219 }
2220
2221 activate_wayback_machine()
2222 {
2223         [ -n "${1#:}" ] || [ -n "$2" ] || { wayback=; return 0; }
2224         setup_git_dirs
2225         tmpdir_setup
2226         altodb_setup
2227         tgwbr=
2228         tgwbr2=
2229         if [ -n "${1#:}" ]; then
2230                 tgwbr="$(get_temp wbinfo)"
2231                 tgwbr2="${tgwbr}2"
2232                 tg revert --list --no-short "${1#:}" >"$tgwbr" && test -s "$tgwbr" || return 1
2233                 # tg revert will likely leave a revert-tag-only cache which is not what we want
2234                 remove_ref_cache
2235         fi
2236         cachedir_setup "" 1 # use a separate wayback cache dir
2237         # but don't step on the normal one if the separate one could not be set up
2238         case "$tg_cache_dir" in */wayback);;*) tg_cache_dir=; esac
2239         altodb="$TG_OBJECT_DIRECTORY"
2240         if [ -n "$3" ] && [ -n "$2" ]; then
2241                 [ -d "$3" ] || { mkdir -p "$3" && [ -d "$3" ]; } ||
2242                         die "could not create wayback directory: $3"
2243                 tg_wayback_dir="$(cd "$3" && pwd -P)" || die "could not get wayback directory full path"
2244                 [ -d "$tg_wayback_dir/.git" ] || { mkdir -p "$tg_wayback_dir/.git" && [ -d "$tg_wayback_dir/.git" ]; } ||
2245                         die "could not initialize wayback directory: $3"
2246                 is_empty_dir "$tg_wayback_dir" ".git" && is_empty_dir "$tg_wayback_dir/.git" "." ||
2247                         die "wayback directory is not empty: $3"
2248                 mkdir "$tg_wayback_dir/.git/objects"
2249                 mkdir "$tg_wayback_dir/.git/objects/info"
2250                 cat "$altodb/info/alternates" >"$tg_wayback_dir/.git/objects/info/alternates"
2251         else
2252                 tg_wayback_dir="$tg_tmp_dir/wayback"
2253                 mkdir "$tg_wayback_dir"
2254                 mkdir "$tg_wayback_dir/.git"
2255                 ln -s "$altodb" "$tg_wayback_dir/.git/objects"
2256         fi
2257         mkdir "$tg_wayback_dir/.git/refs"
2258         printf '0 Wayback Machine' >"$tg_wayback_dir/.git/gc.pid"
2259         qpesc="$(printf '%s\n' "$git_common_dir" | sed -e 's/\([\\""]\)/\\\1/g' -e '$!s/$/\\n/' | tr -d '\n')"
2260         laru="false"
2261         [ -z "$2" ] || laru="true"
2262         printf '%s' "\
2263 [include]
2264         path = \"$qpesc/config\"
2265 [core]
2266         bare = false
2267         logAllRefUpdates = $laru
2268         repositoryFormatVersion = 0
2269 [extensions]
2270         preciousObjects = true
2271 [gc]
2272         auto = 0
2273         autoDetach = false
2274         autoPackLimit = 0
2275         packRefs = false
2276 [remote \"wayback\"]
2277         url = \"$qpesc\"
2278 [push]
2279         default = nothing
2280         followTags = true
2281 [alias]
2282         wayback-updates = fetch -u --force --no-tags --dry-run wayback refs/*:refs/*
2283 " >"$tg_wayback_dir/.git/config"
2284         cat "$git_dir/HEAD" >"$tg_wayback_dir/.git/HEAD"
2285         case "$1" in ":"?*);;*)
2286                 git show-ref >"$tg_wayback_dir/.git/packed-refs"
2287                 git --git-dir="$tg_wayback_dir/.git" pack-refs --all
2288         esac
2289         noalt_setup
2290         TG_OBJECT_DIRECTORY="$altodb" && export TG_OBJECT_DIRECTORY
2291         if [ -n "${1#:}" ]; then
2292                 <"$tgwbr" sed 's/^\([^ ][^ ]*\) \([^ ][^ ]*\)$/update \2 \1/' |
2293                 git --git-dir="$tg_wayback_dir/.git" update-ref -m "wayback to $1" ${2:+--create-reflog} --stdin
2294         fi
2295         if test -n "$2"; then
2296                 # extra setup for potential shell
2297                 qpesc2="$(printf '%s\n' "$git_common_dir" | sed -e 's/\([\\""]\)/\\\\\1/g' -e '$!s/$/\\n/' | tr -d '\n')"
2298                 printf '\twayback-repository = "!printf '\''%%s\\\\n'\'' \\"%s\\""\n' "$qpesc2" >>"$tg_wayback_dir/.git/config"
2299                 qtesc="$(printf '%s\n' "${1:-:}" | sed 's/\([""]\)/\\\1/g')"
2300                 printf '\twayback-tag = "!printf '\''%%s\\\\n'\'' \\"%s\\""\n' "$qtesc" >>"$tg_wayback_dir/.git/config"
2301                 if [ -d "$git_common_dir/rr-cache" ]; then
2302                         ln -s "$git_common_dir/rr-cache" "$tg_wayback_dir/.git/rr-cache"
2303                         printf "[rerere]\n\tenabled = true\n" >>"$tg_wayback_dir/.git/config"
2304                 fi
2305                 if [ z"$2" != z"2" ]; then
2306                         wbauth=
2307                         wbprnt=
2308                         if [ -n "${1#:}" ]; then
2309                                 [ -n "$tgwbr2" ] || tgwbr2="$(get_temp wbtag)"
2310                                 git --git-dir="$git_common_dir" cat-file tag "${1#:}" >"$tgwbr2" || return 1
2311                                 wbprnt="${lf}parent $(git --git-dir="$git_common_dir" rev-parse --verify --quiet "${1#:}"^0 -- 2>/dev/null)" || wbprnt=
2312                                 wbauth="$(<"$tgwbr2" awk '{if(!$0)exit;if($1=="tagger")print "author" substr($0,7)}')"
2313                         fi
2314                         wbcmtr="committer Wayback Machine <-> $(date "+%s %z")"
2315                         [ -n "$wbauth" ] || wbauth="author${wbcmtr#committer}"
2316                         wbtree="$(git --git-dir="$tg_wayback_dir/.git" mktree </dev/null)"
2317                         wbcmt="$({
2318                                 printf '%s\n' "tree $wbtree$wbprnt" "$wbauth" "$wbcmtr" ""
2319                                 if [ -n "$tgwbr2" ]; then
2320                                         <"$tgwbr2" sed -e '1,/^$/d' -e '/^-----BEGIN/,$d' | git stripspace
2321                                 else
2322                                         echo "Wayback Machine"
2323                                 fi
2324                         } | git --git-dir="$tg_wayback_dir/.git" hash-object -t commit -w --stdin)"
2325                         test -n "$wbcmt" || return 1
2326                         echo "$wbcmt" >"$tg_wayback_dir/.git/HEAD"
2327                 fi
2328         fi
2329         cd "$tg_wayback_dir"
2330         unset git_dir git_common_dir
2331 }
2332
2333 set_topbases()
2334 {
2335         # refer to "top-bases" in a refname with $topbases
2336
2337         [ -z "$tg_topbases_set" ] || return 0
2338
2339         topbases_implicit_default=1
2340         # See if topgit.top-bases is set to heads or refs
2341         tgtb="$(git config "topgit.top-bases" 2>/dev/null)" || :
2342         if [ -n "$tgtb" ] && [ "$tgtb" != "heads" ] && [ "$tgtb" != "refs" ]; then
2343                 if [ -n "$1" ]; then
2344                         # never die on the hook script
2345                         unset_ tgtb
2346                 else
2347                         die "invalid \"topgit.top-bases\" setting (must be \"heads\" or \"refs\")"
2348                 fi
2349         fi
2350         if [ -n "$tgtb" ]; then
2351                 case "$tgtb" in
2352                 heads)
2353                         topbases="heads/{top-bases}"
2354                         topbasesrx="heads/[{]top-bases[}]"
2355                         oldbases="top-bases";;
2356                 refs)
2357                         topbases="top-bases"
2358                         topbasesrx="top-bases"
2359                         oldbases="heads/{top-bases}";;
2360                 esac
2361                 # MUST NOT be exported
2362                 unset_ tgtb tg_topbases_set topbases_implicit_default
2363                 tg_topbases_set=1
2364                 return 0
2365         fi
2366         unset_ tgtb
2367
2368         # check heads and top-bases and see what state the current
2369         # repository is in.  remotes are ignored.
2370
2371         rc=0 activebases=
2372         activebases="$(
2373                 git for-each-ref --format='%(refname)' "refs/heads" "refs/top-bases" 2>/dev/null |
2374                 run_awk_ref_prefixes ${1:+-e} -n -- "refs/heads/{top-bases}" "refs/top-bases" "refs/heads")" ||
2375                 rc=$?
2376         if [ "$rc" = "65" ]; then
2377                 # Complain and die
2378                 err "repository contains existing TopGit branches"
2379                 err "but some use refs/top-bases/... for the base"
2380                 err "and some use refs/heads/{top-bases}/... for the base"
2381                 err "with the latter being the new, preferred location"
2382                 err "set \"topgit.top-bases\" to either \"heads\" to use"
2383                 err "the new heads/{top-bases} location or \"refs\" to use"
2384                 err "the old top-bases location."
2385                 err "(the tg migrate-bases command can also resolve this issue)"
2386                 die "schizophrenic repository requires topgit.top-bases setting"
2387         fi
2388         [ -z "$activebases" ] || unset_ topbases_implicit_default
2389         if [ "$activebases" = "refs/heads/{top-bases}" ]; then
2390                 topbases="heads/{top-bases}"
2391                 topbasesrx="heads/[{]top-bases[}]"
2392                 oldbases="top-bases"
2393         else
2394                 # default is still top-bases for now
2395                 topbases="top-bases"
2396                 topbasesrx="top-bases"
2397                 oldbases="heads/{top-bases}"
2398         fi
2399         # MUST NOT be exported
2400         unset_ rc activebases tg_topases_set
2401         tg_topbases_set=1
2402         return 0
2403 }
2404
2405 # $1 is remote name to check
2406 # $2 is optional variable name to set to result of check
2407 # $3 is optional command name to use in message (defaults to $cmd)
2408 # Fatal error if remote has schizophrenic top-bases
2409 # No error (and $2, if provided, will be set to empty) if remote has no top-bases at all
2410 check_remote_topbases()
2411 {
2412         [ -n "$1" ] || die "programmer error: check_remote_topbases called with no remote argument"
2413         _crrc=0 _crremotebases=
2414         _crremotebases="$(
2415                 git for-each-ref --format='%(refname)' "refs/remotes/$1" 2>/dev/null |
2416                 run_awk_ref_prefixes -n -- "refs/remotes/$1/{top-bases}" "refs/remotes/$1/top-bases" "refs/remotes/$1")" ||
2417                 _crrc=$?
2418         if [ "$_crrc" = "65" ]; then
2419                 err "remote \"$1\" has top-bases in both locations:"
2420                 err "  refs/remotes/$1/{top-bases}/..."
2421                 err "  refs/remotes/$1/top-bases/..."
2422                 err "set \"topgit.top-bases\" to \"heads\" for the first, preferred location"
2423                 err "or set \"topgit.top-bases\" to \"refs\" for the second, old location"
2424                 err "(the \"-c topgit.top-bases=<val>\" option can be used for this)"
2425                 err "then re-run the tg ${3:-$cmd} command"
2426                 err "(the tg migrate-bases command can also help with this problem)"
2427                 die "schizophrenic remote \"$1\" requires topgit.top-bases setting"
2428         fi
2429         [ "$_crrc" != "66" ] || _crremotebases= # just to be sure
2430         [ -z "$2" ] || eval "$2="'"$_crremotebases"'
2431         unset _crrc _crremotebases
2432         return 0
2433 }
2434
2435 # init_reflog "ref"
2436 # if "$logrefupdates" is set and ref is not under refs/heads/ then force
2437 # an empty log file to exist so that ref changes will be logged
2438 # "$1" must be a fully-qualified refname (i.e. start with "refs/")
2439 # However, if "$1" is "refs/tgstash" then always make the reflog
2440 # The only ref not under refs/ that Git will write a reflog for is HEAD;
2441 # no matter what, it will NOT update a reflog for any other bare refs so
2442 # just quietly succeed when passed TG_STASH without doing anything.
2443 init_reflog()
2444 {
2445         [ -n "$1" ] && [ "$1" != "TG_STASH" ] || return 0
2446         [ -n "$logrefupdates" ] || [ "$1" = "refs/tgstash" ] || return 0
2447         case "$1" in refs/heads/*|HEAD) return 0;; refs/*[!/]);; *) return 1; esac
2448         mkdir -p "$git_common_dir/logs/${1%/*}" 2>/dev/null || :
2449         { >>"$git_common_dir/logs/$1" || :; } 2>/dev/null
2450  }
2451
2452 # store the "realpath" for "$2" in "$1" except the leaf is not resolved if it's
2453 # a symbolic link.  The directory part must exist, but the basename need not.
2454 v_get_abs_path()
2455 {
2456         [ -n "$1" ] && [ -n "$2" ] || return 1
2457         set -- "$1" "$2" "${2%/}"
2458         case "$3" in
2459                 */*) set -- "$1" "$2" "${3%/*}";;
2460                 *  ) set -- "$1" "$2" ".";;
2461         esac
2462         case "$2" in */)
2463                 set -- "$1" "${2%/}" "$3" "/"
2464         esac
2465         [ -d "$3" ] || return 1
2466         eval "$1="'"$(cd "$3" && pwd -P)/${2##*/}$4"'
2467 }
2468
2469 ## Startup
2470
2471 : "${TG_INST_CMDDIR:=@cmddir@}"
2472 : "${TG_INST_SHAREDIR:=@sharedir@}"
2473 : "${TG_INST_HOOKSDIR:=@hooksdir@}"
2474
2475 [ -d "$TG_INST_CMDDIR" ] ||
2476         die "No command directory: '$TG_INST_CMDDIR'"
2477
2478 ## Include awk scripts and their utility functions (separated for easier debugging)
2479
2480 [ -f "$TG_INST_CMDDIR/tg--awksome" ] && [ -r "$TG_INST_CMDDIR/tg--awksome" ] ||
2481         die "Missing awk scripts: '$TG_INST_CMDDIR/tg--awksome'"
2482 . "$TG_INST_CMDDIR/tg--awksome"
2483
2484 if [ -n "$tg__include" ]; then
2485
2486         # We were sourced from another script for our utility functions;
2487         # this is set by hooks.  Skip the rest of the file.  A simple return doesn't
2488         # work as expected in every shell.  See http://bugs.debian.org/516188
2489
2490         # ensure setup happens
2491
2492         initial_setup 1
2493         set_topbases 1
2494         noalt_setup
2495
2496 else
2497
2498         set -e
2499
2500         tgbin="$0"
2501         tgdir="${tgbin%/}"
2502         case "$tgdir" in */*);;*) tgdir="./$tgdir"; esac
2503         tgdir="${tgdir%/*}/"
2504         tgname="${tgbin##*/}"
2505         [ "$0" != "$tgname" ] || tgdir=""
2506
2507         # If tg contains a '/' but does not start with one then replace it with an absolute path
2508
2509         case "$0" in /*) ;; */*)
2510                 tgdir="$(cd "${0%/*}" && pwd -P)/"
2511                 tgbin="$tgdir$tgname"
2512         esac
2513
2514         # tgdisplay will include any explicit -C <dir> etc. options whereas tgname will not
2515         # tgdisplayac is the same as tgdisplay but without any -r or -u options (ac => abort/continue)
2516
2517         tgdisplaydir="$tgdir"
2518         tgdisplay="$tgbin"
2519         tgdisplayac="$tgdisplay"
2520         if
2521             v_get_abs_path _tgnameabs "$(cmd_path "$tgname")" &&
2522             _tgabs="$_tgnameabs" &&
2523             { [ "$tgbin" = "$tgname" ] || v_get_abs_path _tgabs "$tgbin"; } &&
2524             [ "$_tgabs" = "$_tgnameabs" ]
2525         then
2526                 tgdisplaydir=""
2527                 tgdisplay="$tgname"
2528                 tgdisplayac="$tgdisplay"
2529         fi
2530         [ -z "$_tgabs" ] || tgbin="$_tgabs"
2531         unset_ _tgabs _tgnameabs
2532
2533         tg() (
2534                 TG_TMPDIR="$tg_tmp_dir" && export TG_TMPDIR &&
2535                 exec "$tgbin" "$@"
2536         )
2537
2538         explicit_remote=
2539         explicit_dir=
2540         gitcdopt=
2541         noremote=
2542         forcepager=
2543         wayback=
2544
2545         cmd=
2546         while :; do case "$1" in
2547
2548                 help|--help|-h)
2549                         cmd=help
2550                         shift
2551                         break;;
2552
2553                 status|--status)
2554                         cmd=status
2555                         shift
2556                         break;;
2557
2558                 --hooks-path)
2559                         cmd=hooks-path
2560                         shift
2561                         break;;
2562
2563                 --exec-path)
2564                         cmd=exec-path
2565                         shift
2566                         break;;
2567
2568                 --awk-path)
2569                         cmd=awk-path
2570                         shift
2571                         break;;
2572
2573                 --top-bases)
2574                         cmd=top-bases
2575                         shift
2576                         break;;
2577
2578                 --no-pager)
2579                         forcepager=0
2580                         shift;;
2581
2582                 --pager|-p)
2583                         forcepager=1
2584                         shift;;
2585
2586                 -r)
2587                         shift
2588                         if [ -z "$1" ]; then
2589                                 echo "Option -r requires an argument." >&2
2590                                 do_help
2591                                 exit 1
2592                         fi
2593                         unset_ noremote
2594                         base_remote="$1"
2595                         explicit_remote="$base_remote"
2596                         tgdisplay="$tgdisplaydir$tgname$gitcdopt -r $explicit_remote"
2597                         TG_EXPLICIT_REMOTE="$base_remote" && export TG_EXPLICIT_REMOTE
2598                         shift;;
2599
2600                 -u)
2601                         unset_ base_remote explicit_remote
2602                         noremote=1
2603                         tgdisplay="$tgdisplaydir$tgname$gitcdopt -u"
2604                         TG_EXPLICIT_REMOTE= && export TG_EXPLICIT_REMOTE
2605                         shift;;
2606
2607                 -C)
2608                         shift
2609                         if [ -z "$1" ]; then
2610                                 echo "Option -C requires an argument." >&2
2611                                 do_help
2612                                 exit 1
2613                         fi
2614                         cd "$1"
2615                         unset_ GIT_DIR GIT_COMMON_DIR
2616                         if [ -z "$explicit_dir" ]; then
2617                                 explicit_dir="$1"
2618                         else
2619                                 explicit_dir="$PWD"
2620                         fi
2621                         gitcdopt=" -C \"$explicit_dir\""
2622                         [ "$explicit_dir" != "." ] || explicit_dir="." gitcdopt=" -C ."
2623                         tgdisplay="$tgdisplaydir$tgname$gitcdopt"
2624                         tgdisplayac="$tgdisplay"
2625                         [ -z "$explicit_remote" ] || tgdisplay="$tgdisplay -r $explicit_remote"
2626                         [ -z "$noremote" ] || tgdisplay="$tgdisplay -u"
2627                         shift;;
2628
2629                 -c)
2630                         shift
2631                         if [ -z "$1" ]; then
2632                                 echo "Option -c requires an argument." >&2
2633                                 do_help
2634                                 exit 1
2635                         fi
2636                         param="'$(printf '%s\n' "$1" | sed "s/[']/'\\\\''/g")'"
2637                         GIT_CONFIG_PARAMETERS="${GIT_CONFIG_PARAMETERS:+$GIT_CONFIG_PARAMETERS }$param"
2638                         export GIT_CONFIG_PARAMETERS
2639                         shift;;
2640
2641                 -w)
2642                         if [ -n "$wayback" ]; then
2643                                 echo "Option -w may be used at most once." >&2
2644                                 do_help
2645                                 exit 1
2646                         fi
2647                         shift
2648                         if [ -z "$1" ]; then
2649                                 echo "Option -w requires an argument." >&2
2650                                 do_help
2651                                 exit 1
2652                         fi
2653                         wayback="$1"
2654                         shift;;
2655
2656                 --)
2657                         shift
2658                         break;;
2659
2660                 -*)
2661                         echo "Invalid option $1 (subcommand options must appear AFTER the subcommand)." >&2
2662                         do_help
2663                         exit 1;;
2664
2665                 *)
2666                         break;;
2667
2668         esac; done
2669         if [ z"$forcepager" = z"0" ]; then
2670                 GIT_PAGER_IN_USE=1 TG_PAGER_IN_USE=1 &&
2671                 export GIT_PAGER_IN_USE TG_PAGER_IN_USE
2672         fi
2673
2674         [ -n "$cmd" ] || [ $# -lt 1 ] || { cmd="$1"; shift; }
2675
2676         ## Dispatch
2677
2678         [ -n "$cmd" ] || { do_help; exit 1; }
2679
2680         case "$cmd" in
2681
2682                 help)
2683                         do_help "$@"
2684                         exit 0;;
2685
2686                 status|st)
2687                         unset_ base_remote
2688                         basic_setup
2689                         set_topbases
2690                         do_status "$@"
2691                         exit ${do_status_result:-0};;
2692
2693                 hooks-path)
2694                         # Internal command
2695                         echol "$TG_INST_HOOKSDIR";;
2696
2697                 exec-path)
2698                         # Internal command
2699                         echol "$TG_INST_CMDDIR";;
2700
2701                 awk-path)
2702                         # Internal command
2703                         echol "$TG_INST_CMDDIR/awk";;
2704
2705                 top-bases)
2706                         # Maintenance command
2707                         do_topbases_help=
2708                         show_remote_topbases=
2709                         case "$1" in
2710                                 --help|-h)
2711                                         do_topbases_help=0;;
2712                                 -r|--remote)
2713                                         if [ $# -eq 2 ] && [ -n "$2" ]; then
2714                                                 # unadvertised, but make it work
2715                                                 base_remote="$2"
2716                                                 shift
2717                                         fi
2718                                         show_remote_topbases=1;;
2719                                 *)
2720                                         [ $# -eq 0 ] || do_topbases_help=1;;
2721                         esac
2722                         [ $# -le 1 ] || do_topbases_help=1
2723                         if [ -n "$do_topbases_help" ]; then
2724                                 helpcmd='echo "Usage: ${tgname:-tg} [-r <remote>] --top-bases [-r]"'
2725                                 [ $do_topbases_help -eq 0 ] || helpcmd="$helpcmd >&2"
2726                                 eval "$helpcmd"
2727                                 exit $do_topbases_help
2728                         fi
2729                         git_dir=
2730                         if git_dir="$(git rev-parse --git-dir 2>&1)"; then
2731                                 [ -z "$wayback" ] || activate_wayback_machine "$wayback"
2732                                 setup_git_dirs
2733                         fi
2734                         set_topbases
2735                         if [ -n "$show_remote_topbases" ]; then
2736                                 basic_setup_remote
2737                                 [ -n "$base_remote" ] ||
2738                                 die "no remote location given. Either use -r <remote> option or set topgit.remote"
2739                                 rbases=
2740                                 [ -z "$topbases_implicit_default" ] ||
2741                                 check_remote_topbases "$base_remote" rbases "--top-bases"
2742                                 if [ -n "$rbases" ]; then
2743                                         echol "$rbases"
2744                                 else
2745                                         echol "refs/remotes/$base_remote/${topbases#heads/}"
2746                                 fi
2747                         else
2748                                 echol "refs/$topbases"
2749                         fi;;
2750
2751                 *)
2752                         isutil=
2753                         case "$cmd" in index-merge-one-file)
2754                                 isutil="-"
2755                         esac
2756                         [ -r "$TG_INST_CMDDIR"/tg-$isutil$cmd ] || {
2757                                 looplevel="$TG_ALIAS_DEPTH"
2758                                 [ "${looplevel#[1-9]}" != "$looplevel" ] &&
2759                                 [ "${looplevel%%[!0-9]*}" = "$looplevel" ] ||
2760                                 looplevel=0
2761                                 tgalias="$(git config "topgit.alias.$cmd" 2>/dev/null)" || :
2762                                 [ -n "$tgalias" ] || {
2763                                         echo "Unknown subcommand: $cmd" >&2
2764                                         do_help
2765                                         exit 1
2766                                 }
2767                                 looplevel=$(( $looplevel + 1 ))
2768                                 [ $looplevel -le 10 ] || die "topgit.alias nesting level 10 exceeded"
2769                                 TG_ALIAS_DEPTH="$looplevel"
2770                                 export TG_ALIAS_DEPTH
2771                                 if [ "!${tgalias#?}" = "$tgalias" ]; then
2772                                         [ -z "$wayback" ] ||
2773                                         die "-w is not allowed before an '!' alias command"
2774                                         unset_ GIT_PREFIX
2775                                         if pfx="$(git rev-parse --show-prefix 2>/dev/null)"; then
2776                                                 GIT_PREFIX="$pfx"
2777                                                 export GIT_PREFIX
2778                                         fi
2779                                         cd "./$(git rev-parse --show-cdup 2>/dev/null)"
2780                                         exec @SHELL_PATH@ -c "${tgalias#?} \"\$@\"" @SHELL_PATH@ "$@"
2781                                 else
2782                                         eval 'exec "$tgbin"' "${wayback:+-w \"\$wayback\"}" "$tgalias" '"$@"'
2783                                 fi
2784                                 die "alias execution failed for: $tgalias"
2785                         }
2786                         unset_ TG_ALIAS_DEPTH
2787
2788                         showing_help=
2789                         if [ "$*" = "-h" ] || [ "$*" = "--help" ]; then
2790                                 showing_help=1
2791                         fi
2792
2793                         nomergesetup="$showing_help"
2794                         case "$cmd" in base|contains|export|files|info|log|mail|next|patch|prev|rebase|revert|shell|summary|tag)
2795                                 # avoid merge setup where not necessary
2796
2797                                 nomergesetup=1
2798                         esac
2799
2800                         if [ -n "$wayback" ] && [ -z "$showing_help" ]; then
2801                                 [ -n "$nomergesetup" ] ||
2802                                 die "the wayback machine cannot be used with the \"$cmd\" subcommand"
2803                                 if [ "$cmd" = "shell" ]; then
2804                                         # this is ugly; `tg shell` should handle this but it's too
2805                                         # late there so we have to do it here
2806                                         wayback_dir=
2807                                         case "$1" in
2808                                                 "--directory="?*)
2809                                                         wayback_dir="${1#--directory=}" && shift;;
2810                                                 "--directory=")
2811                                                         die "--directory requires an argument";;
2812                                                 "--directory")
2813                                                         [ $# -ge 2 ] || die "--directory requires an argument"
2814                                                         wayback_dir="$2" && shift 2;;
2815                                         esac
2816                                         activate_wayback_machine "$wayback" 1 "$wayback_dir"
2817                                 else
2818                                         _fullwb=
2819                                         # export might drop out into a shell for conflict resolution
2820                                         [ "$cmd" != "export" ] || _fullwb=2
2821                                         activate_wayback_machine "$wayback" "$_fullwb"
2822                                 fi ||
2823                                 die "failed to set the wayback machine to target \"$wayback\""
2824                         fi
2825
2826                         [ -n "$showing_help" ] || initial_setup
2827                         [ -z "$noremote" ] || unset_ base_remote
2828
2829                         if [ -z "$nomergesetup" ]; then
2830                                 # make sure merging the .top* files will always behave sanely
2831
2832                                 setup_ours
2833                                 setup_hook "pre-commit"
2834                         fi
2835
2836                         # everything but rebase needs topbases set
2837                         carefully="$showing_help"
2838                         [ "$cmd" != "migrate-bases" ] || carefully=1
2839                         [ "$cmd" = "rebase" ] || set_topbases $carefully
2840
2841                         _use_ref_cache=
2842                         tg_read_only=1
2843                         _suppress_alt=
2844                         case "$cmd$showing_help" in
2845                                 contains|info|summary|tag)
2846                                         _use_ref_cache=1;;
2847                                 "export")
2848                                         _use_ref_cache=1
2849                                         _suppress_alt=1;;
2850                                 annihilate|create|delete|depend|import|update)
2851                                         tg_read_only=
2852                                         _suppress_alt=1;;
2853                         esac
2854                         [ -z "$_suppress_alt" ] || noalt_setup
2855                         [ -z "$_use_ref_cache" ] || v_create_ref_cache
2856
2857                         fullcmd="${tgname:-tg} $cmd $*"
2858                         fullcmd="${fullcmd% }"
2859                         if [ z"$forcepager" = z"1" ]; then
2860                                 page '. "$TG_INST_CMDDIR"/tg-$isutil$cmd' "$@"
2861                         else
2862                                 . "$TG_INST_CMDDIR"/tg-$isutil$cmd
2863                         fi;;
2864         esac
2865
2866 fi