2 # TopGit - A different patch queue manager
3 # (c) Petr Baudis <pasky@suse.cz> 2008
12 echo "${TG_RECURSIVE}tg: $*"
21 # Make sure we are in the worktree, not under .git; die otherwise
22 ensure_git_repo_or_die()
24 local is_inside_repo is_inside_git_dir
26 is_inside_git_dir=$(git rev-parse --is-inside-git-dir 2>/dev/null) ||
29 case "$is_inside_repo/$is_inside_git_dir" in
30 0*) die "Cannot run outside of a Git repository.";;
31 1/true) die "Cannot run from inside \`.git\` hierarchy, please switch to work-tree.";;
35 # cat_file TOPIC:PATH [FROM]
36 # cat the file PATH from branch TOPIC when FROM is empty.
37 # FROM can be -i or -w, than the file will be from the index or worktree,
38 # respectively. The caller should than ensure that HEAD is TOPIC, to make sense.
44 cat "$root_dir/${path#*:}"
47 # ':file' means cat from index
48 git cat-file blob ":${path#*:}"
51 git cat-file blob "$path"
54 die "Wrong argument to cat_file: '$2'"
59 # get tree for the committed topic
65 # get tree for the base
68 echo "refs/top-bases/$1"
71 # get tree for the index
77 # get tree for the worktree
80 i_tree=$(git write-tree)
82 # the file for --index-output needs to sit next to the
84 : ${GIT_INDEX_FILE:="$git_dir/index"}
85 TMP_INDEX="$(mktemp "${GIT_INDEX_FILE}-tg.XXXXXX")"
86 git read-tree -m $i_tree --index-output="$TMP_INDEX" &&
87 GIT_INDEX_FILE="$TMP_INDEX" &&
88 export GIT_INDEX_FILE &&
89 git diff --name-only -z HEAD |
90 git update-index -z --add --remove --stdin &&
96 # pretty_tree NAME [-b | -i | -w]
97 # Output tree ID of a cleaned-up tree without tg's artifacts.
98 # NAME will be ignored for -i and -w, but needs to be present
103 git ls-tree --full-tree "$(get_tree_$source "$name")" |
104 awk -F ' ' '$2 !~ /^.top/' |
111 hook_call="\"\$($tg --hooks-path)\"/$1 \"\$@\""
112 if [ -f "$git_dir/hooks/$1" ] &&
113 fgrep -q "$hook_call" "$git_dir/hooks/$1"; then
114 # Another job well done!
117 # Prepare incantation
118 if [ -x "$git_dir/hooks/$1" ]; then
119 hook_call="$hook_call"' || exit $?'
121 hook_call="exec $hook_call"
123 # Don't call hook if tg is not installed
124 hook_call="if which \"$tg\" > /dev/null; then $hook_call; fi"
125 # Insert call into the hook
129 [ ! -s "$git_dir/hooks/$1" ] || cat "$git_dir/hooks/$1"
130 } >"$git_dir/hooks/$1+"
131 chmod a+x "$git_dir/hooks/$1+"
132 mv "$git_dir/hooks/$1+" "$git_dir/hooks/$1"
135 # setup_ours (no arguments)
138 if [ ! -s "$git_dir/info/attributes" ] || ! grep -q topmsg "$git_dir/info/attributes"; then
140 echo ".topmsg merge=ours"
141 echo ".topdeps merge=ours"
142 } >>"$git_dir/info/attributes"
144 if ! git config merge.ours.driver >/dev/null; then
145 git config merge.ours.name '"always keep ours" merge driver'
146 git config merge.ours.driver 'touch %A'
150 # measure_branch NAME [BASE]
153 _bname="$1"; _base="$2"
154 [ -n "$_base" ] || _base="refs/top-bases/$_bname"
155 # The caller should've verified $name is valid
156 _commits="$(git rev-list "$_bname" ^"$_base" -- | wc -l)"
157 _nmcommits="$(git rev-list --no-merges "$_bname" ^"$_base" -- | wc -l)"
158 if [ $_commits -gt 1 ]; then
163 echo "$_commits/$_nmcommits $_suffix"
166 # branch_contains B1 B2
167 # Whether B1 is a superset of B2.
170 [ -z "$(git rev-list --max-count=1 ^"$1" "$2" --)" ]
174 # Whether REF is a valid ref name
177 git rev-parse --verify "$@" >/dev/null 2>&1
181 # Whether BRANCH has a remote equivalent (accepts top-bases/ too)
184 [ -n "$base_remote" ] && ref_exists "remotes/$base_remote/$1"
191 # use the merge base in case the base is ahead.
192 mb="$(git merge-base "refs/top-bases/$_name" "$_name")";
194 test "$(git rev-parse "$mb^{tree}")" = "$(git rev-parse "$_name^{tree}")";
198 # Whether REF is a SHA1 (compared to a symbolic name).
201 [ "$(git rev-parse "$1")" = "$1" ]
204 # recurse_deps CMD NAME [BRANCHPATH...]
205 # Recursively eval CMD on all dependencies of NAME.
206 # CMD can refer to $_name for queried branch name,
207 # $_dep for dependency name,
208 # $_depchain for space-seperated branch backtrace,
209 # and the $_dep_is_tgish boolean.
210 # It can modify $_ret to affect the return value
211 # of the whole function.
212 # If recurse_deps() hits missing dependencies, it will append
213 # them to space-separated $missing_deps list and skip them.
214 # remote dependencies are processed if no_remotes is unset.
218 _name="$1"; # no shift
221 _depsfile="$(get_temp tg-depsfile)"
222 # If no_remotes is unset check also our base against remote base.
223 # Checking our head against remote head has to be done in the helper.
224 if test -z "$no_remotes" && has_remote "top-bases/$_name"; then
225 echo "refs/remotes/$base_remote/top-bases/$_name" >>"$_depsfile"
228 # if the branch was annihilated, there exists no .topdeps file
229 if ! branch_annihilated "$_name"; then
230 #TODO: handle nonexisting .topdeps?
231 git cat-file blob "$_name:.topdeps" >>"$_depsfile";
236 if ! ref_exists "$_dep" ; then
238 missing_deps="$missing_deps $_dep"
243 ref_exists "refs/top-bases/$_dep" ||
246 # Shoo shoo, keep our environment alone!
247 [ -z "$_dep_is_tgish" ] ||
248 (recurse_deps "$_cmd" "$_dep" "$@") ||
253 missing_deps="${missing_deps# }"
257 # branch_needs_update
258 # This is a helper function for determining whether given branch
259 # is up-to-date wrt. its dependencies. It expects input as if it
260 # is called as a recurse_deps() helper.
261 # In case the branch does need update, it will echo it together
262 # with the branch backtrace on the output (see needs_update()
263 # description for details) and set $_ret to non-zero.
264 branch_needs_update()
267 if [ -n "$_dep_is_tgish" ]; then
268 if has_remote "$_dep"; then
269 branch_contains "$_dep" "refs/remotes/$base_remote/$_dep" || _dep_base_update=%
271 # This can possibly override the remote check result;
272 # we want to sync with our base first
273 branch_contains "$_dep" "refs/top-bases/$_dep" || _dep_base_update=:
276 if [ -n "$_dep_base_update" ]; then
277 # _dep needs to be synced with its base/remote
278 echo "$_dep_base_update $_dep $_depchain"
280 elif [ -n "$_name" ] && ! branch_contains "refs/top-bases/$_name" "$_dep"; then
281 # Some new commits in _dep
282 echo "$_dep $_depchain"
288 # This function is recursive; it outputs reverse path from NAME
289 # to the branch (e.g. B_DIRTY B1 B2 NAME), one path per line,
290 # inner paths first. Innermost name can be ':' if the head is
291 # not in sync with the base or '%' if the head is not in sync
292 # with the remote (in this order of priority).
293 # It will also return non-zero status if NAME needs update.
294 # If needs_update() hits missing dependencies, it will append
295 # them to space-separated $missing_deps list and skip them.
298 recurse_deps branch_needs_update "$@"
301 # branch_empty NAME [-i | -w]
304 [ "$(pretty_tree "$1" -b)" = "$(pretty_tree "$1" ${2-})" ]
307 # list_deps [-i | -w]
308 # -i/-w apply only to HEAD
315 head="$(git symbolic-ref -q HEAD)" ||
318 git for-each-ref refs/top-bases |
319 while read rev type ref; do
320 name="${ref#refs/top-bases/}"
321 if branch_annihilated "$name"; then
326 [ "refs/heads/$name" = "$head" ] ||
328 cat_file "$name:.topdeps" $from | while read dep; do
330 ref_exists "refs/top-bases/$dep" ||
332 if ! "$dep_is_tgish" || ! branch_annihilated $dep; then
339 # switch_to_base NAME [SEED]
342 _base="refs/top-bases/$1"; _seed="$2"
343 # We have to do all the hard work ourselves :/
344 # This is like git checkout -b "$_base" "$_seed"
345 # (or just git checkout "$_base"),
346 # but does not create a detached HEAD.
347 git read-tree -u -m HEAD "${_seed:-$_base}"
348 [ -z "$_seed" ] || git update-ref "$_base" "$_seed"
349 git symbolic-ref HEAD "$_base"
352 # Show the help messages.
355 if [ -z "$1" ] ; then
356 # This is currently invoked in all kinds of circumstances,
357 # including when the user made a usage error. Should we end up
358 # providing more than a short help message, then we should
360 # Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
362 ## Build available commands list for help output
366 for cmd in "@cmddir@"/tg-*; do
367 ! [ -r "$cmd" ] && continue
368 # strip directory part and "tg-" prefix
369 cmd="$(basename "$cmd")"
375 echo "TopGit v$TG_VERSION - A different patch queue manager"
376 echo "Usage: tg [-r REMOTE] ($cmds|help) ..."
377 elif [ -r "@cmddir@"/tg-$1 ] ; then
379 @cmddir@/tg-$1 -h 2>&1 || :
381 if [ -r "@docdir@/tg-$1.txt" ] ; then
382 cat "@docdir@/tg-$1.txt"
385 echo "`basename $0`: no help for $1" 1>&2
391 # Check whether we are supposed to output the help message
394 # we are being sourced for utility functions, never run help
395 [ -z "$tg__include" ] || return 1
398 while [ -n "$1" ]; do
409 # run help when there was no previous topic, meaning that there where
410 # no arguments at all
423 # Spawn pager process and redirect the rest of our output to it
428 # TG_PAGER = GIT_PAGER | PAGER | less
429 # NOTE: GIT_PAGER='' is significant
430 TG_PAGER=${GIT_PAGER-${PAGER-less}}
432 [ -z "$TG_PAGER" -o "$TG_PAGER" = "cat" ] && return 0
436 export LESS="${LESS:-FRSX}" # as in pager.c:pager_preexec()
438 # setup_pager should be called only once per command
439 pager_fifo="$tg_tmp_dir/pager"
440 mkfifo -m 600 "$pager_fifo"
442 "$TG_PAGER" < "$pager_fifo" &
443 exec > "$pager_fifo" # dup2(pager_fifo.in, 1)
445 # this is needed so e.g. `git diff` will still colorize it's output if
446 # requested in ~/.gitconfig with color.diff=auto
447 export GIT_PAGER_IN_USE=1
449 # atexit(close(1); wait pager)
450 # deliberately overwrites the global EXIT trap
451 trap "exec >&-; rm -rf \"$tg_tmp_dir\"; wait" EXIT
455 # creates a new temporary file (or directory with -d) in the global
456 # temporary directory $tg_tmp_dir with pattern prefix NAME
459 mktemp ${2-} "$tg_tmp_dir/$1.XXXXXX"
465 die "No command directory: '@cmddir@'"
467 # check if we should run help and get the topic while we're at it
468 help_topic="$(should_do_help "$@")" && { do_help "$help_topic"; exit 0; }
470 ensure_git_repo_or_die
475 git_dir="$(git rev-parse --git-dir)"
476 root_dir="$(git rev-parse --show-cdup)"; root_dir="${root_dir:-.}"
477 # Make sure root_dir doesn't end with a trailing slash.
478 root_dir="${root_dir%/}"
479 base_remote="$(git config topgit.remote 2>/dev/null)" || :
481 # make sure merging the .top* files will always behave sanely
483 setup_hook "pre-commit"
484 # create global temporary directories, inside GIT_DIR
485 tg_tmp_dir="$(mktemp -d "$git_dir/tg-tmp.XXXXXX")"
486 trap "rm -rf \"$tg_tmp_dir\"" EXIT
490 # We were sourced from another script for our utility functions;
491 # this is set by hooks. Skip the rest of the file. A simple return doesn't
492 # work as expected in every shell. See http://bugs.debian.org/516188
493 if [ -z "$tg__include" ]; then
495 if [ "$1" = "-r" ]; then
498 echo "Option -r requires an argument." >&2
502 base_remote="$1"; shift
503 tg="$tg -r $base_remote"
507 [ -n "$cmd" ] || { do_help; exit 1; }
515 [ -r "@cmddir@"/tg-$cmd ] || {
516 echo "Unknown subcommand: $cmd" >&2
520 . "@cmddir@"/tg-$cmd;;