version-controlled at all). But there are several disadvantages -
for one, these tools (especially StGIT) do not actually fit well
with plain Git at all: it is basically impossible to take advantage
-of the index efectively when using StGIT. But more importantly,
+of the index effectively when using StGIT. But more importantly,
these tools horribly fail in the face of distributed environment.
TopGit has been designed around three main tenets:
As mentioned above, the main intended use-case for TopGit is tracking
third-party patches, where each patch is effectively a single topic
-branch. In order to flexibly accomodate even complex scenarios when
+branch. In order to flexibly accommodate even complex scenarios when
you track many patches where many are independent but some depend
on others, TopGit ignores the ancient Quilt heritage of patch series
and instead allows the patches to freely form graphs (DAGs just like
After `tg create`, you should insert the patch description
to the '.topmsg' file, which will already contain some
- pre-filled bits. You can set topgit.to, topgit.cc and topgit.bcc
+ prefilled bits. You can set topgit.to, topgit.cc and topgit.bcc
configuration variables in order to have `tg create`
add these headers with given default values to '.topmsg'.
tg patch will be able to automatically send the patches by mail
or save them to files. (TODO)
- TODO: tg patch -i to base at index instead of branch,
- -w for working tree
+ Options:
+ -i base patch generation on index instead of branch
+ -w base patch generation on working tree instead of branch
tg mail
~~~~~~~
in the cleaned up history (corresponding basically exactly
to `tg patch` output for the topic branch).
- The command has two posible outputs now - either a Git branch
+ The command has two possible outputs now - either a Git branch
with the collapsed history, or a quilt series in new directory.
In case of producing collapsed history in new branch,
a comma-separated explicit list of branches to export. This
mode of operation is currently not supported with collapse.
+ In '--quilt' mode the patches are named like the originating topgit
+ branch. So usually they end up in subdirectories of the output
+ directory. With option '--flatten' the names are mangled such that
+ they end up directly in the output dir (i.e. slashed are substituted by
+ underscores). With '--numbered' (which implies '--flatten') the patch
+ names get a number as prefix to allow getting the order without
+ consulting the series file, which eases sending out the patches.
+
Usage: tg export ([--collapse] BRANCH | --quilt DIR)
TODO: Make stripping of non-essential headers configurable
TODO: Make stripping of [PATCH] and other prefixes configurable
TODO: --mbox option for other mode of operation
- TODO: -n option to prevent exporting of empty patches
TODO: -a option to export all branches
TODO: For quilt exporting, use a temporary branch and remove it when
done - this would allow producing conflict-less series
TODO: tg update -a for updating all topic branches
-TODO: tg depend for adding/removing dependencies smoothly
TODO: tg rename
When mailing out your patch, basically only few extra headers
mail headers are inserted and the patch itself is appended.
Thus, as your patches evolve, you can record nuances like whether
-the paricular patch should have To-list/Cc-maintainer or vice
+the particular patch should have To-list/Cc-maintainer or vice
versa and similar nuances, if your project is into that.
From is prefilled from your current GIT_AUTHOR_IDENT, other headers
can be prefilled from various optional topgit.* config options.
local cur="${COMP_WORDS[COMP_CWORD]}"
case "$cur" in
+ -*)
+ __tgcomp "
+ -i
+ -w
+ "
+ ;;
*)
__tgcomp "$(__tg_topics)"
esac
local cur="${COMP_WORDS[COMP_CWORD]}"
case "$cur" in
+ -*)
+ __tgcomp "
+ --populate
+ "
+ ;;
*)
__tgcomp "$(__tg_remotes)"
esac
_tg_summary ()
{
- COMPREPLY=()
+ local cur="${COMP_WORDS[COMP_CWORD]}"
+
+ case "$cur" in
+ *)
+ __tgcomp "
+ --graphviz
+ -t
+ "
+ esac
}
_tg_update ()
{ if (incommand) { print $0; } }
' > tg-"$1".txt
+# vim:noet
info "Topic branch $name set up. Please fill .topmsg now and make initial commit."
info "To abort: git rm -f .top* && git checkout ${deps%% *} && $tg delete $name"
+
+# vim:noet
git update-ref -d "refs/top-bases/$name" "$baserev"
git update-ref -d "refs/heads/$name" "$branchrev"
+
+# vim:noet
git add -f "$root_dir/.topdeps"
git commit -m"New TopGit dependency: $name"
$tg update
+
+# vim:noet
branches=
output=
driver=collapse
+flatten=false
+numbered=false
## Parse options
case "$arg" in
-b)
branches="$1"; shift;;
+ --flatten)
+ flatten=true;;
+ --numbered)
+ flatten=true;
+ numbered=true;;
--quilt)
driver=quilt;;
--collapse)
[ -z "$branches" -o "$driver" = "quilt" ] ||
die "-b works only with the quilt driver"
+[ "$driver" = "quilt" ] || ! "$numbered" ||
+ die "--numbered works only with the quilt driver";
+
+[ "$driver" = "quilt" ] || ! "$flatten" ||
+ die "--flatten works only with the quilt driver"
+
if [ -z "$branches" ]; then
# this check is only needed when no branches have been passed
name="$(git symbolic-ref HEAD | sed 's#^refs/heads/##')"
$(for p in $parent; do echo -p $p; done))"
fi
- (printf '%s\n\n' "$SUBJECT"; cat "$playground/^msg") |
- git stripspace |
- git commit-tree "$(pretty_tree "$name")" -p "$parent"
+ if branch_empty "$name"; then
+ echo "$parent";
+ else
+ (printf '%s\n\n' "$SUBJECT"; cat "$playground/^msg") |
+ git stripspace |
+ git commit-tree "$(pretty_tree "$name")" -p "$parent"
+ fi;
echo "$name" >>"$playground/^ticker"
}
return
fi
- filename="$output/$_dep.diff"
- if [ -e "$filename" ]; then
+ if "$flatten"; then
+ bn="$(echo "$_dep.diff" | sed -e 's#_#__#g' -e 's#/#_#g')";
+ dn="";
+ else
+ bn="$(basename "$_dep.diff")";
+ dn="$(dirname "$_dep.diff")/";
+ if [ "x$dn" = "x./" ]; then
+ dn="";
+ fi;
+ fi;
+
+ if [ -e "$playground/$_dep" ]; then
# We've already seen this dep
return
fi
- echo "Exporting $_dep"
- mkdir -p "$(dirname "$filename")"
- $tg patch "$_dep" >"$filename"
- echo "$_dep.diff -p1" >>"$output/series"
+ mkdir -p "$playground/$(dirname "$_dep")";
+ touch "$playground/$_dep";
+
+ if branch_empty "$_dep"; then
+ echo "Skip empty patch $_dep";
+ else
+ if "$numbered"; then
+ number="$(printf "%04u" $(($(cat "$playground/^number" 2>/dev/null) + 1)))";
+ bn="$number-$bn";
+ echo "$number" >"$playground/^number";
+ fi;
+
+ echo "Exporting $_dep"
+ mkdir -p "$output/$dn";
+ $tg patch "$_dep" >"$output/$dn$bn"
+ echo "$dn$bn -p1" >>"$output/series"
+ fi
}
depcount="$(cat "$output/series" | wc -l)"
echo "Exported topic branch $name (total $depcount topics) to directory $output"
fi
+
+# vim:noet
esac
done
done
+
+# vim:noet
echo "Up-to-date."
fi
rm "$depcheck"
+
+# vim:noet
base_rev="$(git rev-parse --short --verify "refs/top-bases/$name" 2>/dev/null)" ||
die "not a TopGit-controlled branch"
+if ! git send-emmail --help >/dev/null 2>&1; then
+ die "git send-email command not available"
+fi
+
if [ -n "$in_reply_to" ]; then
send_email_args="$send_email_args --in-reply-to=$in_reply_to"
fi
eval git send-email $send_email_args "$people" "$patchfile"
rm "$patchfile"
+
+# vim:noet
name=
+topic=
+diff_opts=
+diff_committed_only=yes # will be unset for index/worktree
+
## Parse options
while [ -n "$1" ]; do
arg="$1"; shift
case "$arg" in
+ -i)
+ topic='(i)'
+ diff_opts="$diff_opts --cached";
+ diff_committed_only=;;
+ -w)
+ topic='(w)'
+ diff_committed_only=;;
-*)
- echo "Usage: tg [...] patch [NAME]" >&2
+ echo "Usage: tg [...] patch [-i | -w] [NAME]" >&2
exit 1;;
*)
[ -z "$name" ] || die "name already specified ($name)"
esac
done
+
+[ -n "$name" -a -z "$diff_committed_only" ] &&
+ die "-i/-w are mutually exclusive with NAME"
+
[ -n "$name" ] || name="$(git symbolic-ref HEAD | sed 's#^refs/\(heads\|top-bases\)/##')"
base_rev="$(git rev-parse --short --verify "refs/top-bases/$name" 2>/dev/null)" ||
die "not a TopGit-controlled branch"
-git cat-file blob "$name:.topmsg"
+# if not index/worktree, topic is current branch
+[ -z "$topic" ] && topic="$name"
+
+
+
+setup_pager
+
+cat_file "$topic:.topmsg"
echo
-[ -n "$(git grep '^[-]--' "$name" -- ".topmsg")" ] || echo '---'
+[ -n "$(git grep $diff_opts '^[-]--' ${diff_committed_only:+"$name"} -- ".topmsg")" ] || echo '---'
# Evil obnoxious hack to work around the lack of git diff --exclude
git_is_stupid="$(mktemp -t tg-patch-changes.XXXXXX)"
-git diff-tree --name-only "$base_rev" "$name" |
+git diff --name-only $diff_opts "$base_rev" ${diff_committed_only:+"$name"} -- |
fgrep -vx ".topdeps" |
fgrep -vx ".topmsg" >"$git_is_stupid" || : # fgrep likes to fail randomly?
if [ -s "$git_is_stupid" ]; then
- cat "$git_is_stupid" | xargs git diff --patch-with-stat "$base_rev" "$name" --
+ cat "$git_is_stupid" | xargs git diff --patch-with-stat $diff_opts "$base_rev" ${diff_committed_only:+"$name"} --
else
echo "No changes."
fi
rm "$git_is_stupid"
echo '-- '
-echo "tg: ($base_rev..) $name (depends on: $(git cat-file blob "$name:.topdeps" | paste -s -d' '))"
+echo "tg: ($base_rev..) $name (depends on: $(cat_file "$topic:.topdeps" | paste -s -d' '))"
branch_contains "$name" "$base_rev" ||
echo "tg: The patch is out-of-date wrt. the base! Run \`$tg update\`."
+
+# vim:noet
## Configure the remote
-git config --add "remote.$name.fetch" "+refs/top-bases/*:refs/remotes/$name/top-bases/*"
-git config --add "remote.$name.push" "+refs/top-bases/*:refs/top-bases/*"
-git config --add "remote.$name.push" "+refs/heads/*:refs/heads/*"
+git config --replace-all "remote.$name.fetch" "+refs/top-bases/*:refs/remotes/$name/top-bases/*" "\\+refs/top-bases/\\*:refs/remotes/$name/top-bases/\\*"
+git config --replace-all "remote.$name.push" "+refs/top-bases/*:refs/top-bases/*" "\\+refs/top-bases/\\*:refs/top-bases/\\*"
+git config --replace-all "remote.$name.push" "+refs/heads/*:refs/heads/*" "\\+refs/heads/\\*:refs/heads/\\*"
info "Remote $name can now follow TopGit topic branches."
if [ -z "$populate" ]; then
git config "topgit.remote" "$name"
info "The remote '$name' is now the default source of topic branches."
+
+# vim:noet
curname="$(git symbolic-ref HEAD | sed 's#^refs/\(heads\|top-bases\)/##')"
+! [ -n "$terse" -a -n "$graphviz" ] ||
+ die "-t and --graphviz options are mutual exclusive"
+
if [ -n "$graphviz" ]; then
cat <<EOT
# GraphViz output; pipe to:
if [ -n "$graphviz" ]; then
echo '}'
fi
+
+# vim:noet
fi
exit 3
fi
+
+# vim:noet
# (c) Petr Baudis <pasky@suse.cz> 2008
# GPLv2
+TG_VERSION=0.6
## Auxiliary functions
exit 1
}
+# cat_file "topic:file"
+# Like `git cat-file blob $1`, but topics '(i)' and '(w)' means index and worktree
+cat_file()
+{
+ arg="$1"
+ case "$arg" in
+ '(w):'*)
+ arg=$(echo "$arg" | tail --bytes=+5)
+ cat "$arg"
+ return
+ ;;
+ '(i):'*)
+ # ':file' means cat from index
+ arg=$(echo "$arg" | tail --bytes=+5)
+ git cat-file blob ":$arg"
+ ;;
+ *)
+ git cat-file blob "$arg"
+ esac
+}
+
# setup_hook NAME
setup_hook()
{
_bname="$1"; _base="$2"
[ -n "$_base" ] || _base="refs/top-bases/$_bname"
# The caller should've verified $name is valid
- _commits="$(git rev-list "$_bname" ^"$_base" | wc -l)"
- _nmcommits="$(git rev-list --no-merges "$_bname" ^"$_base" | wc -l)"
+ _commits="$(git rev-list "$_bname" ^"$_base" -- | wc -l)"
+ _nmcommits="$(git rev-list --no-merges "$_bname" ^"$_base" -- | wc -l)"
if [ $_commits -gt 1 ]; then
_suffix="commits"
else
do_help()
{
if [ -z "$1" ] ; then
+ # This is currently invoked in all kinds of circumstances,
+ # including when the user made a usage error. Should we end up
+ # providing more than a short help message, then we should
+ # differentiate.
+ # Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
+
## Build available commands list for help output
cmds=
sep="|"
done
- echo "TopGit v0.5 - A different patch queue manager"
+ echo "TopGit v$TG_VERSION - A different patch queue manager"
echo "Usage: tg [-r REMOTE] ($cmds|help) ..."
elif [ -r "@cmddir@"/tg-$1 ] ; then
@cmddir@/tg-$1 -h || :
fi
else
echo "`basename $0`: no help for $1" 1>&2
+ do_help
+ exit 1
fi
}
test -z "$prev"
}
+## Pager stuff
+
+# isatty FD
+isatty()
+{
+ test -t $1
+}
+
+# setup_pager
+# Spawn pager process and redirect the rest of our output to it
+setup_pager()
+{
+ isatty 1 || return 0
+
+ # TG_PAGER = GIT_PAGER | PAGER | less
+ # NOTE: GIT_PAGER='' is significant
+ TG_PAGER=${GIT_PAGER-${PAGER-less}}
+
+ [ -z "$TG_PAGER" -o "$TG_PAGER" = "cat" ] && return 0
+
+
+ # now spawn pager
+ export LESS=${LESS:-FRSX} # as in pager.c:pager_preexec()
+
+ _pager_fifo_dir="$(mktemp -t -d tg-pager-fifo.XXXXXX)"
+ _pager_fifo="$_pager_fifo_dir/0"
+ mkfifo -m 600 "$_pager_fifo"
+
+ "$TG_PAGER" < "$_pager_fifo" &
+ exec > "$_pager_fifo" # dup2(pager_fifo.in, 1)
+
+ # this is needed so e.g. `git diff` will still colorize it's output if
+ # requested in ~/.gitconfig with color.diff=auto
+ export GIT_PAGER_IN_USE=1
+
+ # atexit(close(1); wait pager)
+ trap "exec >&-; rm \"$_pager_fifo\"; rmdir \"$_pager_fifo_dir\"; wait" EXIT
+}
+
## Startup
[ -d "@cmddir@" ] ||
[ -z "$tg__include" ] || return 0
if [ "$1" = "-r" ]; then
- shift; base_remote="$1"; shift
+ shift
+ if [ -z "$1" ]; then
+ echo "Option -r requires an argument." >&2
+ do_help
+ exit 1
+ fi
+ base_remote="$1"; shift
tg="$tg -r $base_remote"
fi
*)
[ -r "@cmddir@"/tg-$cmd ] || {
echo "Unknown subcommand: $cmd" >&2
+ do_help
exit 1
}
. "@cmddir@"/tg-$cmd;;
esac
+
+# vim:noet
~ian / topgit.git / commitdiff