chiark / gitweb /
hooks/pre-commit: check for deps repetitions
[topgit.git] / README
diff --git a/README b/README
index f103d925bce4d32ed8c342785f9ac9149570d73a..5ca042450a7028c5c28ebf8640793a28f48f36c8 100644 (file)
--- a/README
+++ b/README
@@ -327,7 +327,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 +483,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 +514,16 @@ 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:
+       branch.
 
-               git log --first-parent --no-merges `tg base`..
+tg log
+~~~~~~
+       Prints the git log of the named topgit branch.
 
-       (Note: if you have shared the TopGit branch, the above command
+       Note: if you have shared the TopGit branch, this command
        only lists the commits that were made in the current
        repository, so you will not see work done by your
-       collaborators.)
-
+       collaborators.
 
 TODO: tg rename
 
@@ -622,3 +624,13 @@ All commands by default refer to the remote that 'tg remote --populate'
 was called on the last time ('topgit.remote' configuration variable). You can
 manually run any command with a different base remote by passing '-r REMOTE'
 _before_ the subcommand name.
+
+
+POINTERS
+--------
+
+The following references are useful to understand the development of topgit and
+its subcommands.
+
+tg depend:
+  http://lists-archives.org/git/688698-add-list-and-rm-sub-commands-to-tg-depend.html