Indicate the current branch in "tg summary --graphviz"

[topgit.git] / README

diff --git a/README b/README
index c418ff41a694b3920af6854d01f8b64f1ecc94d4..f103d925bce4d32ed8c342785f9ac9149570d73a 100644 (file)
--- a/README
+++ b/README
@@ -351,6 +351,17 @@ tg summary
        pass '--graphviz' to get a dot-suitable output to draw a dependency
        graph between the topic branches.
 
+       You can also use the --sort option to sort the branches using
+       a topological sort.  This is especially useful if each
+       TopGit-tracked topic branch depends on a single parent branch,
+       since it will then print the branches in the dependency
+       order.  In more complex scenarios, a text graph view would be
+       much more useful, but that is not yet implemented.
+
+       The --deps option outputs dependency informations between
+       branches in a machine-readable format.  Feed this to "tsort"
+       to get the output from --sort.
+
        TODO: Speed up by an order of magnitude
        TODO: Text graph view
 
@@ -497,6 +508,21 @@ tg push
        repository.  By default the remote gets all dependencies
        (both tgish and non-tgish) and bases pushed to.
 
+tg base
+~~~~~~~
+       Prints the base commit of the current topic branch.  Silently
+       exits with exit code 1 if you are not working on a TopGit
+       branch.  The following command can be useful to get a summary
+       of the work you have made on a topic branch:
+
+               git log --first-parent --no-merges `tg base`..
+
+       (Note: if you have shared the TopGit branch, the above command
+       only lists the commits that were made in the current
+       repository, so you will not see work done by your
+       collaborators.)
+
+
 TODO: tg rename