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