X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=topgit.git;a=blobdiff_plain;f=README;h=1d3836585b109449fd6475edad5a470700bff802;hp=7b117b89f44a836ecafe4e5077d7f33980a78209;hb=4fe0a8e009776b8c66357f08ef8171bdc2c0f468;hpb=d272e32afc116764cf2afc1033320953466f5ed5 diff --git a/README b/README index 7b117b8..1d38365 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 @@ -296,6 +298,10 @@ tg mail 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 @@ -327,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 ~~~~~~~~~ @@ -338,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, @@ -393,15 +405,24 @@ 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. + + In '--quilt' mode the patches are named like the originating topgit + branch. So usually they end up in subdirectories of the output + directory. With option '--flatten' the names are mangled such that + they end up directly in the output dir (i.e. slashed are substituted by + underscores). With '--numbered' (which implies '--flatten') the patch + names get a number as prefix to allow getting the order without + consulting the series file, which eases sending out the patches. + Usage: tg export ([--collapse] BRANCH | --quilt DIR) 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: -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 @@ -409,12 +430,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 @@ -436,7 +462,6 @@ tg update TODO: tg update -a for updating all topic branches -TODO: tg depend for adding/removing dependencies smoothly TODO: tg rename @@ -466,7 +491,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. @@ -474,7 +499,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