X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=topgit.git;a=blobdiff_plain;f=README;h=a4839f45803b62ec2dcf06eda571c4b51fa89bf7;hp=36316fad1155f1da073a47a3b34bada12bbbb1b0;hb=a867758867a1283fafd9e4604f6f8bd0c381198d;hpb=1ff231723670255a258d9fb0fd4e7160b630e190 diff --git a/README b/README index 36316fa..a4839f4 100644 --- a/README +++ b/README @@ -86,9 +86,9 @@ SYNOPSIS $ ..hack.. $ git commit - ## Create another topic branch on top of specified one and submit + ## Create another topic branch on top of master and submit ## the resulting patch upstream - $ tg create -d master t/revlist/author-fixed + $ tg create t/revlist/author-fixed master tg: Creating t/revlist/author-fixed base from master... $ ..hack.. $ git commit @@ -100,7 +100,7 @@ SYNOPSIS Subject: [PATCH] Fix broken revlist --author when --fixed-string ## Create another topic branch depending on two others non-trivially - $ tg create -d t/revlist/author-fixed,t/gitweb/nifty-links t/whatever + $ tg create t/whatever t/revlist/author-fixed t/gitweb/nifty-links tg: Creating t/whatever base from t/revlist/author-fixed... tg: Merging t/whatever base with t/gitweb/nifty-links... Merge failed! @@ -199,11 +199,14 @@ tg create ~~~~~~~~~ Create a new TopGit-controlled topic branch of a given name (required argument) and switch to it. If no dependencies - are specified using the '-d' paremeter, the current branch - is assumed to be the only dependency. + are specified (by extra arguments passed after the first one), + the current branch is assumed to be the only dependency. After `tg create`, you should insert the patch description - to the '.topmsg' file. + to the '.topmsg' file, which will already contain some + pre-filled 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'. The main task of `tg create` is to set up the topic branch base from the dependencies. This may fail due to merge conflicts. @@ -212,10 +215,6 @@ tg create it will detect that you are on a topic branch base ref and resume the topic branch creation operation. - '-d': - Manually specified dependencies. A comma- or - space-separated list of branch names. - tg delete ~~~~~~~~~ Remove a TopGit-controlled topic branch of given name @@ -246,7 +245,7 @@ tg patch The patch is by default simply dumped to stdout. In the future, tg patch will be able to automatically send the patches by mail - or save them to files. + or save them to files. (TODO) TODO: tg patch -i to base at index instead of branch, -w for working tree @@ -278,8 +277,8 @@ tg update TODO: Some infrastructure for sharing topic branches between repositories easily TODO: tg depend for adding/removing dependencies smoothly -TODO: tg tidy for creating a one-commit-per-patch tidied up history - (for pulling by upstream) +TODO: tg collapse for creating a one-commit-per-patch tidied up + history (for pulling by upstream) IMPLEMENTATION @@ -310,6 +309,8 @@ 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 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. .topdeps: Contains the one-per-line list of branches your patch depends on, pre-seeded with `tg create`. (Continuously