X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=git-debrebase.5.pod;h=52fb60b952d331c7632ab3abc2c8b424f80de624;hp=af9b91a03989d31e8c6dad64261686b3f73f9927;hb=60b7ec7b4ed5d79709ef1ec6037b1431691db808;hpb=2473428adbc11e7bcd557b48fea887203cd48446 diff --git a/git-debrebase.5.pod b/git-debrebase.5.pod index af9b91a0..52fb60b9 100644 --- a/git-debrebase.5.pod +++ b/git-debrebase.5.pod @@ -15,6 +15,8 @@ as a series of individual git commits, which can worked on with rebase, and also shared. +=head2 DISCUSSION + git-debrebase is designed to work well with dgit. git-debrebase can also be used in workflows without source packages, for example to work on Debian-format packages outside or alongside Debian. @@ -24,9 +26,14 @@ itself is not very suitable for use by Debian derivatives, to work on packages inherited from Debian, because it assumes that you want to throw away any packaging provided by your upstream. -However, of git-debrebase in Debian does not make anything harder for +However, use of git-debrebase in Debian does not make anything harder for derivatives, and it can make some things easier. +When using gitk on branches managed by git-debrebase, +B, B +and B (or B) +produce more useful output than the default. + =head1 TERMINOLOGY =over @@ -123,7 +130,7 @@ See L. -/- pseudomerge; contents are identical to / parent lower on diagram. - % dgit-generated commit of debian/patches. + % dgit- or git-debrebase- generated commit of debian/patches. `3.0 (quilt)' only; generally dropped by git-debrebase. * Maintainer's HEAD was here while they were editing, @@ -177,7 +184,7 @@ known as B. While a branch is unstitched, it is not in interchange format. The previous interchange branch tip -tip is recorded, +is recorded, so that the previous history and the user's work can later be @@ -381,8 +388,8 @@ general merges on any of the relevant branches. For this reason the tools will try to help the user avoid divergence of the interchange branch. -See dgit-maint-rebase(7) XXX TBD -for a discussio of what kinds of behaviours +See dgit-maint-rebase(7) +for a discussion of what kinds of behaviours should be be avoided because they might generate such merges. @@ -401,7 +408,7 @@ Nonlinear (merging) history in the breakwater branch is in principle tolerable, but each of the parents would have to be, in turn, a breakwater, -and difficult qeustions arise if they don't have the same anchor. +and difficult questions arise if they don't have the same anchor. We use the commit message annotation to distinguish the special anchor merges from other general merges, @@ -501,6 +508,7 @@ The full set of annotations is: [git-debrebase upstream-combine . PIECE[ PIECE...]: new upstream] [git-debrebase anchor: new upstream NEW-UPSTREAM-VERSION, merge] [git-debrebase: new upstream NEW-UPSTREAM-VERSION, changelog] + [git-debrebase: export and commit patches] [git-debrebase convert-from-gbp: drop patches] [git-debrebase anchor: declare upstream] @@ -510,7 +518,8 @@ The full set of annotations is: Only anchor merges have the C<[git-debrebase anchor: ...]> tag. Single-parent anchors are not generated by git-debrebase, -and when made manually should not be tagged. +and when made manually should not +contain any C<[git-debrebase ...]> annotation. The C and C tags are added to the pre-existing commit message,