tg.sh

   1 #!/bin/sh
   2 # TopGit - A different patch queue manager
   3 # (c) Petr Baudis <pasky@suse.cz>  2008
   4 # GPLv2
   5
   6 TG_VERSION=0.8
   7
   8 ## Auxiliary functions
   9
  10 info()
  11 {
  12         echo "${TG_RECURSIVE}tg: $*"
  13 }
  14
  15 die()
  16 {
  17         info "fatal: $*" >&2
  18         exit 1
  19 }
  20
  21 # cat_file TOPIC:PATH [FROM]
  22 # cat the file PATH from branch TOPIC when FROM is empty.
  23 # FROM can be -i or -w, than the file will be from the index or worktree,
  24 # respectively. The caller should than ensure that HEAD is TOPIC, to make sense.
  25 cat_file()
  26 {
  27         path="$1"
  28         case "${2-}" in
  29         -w)
  30                 cat "$root_dir/${path#*:}"
  31                 ;;
  32         -i)
  33                 # ':file' means cat from index
  34                 git cat-file blob ":${path#*:}"
  35                 ;;
  36         '')
  37                 git cat-file blob "$path"
  38                 ;;
  39         *)
  40                 die "Wrong argument to cat_file: '$2'"
  41                 ;;
  42         esac
  43 }
  44
  45 # get tree for the committed topic
  46 get_tree_()
  47 {
  48         echo "$1"
  49 }
  50
  51 # get tree for the base
  52 get_tree_b()
  53 {
  54         echo "refs/top-bases/$1"
  55 }
  56
  57 # get tree for the index
  58 get_tree_i()
  59 {
  60         git write-tree
  61 }
  62
  63 # get tree for the worktree
  64 get_tree_w()
  65 {
  66         i_tree=$(git write-tree)
  67         (
  68                 # the file for --index-output needs to sit next to the
  69                 # current index file
  70                 : ${GIT_INDEX_FILE:="$git_dir/index"}
  71                 TMP_INDEX="$(mktemp "${GIT_INDEX_FILE}-tg.XXXXXX")"
  72                 git read-tree -m $i_tree --index-output="$TMP_INDEX" &&
  73                 GIT_INDEX_FILE="$TMP_INDEX" &&
  74                 export GIT_INDEX_FILE &&
  75                 git diff --name-only -z HEAD |
  76                         git update-index -z --add --remove --stdin &&
  77                 git write-tree &&
  78                 rm -f "$TMP_INDEX"
  79         )
  80 }
  81
  82 # pretty_tree NAME [-b | -i | -w]
  83 # Output tree ID of a cleaned-up tree without tg's artifacts.
  84 # NAME will be ignored for -i and -w, but needs to be present
  85 pretty_tree()
  86 {
  87         name=$1
  88         source=${2#?}
  89         git ls-tree --full-tree "$(get_tree_$source "$name")" |
  90                 awk -F '        ' '$2 !~ /^.top/' |
  91                 git mktree
  92 }
  93
  94 # setup_hook NAME
  95 setup_hook()
  96 {
  97         hook_call="\"\$($tg --hooks-path)\"/$1 \"\$@\""
  98         if [ -f "$git_dir/hooks/$1" ] &&
  99            fgrep -q "$hook_call" "$git_dir/hooks/$1"; then
 100                 # Another job well done!
 101                 return
 102         fi
 103         # Prepare incantation
 104         if [ -x "$git_dir/hooks/$1" ]; then
 105                 hook_call="$hook_call"' || exit $?'
 106         else
 107                 hook_call="exec $hook_call"
 108         fi
 109         # Don't call hook if tg is not installed
 110         hook_call="if which \"$tg\" > /dev/null; then $hook_call; fi"
 111         # Insert call into the hook
 112         {
 113                 echo "#!/bin/sh"
 114                 echo "$hook_call"
 115                 [ ! -s "$git_dir/hooks/$1" ] || cat "$git_dir/hooks/$1"
 116         } >"$git_dir/hooks/$1+"
 117         chmod a+x "$git_dir/hooks/$1+"
 118         mv "$git_dir/hooks/$1+" "$git_dir/hooks/$1"
 119 }
 120
 121 # setup_ours (no arguments)
 122 setup_ours()
 123 {
 124         if [ ! -s "$git_dir/info/attributes" ] || ! grep -q topmsg "$git_dir/info/attributes"; then
 125                 {
 126                         echo ".topmsg   merge=ours"
 127                         echo ".topdeps  merge=ours"
 128                 } >>"$git_dir/info/attributes"
 129         fi
 130         if ! git config merge.ours.driver >/dev/null; then
 131                 git config merge.ours.name '"always keep ours" merge driver'
 132                 git config merge.ours.driver 'touch %A'
 133         fi
 134 }
 135
 136 # measure_branch NAME [BASE]
 137 measure_branch()
 138 {
 139         _bname="$1"; _base="$2"
 140         [ -n "$_base" ] || _base="refs/top-bases/$_bname"
 141         # The caller should've verified $name is valid
 142         _commits="$(git rev-list "$_bname" ^"$_base" -- | wc -l)"
 143         _nmcommits="$(git rev-list --no-merges "$_bname" ^"$_base" -- | wc -l)"
 144         if [ $_commits -gt 1 ]; then
 145                 _suffix="commits"
 146         else
 147                 _suffix="commit"
 148         fi
 149         echo "$_commits/$_nmcommits $_suffix"
 150 }
 151
 152 # branch_contains B1 B2
 153 # Whether B1 is a superset of B2.
 154 branch_contains()
 155 {
 156         [ -z "$(git rev-list --max-count=1 ^"$1" "$2" --)" ]
 157 }
 158
 159 # ref_exists REF
 160 # Whether REF is a valid ref name
 161 ref_exists()
 162 {
 163         git rev-parse --verify "$@" >/dev/null 2>&1
 164 }
 165
 166 # has_remote BRANCH
 167 # Whether BRANCH has a remote equivalent (accepts top-bases/ too)
 168 has_remote()
 169 {
 170         [ -n "$base_remote" ] && ref_exists "remotes/$base_remote/$1"
 171 }
 172
 173 branch_annihilated()
 174 {
 175         _name="$1";
 176
 177         # use the merge base in case the base is ahead.
 178         mb="$(git merge-base "refs/top-bases/$_name" "$_name" 2> /dev/null)";
 179
 180         test -z "$mb" || test "$(git rev-parse "$mb^{tree}")" = "$(git rev-parse "$_name^{tree}")";
 181 }
 182
 183 # is_sha1 REF
 184 # Whether REF is a SHA1 (compared to a symbolic name).
 185 is_sha1()
 186 {
 187         [ "$(git rev-parse "$1")" = "$1" ]
 188 }
 189
 190 # recurse_deps CMD NAME [BRANCHPATH...]
 191 # Recursively eval CMD on all dependencies of NAME.
 192 # CMD can refer to $_name for queried branch name,
 193 # $_dep for dependency name,
 194 # $_depchain for space-seperated branch backtrace,
 195 # $_dep_missing boolean to check whether $_dep is present
 196 # and the $_dep_is_tgish boolean.
 197 # It can modify $_ret to affect the return value
 198 # of the whole function.
 199 # If recurse_deps() hits missing dependencies, it will append
 200 # them to space-separated $missing_deps list and skip them
 201 # affter calling CMD with _dep_missing set.
 202 # remote dependencies are processed if no_remotes is unset.
 203 recurse_deps()
 204 {
 205         _cmd="$1"; shift
 206         _name="$1"; # no shift
 207         _depchain="$*"
 208
 209         _depsfile="$(get_temp tg-depsfile)"
 210         # If no_remotes is unset check also our base against remote base.
 211         # Checking our head against remote head has to be done in the helper.
 212         if test -z "$no_remotes" && has_remote "top-bases/$_name"; then
 213                 echo "refs/remotes/$base_remote/top-bases/$_name" >>"$_depsfile"
 214         fi
 215
 216         # if the branch was annihilated, there exists no .topdeps file
 217         if ! branch_annihilated "$_name"; then
 218                 #TODO: handle nonexisting .topdeps?
 219                 git cat-file blob "$_name:.topdeps" >>"$_depsfile";
 220         fi;
 221
 222         _ret=0
 223         while read _dep; do
 224                 _dep_missing=
 225                 if ! ref_exists "$_dep" ; then
 226                         # All hope is lost. Inform driver and continue
 227                         missing_deps="$missing_deps $_dep"
 228                         _dep_missing=1
 229                         eval "$_cmd"
 230                         continue
 231                 fi
 232
 233                 _dep_is_tgish=1
 234                 ref_exists "refs/top-bases/$_dep"  ||
 235                         _dep_is_tgish=
 236
 237                 # Shoo shoo, keep our environment alone!
 238                 [ -z "$_dep_is_tgish" ] ||
 239                         (recurse_deps "$_cmd" "$_dep" "$@") ||
 240                         _ret=$?
 241
 242                 eval "$_cmd"
 243         done <"$_depsfile"
 244         missing_deps="${missing_deps# }"
 245         return $_ret
 246 }
 247
 248 # branch_needs_update
 249 # This is a helper function for determining whether given branch
 250 # is up-to-date wrt. its dependencies. It expects input as if it
 251 # is called as a recurse_deps() helper.
 252 # In case the branch does need update, it will echo it together
 253 # with the branch backtrace on the output (see needs_update()
 254 # description for details) and set $_ret to non-zero.
 255 branch_needs_update()
 256 {
 257         if [ -n "$_dep_missing" ]; then
 258                 echo "! $_depchain"
 259                 return 0
 260         fi
 261
 262         _dep_base_update=
 263         if [ -n "$_dep_is_tgish" ]; then
 264                 if has_remote "$_dep"; then
 265                         branch_contains "$_dep" "refs/remotes/$base_remote/$_dep" || _dep_base_update=%
 266                 fi
 267                 # This can possibly override the remote check result;
 268                 # we want to sync with our base first
 269                 branch_contains "$_dep" "refs/top-bases/$_dep" || _dep_base_update=:
 270         fi
 271
 272         if [ -n "$_dep_base_update" ]; then
 273                 # _dep needs to be synced with its base/remote
 274                 echo "$_dep_base_update $_dep $_depchain"
 275                 _ret=1
 276         elif [ -n "$_name" ] && ! branch_contains "refs/top-bases/$_name" "$_dep"; then
 277                 # Some new commits in _dep
 278                 echo "$_dep $_depchain"
 279                 _ret=1
 280         fi
 281 }
 282
 283 # needs_update NAME
 284 # This function is recursive; it outputs reverse path from NAME
 285 # to the branch (e.g. B_DIRTY B1 B2 NAME), one path per line,
 286 # inner paths first. Innermost name can be ':' if the head is
 287 # not in sync with the base, '%' if the head is not in sync
 288 # with the remote (in this order of priority) or '!' if depednecy
 289 # is missing.
 290 # It will also return non-zero status if NAME needs update.
 291 # If needs_update() hits missing dependencies, it will append
 292 # them to space-separated $missing_deps list and skip them.
 293 needs_update()
 294 {
 295         recurse_deps branch_needs_update "$@"
 296 }
 297
 298 # branch_empty NAME [-i | -w]
 299 branch_empty()
 300 {
 301         [ "$(pretty_tree "$1" -b)" = "$(pretty_tree "$1" ${2-})" ]
 302 }
 303
 304 # list_deps [-i | -w]
 305 # -i/-w apply only to HEAD
 306 list_deps()
 307 {
 308         local head
 309         local head_from
 310         local from
 311         head_from=${1-}
 312         head="$(git symbolic-ref -q HEAD)" ||
 313                 head="..detached.."
 314
 315         git for-each-ref refs/top-bases |
 316                 while read rev type ref; do
 317                         name="${ref#refs/top-bases/}"
 318                         if branch_annihilated "$name"; then
 319                                 continue;
 320                         fi
 321
 322                         from=$head_from
 323                         [ "refs/heads/$name" = "$head" ] ||
 324                                 from=
 325                         cat_file "$name:.topdeps" $from | while read dep; do
 326                                 dep_is_tgish=true
 327                                 ref_exists "refs/top-bases/$dep"  ||
 328                                         dep_is_tgish=false
 329                                 if ! "$dep_is_tgish" || ! branch_annihilated $dep; then
 330                                         echo "$name $dep"
 331                                 fi
 332                         done
 333                 done
 334 }
 335
 336 # switch_to_base NAME [SEED]
 337 switch_to_base()
 338 {
 339         _base="refs/top-bases/$1"; _seed="$2"
 340         # We have to do all the hard work ourselves :/
 341         # This is like git checkout -b "$_base" "$_seed"
 342         # (or just git checkout "$_base"),
 343         # but does not create a detached HEAD.
 344         git read-tree -u -m HEAD "${_seed:-$_base}"
 345         [ -z "$_seed" ] || git update-ref "$_base" "$_seed"
 346         git symbolic-ref HEAD "$_base"
 347 }
 348
 349 # Show the help messages.
 350 do_help()
 351 {
 352         if [ -z "$1" ] ; then
 353                 # This is currently invoked in all kinds of circumstances,
 354                 # including when the user made a usage error. Should we end up
 355                 # providing more than a short help message, then we should
 356                 # differentiate.
 357                 # Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
 358
 359                 ## Build available commands list for help output
 360
 361                 cmds=
 362                 sep=
 363                 for cmd in "@cmddir@"/tg-*; do
 364                         ! [ -r "$cmd" ] && continue
 365                         # strip directory part and "tg-" prefix
 366                         cmd="$(basename "$cmd")"
 367                         cmd="${cmd#tg-}"
 368                         cmds="$cmds$sep$cmd"
 369                         sep="|"
 370                 done
 371
 372                 echo "TopGit v$TG_VERSION - A different patch queue manager"
 373                 echo "Usage: tg [-r REMOTE] ($cmds|help) ..."
 374         elif [ -r "@cmddir@"/tg-$1 ] ; then
 375                 setup_pager
 376                 @cmddir@/tg-$1 -h 2>&1 || :
 377                 echo
 378                 if [ -r "@sharedir@/tg-$1.txt" ] ; then
 379                         cat "@sharedir@/tg-$1.txt"
 380                 fi
 381         else
 382                 echo "`basename $0`: no help for $1" 1>&2
 383                 do_help
 384                 exit 1
 385         fi
 386 }
 387
 388 ## Pager stuff
 389
 390 # isatty FD
 391 isatty()
 392 {
 393         test -t $1
 394 }
 395
 396 # setup_pager
 397 # Spawn pager process and redirect the rest of our output to it
 398 setup_pager()
 399 {
 400         isatty 1 || return 0
 401
 402         # TG_PAGER = GIT_PAGER | PAGER | less
 403         # NOTE: GIT_PAGER='' is significant
 404         TG_PAGER=${GIT_PAGER-${PAGER-less}}
 405
 406         [ -z "$TG_PAGER"  -o  "$TG_PAGER" = "cat" ]  && return 0
 407
 408
 409         # now spawn pager
 410         export LESS="${LESS:-FRSX}"     # as in pager.c:pager_preexec()
 411
 412         # setup_pager should be called only once per command
 413         pager_fifo="${tg_tmp_dir:-${HOME}}/.tg-pager"
 414         mkfifo -m 600 "$pager_fifo"
 415
 416         "$TG_PAGER" < "$pager_fifo" &
 417         exec > "$pager_fifo"            # dup2(pager_fifo.in, 1)
 418
 419         # this is needed so e.g. `git diff` will still colorize it's output if
 420         # requested in ~/.gitconfig with color.diff=auto
 421         export GIT_PAGER_IN_USE=1
 422
 423         # atexit(close(1); wait pager)
 424         # deliberately overwrites the global EXIT trap
 425         trap "exec >&-; rm -rf \"${tg_tmp_dir:-${HOME}/.tg-pager}\"; wait" EXIT
 426 }
 427
 428 # get_temp NAME [-d]
 429 # creates a new temporary file (or directory with -d) in the global
 430 # temporary directory $tg_tmp_dir with pattern prefix NAME
 431 get_temp()
 432 {
 433         mktemp ${2-} "$tg_tmp_dir/$1.XXXXXX"
 434 }
 435
 436 ## Startup
 437
 438 [ -d "@cmddir@" ] ||
 439         die "No command directory: '@cmddir@'"
 440
 441 ## Initial setup
 442
 443 cmd="$1"
 444 [ -z "$tg__include" ] || cmd="include" # ensure setup happens
 445 case "$cmd" in
 446 help|--help|-h)
 447         :;;
 448 *)
 449         if [ -n "$cmd" ]; then
 450             set -e
 451             git_dir="$(git rev-parse --git-dir)"
 452             root_dir="$(git rev-parse --show-cdup)"; root_dir="${root_dir:-.}"
 453 # Make sure root_dir doesn't end with a trailing slash.
 454             root_dir="${root_dir%/}"
 455             base_remote="$(git config topgit.remote 2>/dev/null)" || :
 456             tg="tg"
 457 # make sure merging the .top* files will always behave sanely
 458             setup_ours
 459             setup_hook "pre-commit"
 460             # create global temporary directories, inside GIT_DIR
 461             tg_tmp_dir="$(mktemp -d "$git_dir/tg-tmp.XXXXXX")"
 462             trap "rm -rf \"$tg_tmp_dir\"" EXIT
 463         fi
 464 esac
 465
 466 ## Dispatch
 467
 468 # We were sourced from another script for our utility functions;
 469 # this is set by hooks.  Skip the rest of the file.  A simple return doesn't
 470 # work as expected in every shell.  See http://bugs.debian.org/516188
 471 if [ -z "$tg__include" ]; then
 472
 473 if [ "$1" = "-r" ]; then
 474         shift
 475         if [ -z "$1" ]; then
 476                 echo "Option -r requires an argument." >&2
 477                 do_help
 478                 exit 1
 479         fi
 480         base_remote="$1"; shift
 481         tg="$tg -r $base_remote"
 482 fi
 483
 484 [ -n "$cmd" ] || { do_help; exit 1; }
 485 shift
 486
 487 case "$cmd" in
 488 help|--help|-h)
 489         do_help "$1"
 490         exit 0;;
 491 --hooks-path)
 492         # Internal command
 493         echo "@hooksdir@";;
 494 *)
 495         [ -r "@cmddir@"/tg-$cmd ] || {
 496                 echo "Unknown subcommand: $cmd" >&2
 497                 do_help
 498                 exit 1
 499         }
 500         . "@cmddir@"/tg-$cmd;;
 501 esac
 502
 503 fi
 504
 505 # vim:noet