chiark / gitweb /
make removing quilt patches dir more robust
[topgit.git] / README
diff --git a/README b/README
index f45eb6c..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.
@@ -253,6 +253,21 @@ tg delete
 
        TODO: '-a' to delete all empty branches, depfix, revert
 
+tg depend
+~~~~~~~~~
+       Change dependencies of a TopGit-controlled topic branch.
+       This should have several subcommands, but only 'add' is
+       supported right now.
+
+       The 'add' subcommand takes an argument of a topic branch
+       to be added, adds it to '.topdeps', performs a commit and
+       then updates your topic branch accordingly. If you want to
+       do other things related to the dependency addition, like
+       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
@@ -272,11 +287,33 @@ tg patch
        TODO: tg patch -i to base at index instead of branch,
                -w for working tree
 
+tg mail
+~~~~~~~
+       Send a patch from the current or specified topic branch as
+       email.
+
+       Takes the patch given on the command line and emails it out.
+       Destination addresses such as To, Cc and Bcc are taken from the
+       patch header.
+
+       Since it actually boils down to `git send-email` please refer to
+       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
+       TODO: specifying additional options and addresses on command
+             line
+
 tg remote
 ~~~~~~~~~
        Register given remote as TopGit-controlled. This will create
        the namespace for the remote branch bases and teach 'git fetch'
-       and 'git push' to operate on them.
+       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
        '--populate' switch - use that for your origin-style remote,
@@ -296,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
 ~~~~~~~~~
@@ -362,6 +405,10 @@ tg export
        and an argument specifying the directory
        where the quilt series should be saved.
 
+       With '--quilt', you can also pass '-b' parameter followed by
+       a comma-separated explicit list of branches to export. This
+       mode of operation is currently not supported with collapse.
+
        Usage: tg export ([--collapse] BRANCH | --quilt DIR)
 
        TODO: Make stripping of non-essential headers configurable
@@ -369,8 +416,6 @@ tg export
        TODO: --mbox option for other mode of operation
        TODO: -n option to prevent exporting of empty patches
        TODO: -a option to export all branches
-       TODO: Allow branches to be exported to be passed as arguments, default
-             to the current branch if none are specified
        TODO: For quilt exporting, use a temporary branch and remove it when
              done - this would allow producing conflict-less series
 
@@ -378,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
@@ -405,8 +455,6 @@ tg update
 
        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
 
@@ -445,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