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