X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;f=README;h=c19985f83d54a72728d0c36413ea7b0a03e52d6e;hb=a062d4f8ef8e7d3174b5a572e1002b6c4b2273e7;hp=8129f9190e68b3101cd234f94db5aac2170f2327;hpb=995861effbc75374ac47dfd7fd787f01c6366bef;p=topgit.git diff --git a/README b/README index 8129f91..c19985f 100644 --- a/README +++ b/README @@ -22,7 +22,7 @@ version control of patches (reordering of patches is not version-controlled at all). But there are several disadvantages - for one, these tools (especially StGIT) do not actually fit well with plain Git at all: it is basically impossible to take advantage -of the index efectively when using StGIT. But more importantly, +of the index effectively when using StGIT. But more importantly, these tools horribly fail in the face of distributed environment. TopGit has been designed around three main tenets: @@ -45,11 +45,11 @@ them. As mentioned above, the main intended use-case for TopGit is tracking third-party patches, where each patch is effectively a single topic -branch. In order to flexibly accomodate even complex scenarios when +branch. In order to flexibly accommodate 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. @@ -222,7 +222,7 @@ tg create After `tg create`, you should insert the patch description to the '.topmsg' file, which will already contain some - pre-filled bits. You can set topgit.to, topgit.cc and topgit.bcc + prefilled bits. You can set topgit.to, topgit.cc and topgit.bcc configuration variables in order to have `tg create` add these headers with given default values to '.topmsg'. @@ -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 @@ -331,10 +335,12 @@ tg summary 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. + 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 ~~~~~~~~~ @@ -344,7 +350,7 @@ tg export in the cleaned up history (corresponding basically exactly to `tg patch` output for the topic branch). - The command has two posible outputs now - either a Git branch + The command has two possible outputs now - either a Git branch with the collapsed history, or a quilt series in new directory. In case of producing collapsed history in new branch, @@ -408,7 +414,7 @@ tg export TODO: Make stripping of non-essential headers configurable TODO: Make stripping of [PATCH] and other prefixes configurable TODO: --mbox option for other mode of operation - TODO: -n option to prevent exporting of empty patches + TODO: prevent exporting of empty patches by the collapse driver TODO: -a option to export all branches TODO: For quilt exporting, use a temporary branch and remove it when done - this would allow producing conflict-less series @@ -417,7 +423,8 @@ 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 @@ -448,7 +455,6 @@ tg update TODO: tg update -a for updating all topic branches -TODO: tg depend for adding/removing dependencies smoothly TODO: tg rename @@ -478,7 +484,7 @@ whatever Cc headers you choose or the post-three-dashes message. When mailing out your patch, basically only few extra headers mail headers are inserted and the patch itself is appended. Thus, as your patches evolve, you can record nuances like whether -the paricular patch should have To-list/Cc-maintainer or vice +the particular patch should have To-list/Cc-maintainer or vice versa and similar nuances, if your project is into that. From is prefilled from your current GIT_AUTHOR_IDENT, other headers can be prefilled from various optional topgit.* config options.