chiark / gitweb /
tg import: Fix up process_commit() progress reporting
[topgit.git] / README
diff --git a/README b/README
index 9df3699d765e8242b4b5f24075aa6d500b3753f1..9c6f3352185130cf58f6158ffa96fd5ebbc1960d 100644 (file)
--- a/README
+++ b/README
@@ -266,7 +266,8 @@ tg remote
 tg summary
 ~~~~~~~~~~
        Show overview of all TopGit-tracked topic branches and their
-       up-to-date status ('0' marks that it introduces no own changes,
+       up-to-date status ('>' marks the current topic branch,
+       '0' marks that it introduces no own changes,
        'l'/'r' marks that it is local-only or has remote mate,
        'L'/'R' marks that it is ahead/out-of-date wrt. its remote mate,
        'D' marks that it is out-of-date wrt. its dependencies,
@@ -351,6 +352,16 @@ tg export
        TODO: For quilt exporting, use a temporary branch and remove it when
              done - this would allow producing conflict-less series
 
+tg import
+~~~~~~~~~
+       Import commits within the given revision range into TopGit,
+       creating one topic branch per commit, the dependencies forming
+       a linear sequence starting on your current branch.
+
+       The branch names are auto-guessed from the commit messages
+       and prefixed by t/ by default; use '-p PREFIX' to specify
+       an alternative prefix (even an empty one).
+
 tg update
 ~~~~~~~~~
        Update the current topic branch wrt. changes in the branches
@@ -459,3 +470,8 @@ carried over to our local base automagically. Then, the base is merged into
 remote branch and the result is merged to local branch - again, to carry over
 remote conflict resolutions. In the future, this order might be adjustable
 per-update in case local changes are diverging more than the remote ones.
+
+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.