X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;f=README;h=f103d925bce4d32ed8c342785f9ac9149570d73a;hb=d1c89c7b3c303883528e3a2ca45d9b4daf1f1e71;hp=fc74ff81160a826ddc4ab467d167114553c61df0;hpb=563ddeffd5d5947fe05b6d5ae0ae9176208557b8;p=topgit.git

diff --git a/README b/README
index fc74ff8..f103d92 100644
--- a/README
+++ b/README
@@ -308,6 +308,13 @@ tg mail
 	The '-r' parameter with msgid can be used to generate in-reply-to
 	and reference headers to an earlier mail.
 
+	Note: be careful when using this command.  It easily sends out several
+	mails.  You might want to run
+
+		git config sendemail.confirm always
+
+	to let `git send-email` ask for confirmation before sending any mail.
+
 	TODO: 'tg mail patchfile' to mail an already exported patch
 	TODO: mailing patch series
 	TODO: specifying additional options and addresses on command
@@ -344,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
 
@@ -490,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