X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=dgit-maint-debrebase.7.pod;h=b4330f9d8a6804088ae7a45659bc4b26580bb7a0;hp=fb7c1e18cf60f003c08d8de43d34166b3e45a68d;hb=0a6ed24d826439ab82b17087bb6fcdf7b4415291;hpb=130db7d9bae45f6a5777c841dd97356b7335a98c diff --git a/dgit-maint-debrebase.7.pod b/dgit-maint-debrebase.7.pod index fb7c1e18..b4330f9d 100644 --- a/dgit-maint-debrebase.7.pod +++ b/dgit-maint-debrebase.7.pod @@ -209,47 +209,79 @@ patching the upstream source. This section explains how to convert an existing Debian package to this workflow. It should be skipped when debianising a new package. -=head2 No existing git history +If you have an existing git history that you have pushed to an +ordinary git server like B, we start with that. If +you don't already have it locally, you'll need to clone it, and obtain +the corresponding orig.tar from the archive: + +=over 4 + + % git clone salsa.debian.org:Debian/foo + % cd foo + % dgit setup-new-tree + % origtargz + +=back + +If you don't have any existing git history, or you have history only +on the special B server, we start with B: =over 4 % dgit clone foo % cd foo + +=back + +Then we make new upstream tags available: + +=over 4 + % git remote add -f upstream https://some.upstream/foo.git =back -=head2 Existing git history using another workflow +We now use a B command to convert your +existing history to the git-debrebase(5) data model. Which command +you should use depends on some facts about your repository: + +=over 4 -First, if you don't already have the git history locally, clone it, -and obtain the corresponding orig.tar from the archive: +=item (A) There is no delta queue. + +If there do not exist any Debian patches, use =over 4 - % git clone salsa.debian.org:Debian/foo - % cd foo - % origtargz + % git debrebase convert-from-gbp =back -If your tree is patches-unapplied, some conversion work is needed. -You can use +=item (B) There is a delta queue, and patches are unapplied. + +This is the standard git-buildpackage(1) workflow: there are Debian +patches, but the upstream source is committed to git without those +patches applied. Use =over 4 - git debrebase convert-from-gbp + % git debrebase convert-from-gbp =back -Then make new upstream tags available: +=item (C) There is a delta queue, and patches are applied. + +Use =over 4 - % git remote add -f upstream https://some.upstream/foo.git + % git debrebase convert-from-dgit-view + +=back =back -Now you simply need to ensure that your git HEAD is dgit-compatible, +Finally, you need to ensure that your git HEAD is dgit-compatible, i.e., it is exactly what you would get if you deleted .git, invoked B, and then unpacked the resultant source package. @@ -258,8 +290,6 @@ To achieve this, you might need to delete I. One way to have dgit check your progress is to run B. -The first dgit push will require I<--overwrite>. - =head1 GIT CONFIGURATION git-debrebase(1) does not yet support using B to merge @@ -323,7 +353,7 @@ or if you have a working watch file =over 4 - % git debrebase new-upstream-v0 1.2.3 + % git debrebase new-upstream 1.2.3 =back @@ -406,7 +436,8 @@ is a single debrebase stitch. =head1 BUILDING AND UPLOADING You can use dpkg-buildpackage(1) for test builds. When you are ready -to build for an upload, use B. +to build for an upload, use B, B or B. Upload with B or B. Remember to pass I<--new> if the package is new in the target suite. @@ -427,6 +458,53 @@ Note that this will introduce a new pseudomerge. After dgit pushing, be sure to git push to B, if you're using that. +=head1 INSPECTING THE HISTORY + +The git history made by git-debrebase can seem complicated. +Here are some suggestions for helpful invocations of gitk and git. +They can be adapted for other tools like tig, git log, etc. + +=over + +=item History of package in Debian (disregarding history from upstream): + + % gitk --first-parent + +In a laundered branch, the delta queue is at the top. + +=item History of the packaging (excluding the delta queue) + + % gitk :/debian :!/debian/patches + +=item Just the delta queue (ie, Debian's changes to upstream): + + % gitk --first-parent -- :/ :!/debian + +=item Full history including old versions of the delta queue: + + % gitk --date-order + +The "Declare fast forward" commits you see have an older history +(usually, an older delta queue) as one parent, +and a newer history as the other. +--date-order makes gitk show the delta queues in the right order. + +=item Show complete diff since the last upload: + + % git diff dgit/dgit/sid..HEAD -- :/ :!/debian/patches +(Includes changes to upstream files.) + +=item Interdiff of delta queue since last upload, if you really want that: + + % git debrebase make-patches + % git diff dgit/dgit/sid..HEAD -- debian/patches + +=back + +Also of course there is + + % git debrebase status + =head1 HANDLING DFSG-NON-FREE MATERIAL =head2 Illegal material @@ -456,7 +534,7 @@ For the first upstream release that requires DFSG filtering: % git commit -m "upstream version 1.2.3 DFSG-cleaned" % git tag -s 1.2.3+dfsg % git checkout master - % # proceed with "Importing the release" + % # proceed with "Importing the release" on 1.2.3+dfsg tag =back @@ -470,7 +548,7 @@ And for subsequent releases (whether or not they require filtering): % git commit -m "upstream version 1.2.4 DFSG-cleaned" # if needed % git tag -s 1.2.4+dfsg % git checkout master - % # proceed with "Importing the release" + % # proceed with "Importing the release" on 1.2.4+dfsg tag =back @@ -567,15 +645,22 @@ than sending files from I. =head2 Upstream branches -Except in the case where upstream releases only tarballs, or we -require DFSG filtering, we do not maintain a separate 'upstream' -branch (unless you also happen to be involved in upstream -development). We work with upstream tags rather than any branches -(except temporary branches used to prepare patches for forwarding -upstream, for example). +In this workflow, we specify upstream tags rather than any branches. + +Except when (i) upstream releases only tarballs, (ii) we require DFSG +filtering, or (iii) you also happen to be involved in upstream +development, we do not maintain any local branch corresponding to +upstream, except temporary branches used to prepare patches for +forwarding, and the like. The idea here is that from Debian's point of view, upstream releases -are immutable points in history, and so better represented by tags. +are immutable points in history. We want to make sure that we are +basing our Debian package on a properly identified upstream version, +rather than some arbitrary commit on some branch. Tags are more +useful for this. + +Upstream's branches remain available as the git remote tracking +branches for your upstream remote, e.g. I. =head2 The first ever dgit push @@ -611,17 +696,23 @@ using git-rebase(1) directly. For example, =over 4 - % git debrebase launder + % git debrebase % git rebase -i HEAD~5 # there are 4 Debian patches =back If you take this approach, you should be very careful not to start the -rebase too early. +rebase too early, +including before the most recent pseudomerge. +git-rebase without a base argument will often +start the rebase too early, +and should be avoided. +Run git-debrebase instead. +See also "ILLEGAL OPERATIONS" in git-debrebase(5). =head1 SEE ALSO -dgit(1), dgit(7) +dgit(1), dgit(7), git-debrebase(1), git-debrebase(5) =head1 AUTHOR