cat_file: take -i/-w parameters

[topgit.git] / README

diff --git a/README b/README
index 9bab4defb385acc3a377750414de8167558c613e..48db36a08f5566f709e68560ad0667be9290becd 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
@@ -327,7 +335,7 @@ tg remote
        and 'git push' to operate on them. (Do NOT use 'git push --all'
        for your pushes - plain 'git push' will do the right thing.)
 
-       It takes a mandatory remote name argument, and optional
+       It takes a optional remote name argument, and optional
        '--populate' switch - use that for your origin-style remote,
        it will seed the local topic branch system based on the
        remote topic branches. '--populate' will also make 'tg remote'
@@ -483,13 +491,15 @@ tg import
 
 tg update
 ~~~~~~~~~
-       Update the current topic branch wrt. changes in the branches
-       it depends on and remote branches.
+       Update the current or specified topic branch wrt. changes in the
+       branches it depends on and remote branches.
        This is performed in two phases - first,
        changes within the dependencies are merged to the base,
        then the base is merged into the topic branch.
        The output will guide you in case of conflicts.
 
+       After the update the current branch is the specified one.
+
        In case your dependencies are not up-to-date, tg update
        will first recurse into them and update these.
 
@@ -512,16 +522,14 @@ 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`..
+       branch.
 
-       (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.)
+tg log
+~~~~~~
+       Prints the git log of the named topgit branch.
 
+       Note: if you have merged changes from a different repository, this
+       command might not list all interesting commits.
 
 TODO: tg rename