tg import: Standard script header

[topgit.git] / README

diff --git a/README b/README
index 4d96dfb5a52ebfc0cf40264f317ecd57f12865bf..66a1638c96890eed7e6c73810bde64cc3277b135 100644 (file)
--- a/README
+++ b/README
@@ -352,6 +352,17 @@ 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 tp/.
+
+       Usage: tg import rev1..rev2
+
 tg update
 ~~~~~~~~~
        Update the current topic branch wrt. changes in the branches
@@ -460,3 +471,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.