chiark / gitweb /
remove fixes/destdir dependency
[topgit.git] / README
diff --git a/README b/README
index fd88504a4aeceee0b8fcaa0aa3856ebc564583cc..b99b03680fb7fced0e1dc2f0e699f73b141745f5 100644 (file)
--- a/README
+++ b/README
@@ -233,6 +233,10 @@ tg create
        it will detect that you are on a topic branch base ref and
        resume the topic branch creation operation.
 
+       In an alternative use case, if '-r BRANCH' is given instead
+       of dependency list, the topic branch is created based on
+       the given remote branch.
+
 tg delete
 ~~~~~~~~~
        Remove a TopGit-controlled topic branch of given name
@@ -370,6 +374,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
@@ -382,10 +396,15 @@ tg update
        In case your dependencies are not up-to-date, tg update
        will first recurse into them and update these.
 
+       If a remote branch update brings dependencies on branches
+       not yet instantiated locally, you can either bring in all
+       the new branches from the remote using 'tg remote --populate'
+       or only pick out the missing ones using 'tg create -r'
+       ('tg summary' will point out branches with incomplete
+       dependencies by showing an '!' near to them).
+
        TODO: tg update -a for updating all topic branches
 
-TODO: Some infrastructure for sharing topic branches between
-       repositories easily
 TODO: tg depend for adding/removing dependencies smoothly
 TODO: tg rename