Merge commit 'refs/top-bases/fixes/tg--r-require-arg' into fixes/tg--r-require-arg

[topgit.git] / README

diff --git a/README b/README
index ce0c3a65fd1634731b72e352eb5b4ac5da7fa670..ed8d358c9c85132931c2781498e3205f5d61ce2d 100644 (file)
--- a/README
+++ b/README
@@ -272,6 +272,14 @@ tg depend
 
        TODO: Subcommand for removing dependencies, obviously
 
+tg files
+~~~~~~~~
+       List files changed by the current or specified topic branch.
+
+       Options:
+         -i            list files based on index instead of branch
+         -w            list files based on working tree instead of branch
+
 tg info
 ~~~~~~~
        Show a summary information about the current or specified
@@ -315,6 +323,10 @@ tg mail
 
        to let `git send-email` ask for confirmation before sending any mail.
 
+       Options:
+         -i            base patch generation on index instead of branch
+         -w            base patch generation on working tree instead of branch
+
        TODO: 'tg mail patchfile' to mail an already exported patch
        TODO: mailing patch series
        TODO: specifying additional options and addresses on command
@@ -362,6 +374,10 @@ tg summary
        branches in a machine-readable format.  Feed this to "tsort"
        to get the output from --sort.
 
+       Options:
+         -i            Use TopGit meta data from the index instead of branch
+         -w            Use TopGit meta data from the working tree instead of branch
+
        TODO: Speed up by an order of magnitude
        TODO: Text graph view
 
@@ -514,22 +530,33 @@ 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.)
+       branch.
 
 tg log
 ~~~~~~
        Prints the git log of the named topgit branch.
 
-TODO: tg rename
+       Note: if you have merged changes from a different repository, this
+       command might not list all interesting commits.
+
+tg prev
+~~~~~~~
+       Outputs the direct dependencies for the current or named patch.
+
+       Options:
+         -i            show dependencies based on index instead of branch
+         -w            show dependencies based on working tree instead of branch
 
+tg next
+~~~~~~~
+       Outputs all patches which directly depend on the current or
+       named patch.
+
+       Options:
+         -i            show dependencies based on index instead of branch
+         -w            show dependencies based on working tree instead of branch
+
+TODO: tg rename
 
 IMPLEMENTATION
 --------------