2 # TopGit - A different patch queue manager
3 # (C) Petr Baudis <pasky@suse.cz> 2008
4 # (C) Kyle J. McKay <mackyle@gmail.com> 2014,2015
9 # Update if you add any code that requires a newer version of git
10 GIT_MINIMUM_VERSION
=1.7.7.2
14 octet
='[0-9a-f][0-9a-f]'
15 octet4
="$octet$octet$octet$octet"
16 octet19
="$octet4$octet4$octet4$octet4$octet$octet$octet"
17 octet20
="$octet4$octet4$octet4$octet4$octet4"
19 ## Auxiliary functions
23 echo "${TG_RECURSIVE}${tgname:-tg}: $*"
40 echo "$3" |
tr "${separator}" '\n' |
(for l
in $
(echo "$2"|
tr "${separator}" ' '); do
42 [ $l -ge $r ] ||
return 1
43 [ $l -gt $r ] && return 0
48 git_ver
="$(git version | sed -e 's/^[^0-9][^0-9]*//')"
49 compare_versions .
"${git_ver%%[!0-9.]*}" "${GIT_MINIMUM_VERSION}" \
50 || die
"git version >= ${GIT_MINIMUM_VERSION} required"
53 case "$1" in version|
--version|
-V)
54 echo "TopGit version $TG_VERSION"
59 [ "$1" = "precheck" ] && exit 0
65 if [ -f "$tg_tmp_dir/cached/$1/.tpd" ]; then
67 while IFS
= read -r _line ||
[ -n "$_line" ]; do
68 printf '%s\n' "$_line"
69 done <"$tg_tmp_dir/cached/$1/.tpd"
72 [ -d "$tg_tmp_dir/cached/$1" ] || mkdir
-p "$tg_tmp_dir/cached/$1" 2>/dev
/null ||
:
73 if [ -d "$tg_tmp_dir/cached/$1" ]; then
74 git cat-file blob
"$1:.topdeps" 2>/dev
/null
>"$tg_tmp_dir/cached/$1/.tpd"
76 while IFS
= read -r _line ||
[ -n "$_line" ]; do
77 printf '%s\n' "$_line"
78 done <"$tg_tmp_dir/cached/$1/.tpd"
80 git cat-file blob
"$1:.topdeps" 2>/dev
/null
84 # cat_file TOPIC:PATH [FROM]
85 # cat the file PATH from branch TOPIC when FROM is empty.
86 # FROM can be -i or -w, than the file will be from the index or worktree,
87 # respectively. The caller should than ensure that HEAD is TOPIC, to make sense.
93 cat "$root_dir/${path#*:}"
96 # ':file' means cat from index
97 git cat-file blob
":${path#*:}"
102 cat_deps
"${path%:.topdeps}"
105 git cat-file blob
"$path"
110 die
"Wrong argument to cat_file: '$2'"
115 # get tree for the committed topic
121 # get tree for the base
124 echo "refs/top-bases/$1"
127 # get tree for the index
133 # get tree for the worktree
136 i_tree
=$
(git write-tree
)
138 # the file for --index-output needs to sit next to the
141 : ${GIT_INDEX_FILE:="$git_dir/index"}
142 TMP_INDEX
="$(mktemp "${GIT_INDEX_FILE}-tg.XXXXXX
")"
143 git read-tree
-m $i_tree --index-output="$TMP_INDEX" &&
144 GIT_INDEX_FILE
="$TMP_INDEX" &&
145 export GIT_INDEX_FILE
&&
146 git
diff --name-only -z HEAD |
147 git update-index
-z --add --remove --stdin &&
153 # strip_ref "$(git symbolic-ref HEAD)"
154 # Output will have a leading refs/heads/ or refs/top-bases/ stripped if present
159 echo "${1#refs/heads/}"
162 echo "${1#refs/top-bases/}"
169 # pretty_tree NAME [-b | -i | -w]
170 # Output tree ID of a cleaned-up tree without tg's artifacts.
171 # NAME will be ignored for -i and -w, but needs to be present
176 git ls-tree
--full-tree "$(get_tree_$source "$name")" |
177 awk -F ' ' '$2 !~ /^.top/' |
184 tgname
="$(basename "$0")"
185 hook_call
="\"\$(\"$tgname\" --hooks-path)\"/$1 \"\$@\""
186 if [ -f "$git_dir/hooks/$1" ] && fgrep
-q "$hook_call" "$git_dir/hooks/$1"; then
187 # Another job well done!
190 # Prepare incantation
191 if [ -x "$git_dir/hooks/$1" ]; then
192 hook_call
="$hook_call"' || exit $?'
194 hook_call
="exec $hook_call"
196 # Don't call hook if tg is not installed
197 hook_call
="if which \"$tgname\" > /dev/null; then $hook_call; fi"
198 # Insert call into the hook
202 [ ! -s "$git_dir/hooks/$1" ] ||
cat "$git_dir/hooks/$1"
203 } >"$git_dir/hooks/$1+"
204 chmod a
+x
"$git_dir/hooks/$1+"
205 mv "$git_dir/hooks/$1+" "$git_dir/hooks/$1"
208 # setup_ours (no arguments)
211 if [ ! -s "$git_dir/info/attributes" ] ||
! grep -q topmsg
"$git_dir/info/attributes"; then
212 [ -d "$git_dir/info" ] || mkdir
"$git_dir/info"
214 echo ".topmsg merge=ours"
215 echo ".topdeps merge=ours"
216 } >>"$git_dir/info/attributes"
218 if ! git config merge.ours.driver
>/dev
/null
; then
219 git config merge.ours.name
'"always keep ours" merge driver'
220 git config merge.ours.driver
'touch %A'
224 # measure_branch NAME [BASE]
227 _bname
="$1"; _base
="$2"
228 [ -n "$_base" ] || _base
="refs/top-bases/$_bname"
229 # The caller should've verified $name is valid
230 _commits
="$(git rev-list "$_bname" ^"$_base" -- | wc_l)"
231 _nmcommits
="$(git rev-list --no-merges "$_bname" ^"$_base" -- | wc_l)"
232 if [ $_commits -ne 1 ]; then
237 echo "$_commits/$_nmcommits $_suffix"
240 # branch_contains B1 B2
241 # Whether B1 is a superset of B2.
244 [ -z "$(git rev-list --max-count=1 ^"$1" "$2" --)" ]
248 # Whether REF is a valid ref name
253 { read -r _result
<"$tg_tmp_dir/cached/$1/.ref"; } 2>/dev
/null ||
:
254 [ -z "$_result" ] ||
return $_result;
255 git rev-parse
--verify "$@" >/dev
/null
2>&1
257 [ -d "$tg_tmp_dir/cached/$1" ] || mkdir
-p "$tg_tmp_dir/cached/$1" 2>/dev
/null
&& \
258 echo $_result >"$tg_tmp_dir/cached/$1/.ref" 2>/dev
/null ||
:
263 # Runs git rev-parse REF^{tree}
267 if [ -f "$tg_tmp_dir/cached/$1/.rpt" ]; then
268 if IFS
= read -r _result
<"$tg_tmp_dir/cached/$1/.rpt"; then
269 printf '%s\n' "$_result"
274 [ -d "$tg_tmp_dir/cached/$1" ] || mkdir
-p "$tg_tmp_dir/cached/$1" 2>/dev
/null ||
:
275 if [ -d "$tg_tmp_dir/cached/$1" ]; then
276 git rev-parse
"$1^{tree}" >"$tg_tmp_dir/cached/$1/.rpt" 2>/dev
/null ||
:
277 if IFS
= read -r _result
<"$tg_tmp_dir/cached/$1/.rpt"; then
278 printf '%s\n' "$_result"
283 git rev-parse
"$1^{tree}" 2>/dev
/null
287 # Whether BRANCH has a remote equivalent (accepts top-bases/ too)
290 [ -n "$base_remote" ] && ref_exists
"remotes/$base_remote/$1"
293 # Return the verified TopGit branch name or die with an error.
294 # As a convenience, if HEAD is given and HEAD is a symbolic ref to
295 # refs/heads/... then ... will be verified instead.
296 # if "$2" = "-f" then return an error rather than dying.
297 verify_topgit_branch
()
301 _verifyname
="${1#refs/heads/}"
304 _verifyname
="${1#refs/top-bases/}"
307 _verifyname
="$(git symbolic-ref HEAD 2>/dev/null || :)"
308 [ -n "$_verifyname" ] || die
"HEAD is not a symbolic ref"
309 case "$_verifyname" in refs
/heads
/*) :;; *)
310 [ "$2" != "-f" ] ||
return 1
311 die
"HEAD is not a symbolic ref to the refs/heads namespace"
313 _verifyname
="${_verifyname#refs/heads/}"
319 if ! git rev-parse
--short --verify "refs/heads/$_verifyname" >/dev
/null
2>&1; then
320 [ "$2" != "-f" ] ||
return 1
323 if ! git rev-parse
--short --verify "refs/top-bases/$_verifyname" >/dev
/null
2>&1; then
324 [ "$2" != "-f" ] ||
return 1
325 die
"not a TopGit-controlled branch"
327 printf '%s' "$_verifyname"
336 { read -r _result
<"$tg_tmp_dir/cached/$_branch_name/.ann"; } 2>/dev
/null ||
:
337 [ -z "$_result" ] ||
return $_result;
339 # use the merge base in case the base is ahead.
340 mb
="$(git merge-base "refs
/top-bases
/$_branch_name" "$_branch_name" 2> /dev/null)";
342 test -z "$mb" ||
test "$(rev_parse_tree "$mb")" = "$(rev_parse_tree "$_branch_name")"
344 [ -d "$tg_tmp_dir/cached/$_branch_name" ] || mkdir
-p "$tg_tmp_dir/cached/$_branch_name" 2>/dev
/null
&& \
345 echo $_result >"$tg_tmp_dir/cached/$_branch_name/.ann" 2>/dev
/null ||
:
349 non_annihilated_branches
()
352 git for-each-ref
${_pattern:-refs/top-bases} |
353 while read rev type ref
; do
354 name
="${ref#refs/top-bases/}"
355 if branch_annihilated
"$name"; then
362 # Make sure our tree is clean
365 git update-index
--ignore-submodules --refresh ||
366 die
"the working directory has uncommitted changes (see above) - first commit or reset them"
367 [ -z "$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)" ] ||
368 die
"the index has uncommited changes"
372 # Whether REF is a SHA1 (compared to a symbolic name).
375 case "$1" in $octet20) return 0;; esac
379 # recurse_deps_internal NAME [BRANCHPATH...]
380 # get recursive list of dependencies with leading 0 if branch exists 1 if missing
381 # followed by a 1 if the branch is "tgish" or a 0 if not
382 # then the branch name followed by its depedency chain (which might be empty)
383 # An output line might look like this:
384 # 0 1 t/foo/leaf t/foo/int t/stage
385 # If no_remotes is non-empty, exclude remotes
386 # If recurse_preorder is non-empty, do a preorder rather than postorder traversal
387 recurse_deps_internal
()
389 if ! ref_exists
"$1"; then
390 [ -z "$2" ] ||
echo "1 0 $*"
394 # If no_remotes is unset also check our base against remote base.
395 # Checking our head against remote head has to be done in the helper.
396 if test -z "$no_remotes" && has_remote
"top-bases/$1"; then
397 echo "0 0 refs/remotes/$base_remote/top-bases/$1 $*"
401 if ref_exists
"refs/top-bases/$1"; then
403 [ -z "$recurse_preorder" -o -z "$2" ] ||
echo "0 $_is_tgish $*"
405 # if the branch was annihilated, it is considered to have no dependencies
406 if ! branch_annihilated
"$1"; then
407 #TODO: handle nonexisting .topdeps?
409 while read _dname
; do
410 # Shoo shoo, leave our environment alone!
411 (recurse_deps_internal
"$_dname" "$@")
416 [ -n "$recurse_preorder" -o -z "$2" ] ||
echo "0 $_is_tgish $*"
420 # helper for recurse_deps so that a return statement executed inside CMD
421 # does not return from recurse_deps. This shouldn't be necessary, but it
422 # seems that it actually is.
428 # recurse_deps CMD NAME [BRANCHPATH...]
429 # Recursively eval CMD on all dependencies of NAME.
430 # Dependencies are visited in topological order.
431 # CMD can refer to $_name for queried branch name,
432 # $_dep for dependency name,
433 # $_depchain for space-seperated branch backtrace,
434 # $_dep_missing boolean to check whether $_dep is present
435 # and the $_dep_is_tgish boolean.
436 # It can modify $_ret to affect the return value
437 # of the whole function.
438 # If recurse_deps() hits missing dependencies, it will append
439 # them to space-separated $missing_deps list and skip them
440 # after calling CMD with _dep_missing set.
441 # remote dependencies are processed if no_remotes is unset.
446 _depsfile
="$(get_temp tg-depsfile)"
447 recurse_deps_internal
"$@" >>"$_depsfile"
450 while read _ismissing _istgish _dep _name _deppath
; do
451 _depchain
="$_name${_deppath:+ $_deppath}"
453 [ "$_istgish" = "0" ] || _dep_is_tgish
=1
455 if [ "$_ismissing" != "0" ]; then
457 case " $missing_deps " in *" $_dep "*) :;; *)
458 missing_deps
="${missing_deps:+$missing_deps }$_dep"
467 # branch_needs_update
468 # This is a helper function for determining whether given branch
469 # is up-to-date wrt. its dependencies. It expects input as if it
470 # is called as a recurse_deps() helper.
471 # In case the branch does need update, it will echo it together
472 # with the branch backtrace on the output (see needs_update()
473 # description for details) and set $_ret to non-zero.
474 branch_needs_update
()
476 if [ -n "$_dep_missing" ]; then
477 echo "! $_dep $_depchain"
482 if [ -n "$_dep_is_tgish" ]; then
483 branch_annihilated
"$_dep" && return 0
485 if has_remote
"$_dep"; then
486 branch_contains
"$_dep" "refs/remotes/$base_remote/$_dep" || _dep_base_update
=%
488 # This can possibly override the remote check result;
489 # we want to sync with our base first
490 branch_contains
"$_dep" "refs/top-bases/$_dep" || _dep_base_update
=:
493 if [ -n "$_dep_base_update" ]; then
494 # _dep needs to be synced with its base/remote
495 echo "$_dep_base_update $_dep $_depchain"
497 elif [ -n "$_name" ] && ! branch_contains
"refs/top-bases/$_name" "$_dep"; then
498 # Some new commits in _dep
499 echo "$_dep $_depchain"
505 # This function is recursive; it outputs reverse path from NAME
506 # to the branch (e.g. B_DIRTY B1 B2 NAME), one path per line,
507 # inner paths first. Innermost name can be ':' if the head is
508 # not in sync with the base, '%' if the head is not in sync
509 # with the remote (in this order of priority) or '!' if depednecy
511 # It will also return non-zero status if NAME needs update.
512 # If needs_update() hits missing dependencies, it will append
513 # them to space-separated $missing_deps list and skip them.
516 recurse_deps branch_needs_update
"$@"
519 # branch_empty NAME [-i | -w]
522 [ "$(pretty_tree "$1" -b)" = "$(pretty_tree "$1" $2)" ]
525 # list_deps [-i | -w]
526 # -i/-w apply only to HEAD
530 head="$(git symbolic-ref -q HEAD)" ||
533 git for-each-ref refs
/top-bases |
534 while read rev type ref
; do
535 name
="${ref#refs/top-bases/}"
536 if branch_annihilated
"$name"; then
541 [ "refs/heads/$name" = "$head" ] ||
543 cat_file
"$name:.topdeps" $from |
while read dep
; do
545 ref_exists
"refs/top-bases/$dep" ||
547 if ! "$dep_is_tgish" ||
! branch_annihilated
$dep; then
554 # switch_to_base NAME [SEED]
557 _base
="refs/top-bases/$1"; _seed
="$2"
558 # We have to do all the hard work ourselves :/
559 # This is like git checkout -b "$_base" "$_seed"
560 # (or just git checkout "$_base"),
561 # but does not create a detached HEAD.
562 git read-tree
-u -m HEAD
"${_seed:-$_base}"
563 [ -z "$_seed" ] || git update-ref
"$_base" "$_seed"
564 git symbolic-ref HEAD
"$_base"
567 # Show the help messages.
571 if [ "$1" = "-w" ]; then
575 if [ -z "$1" ] ; then
576 # This is currently invoked in all kinds of circumstances,
577 # including when the user made a usage error. Should we end up
578 # providing more than a short help message, then we should
580 # Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
582 ## Build available commands list for help output
586 for cmd
in "@cmddir@"/tg-
*; do
587 ! [ -r "$cmd" ] && continue
588 # strip directory part and "tg-" prefix
589 cmd
="$(basename "$cmd")"
595 echo "TopGit version $TG_VERSION - A different patch queue manager"
596 echo "Usage: $tgname ( help [-w] [<command>] | [-C <dir>] [-r <remote>] ($cmds) ...)"
597 echo "Use \"$tgdisplaydir$tgname help tg\" for overview of TopGit"
598 elif [ -r "@cmddir@"/tg-
$1 -o -r "@sharedir@/tg-$1.txt" ] ; then
599 if [ -n "$_www" ]; then
601 if ! [ -r "@sharedir@/topgit.html" ]; then
602 echo "`basename $0`: missing html help file:" \
603 "@sharedir@/topgit.html" 1>&2
606 if ! [ -r "@sharedir@/tg-$1.html" ]; then
607 echo "`basename $0`: missing html help file:" \
608 "@sharedir@/tg-$1.html" 1>&2
611 if [ -n "$nohtml" ]; then
612 echo "`basename $0`: use" \
613 "\"`basename $0` help $1\" instead" 1>&2
616 git web--browse
-c help.browser
"@sharedir@/tg-$1.html"
621 if [ -r "@cmddir@"/tg-
$1 ] ; then
622 "@cmddir@"/tg-
$1 -h 2>&1 ||
:
625 if [ -r "@sharedir@/tg-$1.txt" ] ; then
626 cat "@sharedir@/tg-$1.txt"
630 echo "`basename $0`: no help for $1" 1>&2
644 # pass "diff" to get pager.diff
645 # if pager.$1 is a boolean false returns cat
646 # if set to true or unset fails
647 # otherwise succeeds and returns the value
650 if _x
="$(git config --bool "pager.
$1" 2>/dev/null)"; then
651 [ "$_x" != "true" ] ||
return 1
655 if _x
="$(git config "pager.
$1" 2>/dev/null)"; then
663 # Set TG_PAGER to a valid executable
664 # After calling, code to be paged should be surrounded with {...} | eval "$TG_PAGER"
665 # Preference is (same as Git):
667 # 2. pager.$USE_PAGER_TYPE (but only if USE_PAGER_TYPE is set and so is pager.$USE_PAGER_TYPE)
668 # 3. core.pager (only if set)
673 isatty
1 ||
{ TG_PAGER
=cat; return 0; }
675 if [ -z "$TG_PAGER_IN_USE" ]; then
676 # TG_PAGER = GIT_PAGER | PAGER | less
677 # NOTE: GIT_PAGER='' is significant
678 if [ -n "${GIT_PAGER+set}" ]; then
679 TG_PAGER
="$GIT_PAGER"
680 elif [ -n "$USE_PAGER_TYPE" ] && _dp
="$(get_pager "$USE_PAGER_TYPE")"; then
682 elif _cp
="$(git config core.pager 2>/dev/null)"; then
684 elif [ -n "${PAGER+set}" ]; then
694 # Set pager default environment variables
695 # see pager.c:setup_pager
696 if [ -z "${LESS+set}" ]; then
699 if [ -z "${LV+set}" ]; then
703 # this is needed so e.g. `git diff` will still colorize it's output if
704 # requested in ~/.gitconfig with color.diff=auto
705 export GIT_PAGER_IN_USE
=1
707 # this is needed so we don't get nested pagers
708 export TG_PAGER_IN_USE
=1
712 # creates a new temporary file (or directory with -d) in the global
713 # temporary directory $tg_tmp_dir with pattern prefix NAME
716 mktemp
$2 "$tg_tmp_dir/$1.XXXXXX"
722 # suppress the merge log editor feature since git 1.7.10
724 export GIT_MERGE_AUTOEDIT
=no
725 git_dir
="$(git rev-parse --git-dir)"
726 root_dir
="$(git rev-parse --show-cdup)"; root_dir
="${root_dir:-.}"
727 logrefupdates
="$(git config --bool core.logallrefupdates 2>/dev/null || :)"
728 [ "$logrefupdates" = "true" ] || logrefupdates
=
730 # Make sure root_dir doesn't end with a trailing slash.
732 root_dir
="${root_dir%/}"
733 [ -n "$base_remote" ] || base_remote
="$(git config topgit.remote 2>/dev/null)" ||
:
735 # create global temporary directories, inside GIT_DIR
737 tg_tmp_dir
="$(mktemp -d "$git_dir/tg-tmp.XXXXXX
")"
738 trap "rm -rf \"$tg_tmp_dir\"" EXIT
741 # return the "realpath" for the item except the leaf is not resolved if it's
742 # a symbolic link. The directory part must exist, but the basename need not.
745 [ -n "$1" -a -d "$(dirname -- "$1")" ] ||
return 1
746 printf '%s' "$(cd -- "$
(dirname -- "$1")" && pwd -P)/$(basename -- "$1")"
752 die
"No command directory: '@cmddir@'"
754 if [ -n "$tg__include" ]; then
756 # We were sourced from another script for our utility functions;
757 # this is set by hooks. Skip the rest of the file. A simple return doesn't
758 # work as expected in every shell. See http://bugs.debian.org/516188
760 # ensure setup happens
769 tgdir
="$(dirname -- "$tg")/"
770 tgname
="$(basename -- "$tg")"
771 [ "$0" != "$tgname" ] || tgdir
=""
773 # If tg contains a '/' but does not start with one then replace it with an absolute path
775 case "$0" in /*) :;; */*)
776 tgdir
="$(cd "$
(dirname -- "$0")" && pwd -P)/"
780 # If the tg in the PATH is the same as "$tg" just display the basename
781 # tgdisplay will include any explicit -C <dir> option whereas tg will not
783 tgdisplaydir
="$tgdir"
785 if [ "$(get_abs_path "$tg")" = "$(get_abs_path "$
(which "$tgname" ||
:)" || :)" ]; then
796 while :; do case "$1" in
811 echo "Option -r requires an argument." >&2
817 explicit_remote
="$base_remote"
818 tg
="$tgdir$tgname -r $explicit_remote"
819 tgdisplay
="$tgdisplaydir$tgname"
820 [ -z "$explicit_dir" ] || tgdisplay
="$tgdisplay -C \"$explicit_dir\""
821 tgdisplay
="$tgdisplay -r $explicit_remote"
825 unset base_remote explicit_remote
827 tg
="$tgdir$tgname -u"
828 tgdisplay
="$tgdisplaydir$tgname"
829 [ -z "$explicit_dir" ] || tgdisplay
="$tgdisplay -C \"$explicit_dir\""
830 tgdisplay
="$tgdisplay -u"
836 echo "Option -C requires an argument." >&2
843 gitcdopt
=" -C \"$explicit_dir\""
845 tgdisplay
="$tgdisplaydir$tgname -C \"$explicit_dir\""
846 [ -z "$explicit_remote" ] || tg
="$tg -r $explicit_remote"
847 [ -z "$explicit_remote" ] || tgdisplay
="$tgdisplay -r $explicit_remote"
848 [ -z "$noremote" ] || tg
="$tg -u"
849 [ -z "$noremote" ] || tg
="$tgdisplay -u"
857 echo "Invalid option $1 (subcommand options must appear AFTER the subcommand)." >&2
866 [ -n "$cmd" ] ||
{ cmd
="$1"; shift ||
:; }
870 [ -n "$cmd" ] ||
{ do_help
; exit 1; }
883 [ -r "@cmddir@"/tg-
$cmd ] ||
{
884 echo "Unknown subcommand: $cmd" >&2
890 [ -z "$noremote" ] ||
unset base_remote
892 # make sure merging the .top* files will always behave sanely
895 setup_hook
"pre-commit"
897 .
"@cmddir@"/tg-
$cmd;;