X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;ds=sidebyside;f=README;h=b99b03680fb7fced0e1dc2f0e699f73b141745f5;hb=d33fe8bccb78adca51fa87626cd80bd064676d1f;hp=66a1638c96890eed7e6c73810bde64cc3277b135;hpb=fb1c98a527683fb1a58b9ae499a8316b21863e8b;p=topgit.git diff --git a/README b/README index 66a1638..b99b036 100644 --- a/README +++ b/README @@ -184,6 +184,24 @@ SYNOPSIS tg: Updating base with t/gitweb/nifty-links changes... tg: Updating t/whatever against new base... + ## Clone a TopGit-controlled repository + $ git clone URL repo + $ cd repo + $ tg remote --populate origin + ... + $ git fetch + $ tg update + + ## Add a TopGit remote to a repository and push to it + $ git remote add foo URL + $ tg remote foo + $ git push foo + + ## Update from a non-default TopGit remote + $ git fetch foo + $ tg -r foo summary + $ tg -r foo update + USAGE ----- @@ -215,6 +233,10 @@ tg create it will detect that you are on a topic branch base ref and resume the topic branch creation operation. + In an alternative use case, if '-r BRANCH' is given instead + of dependency list, the topic branch is created based on + the given remote branch. + tg delete ~~~~~~~~~ Remove a TopGit-controlled topic branch of given name @@ -353,15 +375,14 @@ tg export done - this would allow producing conflict-less series 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. The branch names are auto-guessed from the commit messages - and prefixed by tp/. - - Usage: tg import rev1..rev2 + and prefixed by t/ by default; use '-p PREFIX' to specify + an alternative prefix (even an empty one). tg update ~~~~~~~~~ @@ -375,10 +396,15 @@ tg update In case your dependencies are not up-to-date, tg update will first recurse into them and update these. + If a remote branch update brings dependencies on branches + not yet instantiated locally, you can either bring in all + the new branches from the remote using 'tg remote --populate' + or only pick out the missing ones using 'tg create -r' + ('tg summary' will point out branches with incomplete + dependencies by showing an '!' near to them). + 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