X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=git-debrebase.1.pod;h=273ef47dc1c13ee465d59950783a1f495b63763d;hp=4d4c85a94992b7e83f68d5e8a20212176ee658c6;hb=3751352480012499dcab49a6421770a7fc5986fe;hpb=ca261d36408442d8f3beeac12434af95810b1e32 diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod index 4d4c85a9..273ef47d 100644 --- a/git-debrebase.1.pod +++ b/git-debrebase.1.pod @@ -15,11 +15,11 @@ Debian packages based on upstream source code. This is the command line reference. Please read the tutorial -L. +L. For background, theory of operation, and definitions see L. -You should read this manpage in conjunction with +You should read this manpage in cojnunction with L, which defines many important terms used here. @@ -57,10 +57,10 @@ to distinguish them from options for git-debrebase. =item git-debrebase status -Analyise the current branch, -both in terms of its conents, +Analyses the current branch, +both in terms of its contents, and the refs which are relevant to git-debrebase, -and print a human-readable summary. +and prints a human-readable summary. Please do not attempt to parse the output; it may be reformatted or reorganised in the future. @@ -100,7 +100,7 @@ If there is no ffq-prev, it is an error, unless --noop-ok. You should consider using B instead, because that launders the branch too. -=item git-debrebase new-upstream-v0 [...] +=item git-debrebase new-upstream [...] Rebases the delta queue onto a new upstream version. In detail: @@ -135,6 +135,12 @@ If you git-rebase --abort, the whole new upstream operation is aborted, except for the laundering. + +may be whole new Debian version, including revision, +or just the upstream part, +in which case -1 will be appended +to make the new Debian version. + The are, optionally, in order: =over @@ -142,7 +148,10 @@ The are, optionally, in order: =item The new upstream branch (or commit-ish). -Default is C. +The default is to look for one of these tags, in this order: +U vU upstream/U; +where U is the new upstream version. +(This is the same algorithm as L.) It is a snag if the upstream contains a debian/ directory; if forced to proceed, @@ -196,11 +205,6 @@ L, L, L and L may be able to help. -This subcommand has -v0 in its name because we are not yet sure -that its command line syntax is optimal. -We may want to introduce an incompatible replacement syntax -under the name C. - =item git-debrebase make-patches [--quiet-would-amend] Generate patches in debian/patches/ @@ -227,6 +231,9 @@ are not a simple superset of those already in debian/patches, make-patches will fail with exit status 7, and an error message. (The message can be suppress with --quiet-would-amend.) +If the problem is simply that +the existing patches were not made by git-debrebase, +using dgit quilt-fixup instead should succeed. =item git-debrebase convert-from-gbp [] @@ -250,9 +257,18 @@ This check exists to detect certain likely user errors, but if this situation is true and expected, forcing it is fine. +git-debrebase will try to look for the dgit archive view +of the most recent release, +and if it finds it will make a pseduomerge so that +your new git-debrebase view is appropriately fast forward. + The result is a well-formed git-debrebase interchange branch. The result is also fast-forward from the gbp branch. +It is a snag if the new branch looks like it will have diverged, +just as for a laundering/unstitching call to git-debrebase; +See L, below. + Note that it is dangerous not to know whether you are dealing with a gbp patches-unappled branch containing quilt patches, or a git-debrebase interchange branch. @@ -342,7 +358,7 @@ Turns snag(s) with id into warnings. Some troublesome things which git-debrebase encounters are Bs. (The specific instances are discussed -in the text for the relvant operation.) +in the text for the relevant operation.) When a snag is detected, a message is printed to stderr containing the snag id