chiark / gitweb /
Add Vim modelines for consistent spacing
[topgit.git] / README
diff --git a/README b/README
index 1893dc0..5bfe3ee 100644 (file)
--- a/README
+++ b/README
@@ -49,7 +49,7 @@ branch.  In order to flexibly accomodate even complex scenarios when
 you track many patches where many are independent but some depend
 on others, TopGit ignores the ancient Quilt heritage of patch series
 and instead allows the patches to freely form graphs (DAGs just like
-Git history itself, only "one lever higher"). For now, you have
+Git history itself, only "one level higher"). For now, you have
 to manually specify which patches does the current one depend
 on, but TopGit might help you with that in the future in a darcs-like
 fashion.
@@ -266,6 +266,8 @@ tg depend
        adjusting '.topmsg', prepare them in the index before
        calling 'tg depend add'.
 
+       TODO: Subcommand for removing dependencies, obviously
+
 tg info
 ~~~~~~~
        Show a summary information about the current or specified
@@ -298,6 +300,8 @@ tg mail
        its documentation for details on how to setup email for git.
        You can pass arbitrary options to this command through the
        '-s' parameter, but you must double-quote everything.
+       The '-r' parameter with msgid can be used to generate in-reply-to
+       and reference headers to an earlier mail.
 
        TODO: 'tg mail patchfile' to mail an already exported patch
        TODO: mailing patch series
@@ -329,8 +333,14 @@ tg summary
        '!' marks that it has missing dependencies (even recursively),
        'B' marks that it is out-of-date wrt. its base).
 
+       This can take long time to accurately determine all the relevant
+       information about each branch; you can pass '-t' to get just
+       terse list of topic branch names quickly. Alternately, you can
+       pass '--graphviz' to get a dot-suitable output to draw a dependency
+       graph between the topic branches.
+
        TODO: Speed up by an order of magnitude
-       TODO: Graph view
+       TODO: Text graph view
 
 tg export
 ~~~~~~~~~
@@ -413,12 +423,17 @@ 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.
+       a linear sequence starting on your current branch (or a branch
+       specified by the '-d' parameter).
 
        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).
 
+       Alternatively, you can use the '-s NAME' parameter to specify
+       the name of target branch; the command will then take one more
+       argument describing a single commit to import.
+
 tg update
 ~~~~~~~~~
        Update the current topic branch wrt. changes in the branches
@@ -478,7 +493,10 @@ can be prefilled from various optional topgit.* config options.
        .topdeps: Contains the one-per-line list of branches
 your patch depends on, pre-seeded with `tg create`. (Continuously
 updated) merge of these branches will be the "base" of your topic
-branch.
+branch. DO NOT EDIT THIS FILE MANUALLY!!! If you do so, you need
+to know exactly what are you doing, since this file must stay in
+sync with the Git history information, otherwise very bad things
+will happen.
 
 TopGit also automagically installs a bunch of custom commit-related
 hooks that will verify if you are committing the .top* files in sane