3 git-debrebase - delta queue rebase tool for Debian packaging
7 git-debrebase [<options...>] [-- <git-rebase options...>]
8 git-debrebase [<options...>] <operation> [<operation options...>
12 git-debrebase is a tool for representing in git,
14 Debian packages based on upstream source code.
16 This is the command line reference.
17 Please read the tutorial
18 L<dgit-maint-debrebase(7)>.
19 For background, theory of operation,
20 and definitions see L<git-debrebase(5)>.
22 You should read this manpage in cojnunction with
23 L<git-debrebase(5)/TERMINOLOGY>,
24 which defines many important terms used here.
26 =head1 PRINCIPAL OPERATIONS
30 =item git-debrebase [-- <git-rebase options...>]
32 =item git-debrebase [-i <further git-rebase options...>]
34 Unstitches and launders the branch.
35 (See L</UNSTITCHING AND LAUNDERING> below.)
37 Then, if any git-rebase options were supplied,
38 edits the Debian delta queue,
39 using git-rebase, by running
41 git rebase <git-rebase options> <breakwater-tip>
43 Do not pass a base branch argument:
44 git-debrebase will supply that.
45 Do not use --onto, or --fork-point.
46 Useful git-rebase options include -i and --autosquash.
48 If git-rebase stops for any reason,
49 you may git-rebase --abort, --continue, or --skip, as usual.
50 If you abort the git-rebase,
51 the branch will still have been laundered,
52 but everything in the rebase will be undone.
54 The options for git-rebase must either start with C<-i>,
55 or be prececded by C<-->,
56 to distinguish them from options for git-debrebase.
58 =item git-debrebase status
60 Analyses the current branch,
61 both in terms of its contents,
62 and the refs which are relevant to git-debrebase,
63 and prints a human-readable summary.
65 Please do not attempt to parse the output;
66 it may be reformatted or reorganised in the future.
68 use one of the L<UNDERLYING AND SUPPLEMENTARY OPERATIONS>
71 =item git-debrebase conclude
73 Finishes a git-debrebase session,
74 tidying up the branch and making it fast forward again.
76 Specifically: if the branch is unstitched,
77 launders and restitches it,
78 making a new pseudomerge.
79 Otherwise, it is an error,
82 =item git-debrebase quick
84 Unconditionally launders and restitches the branch,
85 consuming any ffq-prev
86 and making a new pseudomerge.
88 If the branch is already laundered and stitched, does nothing.
90 =item git-debrebase prepush [--prose=<for commit message>]
92 =item git-debrebase stitch [--prose=<for commit message>]
96 This is a good command to run before pushing to a git server.
98 If there is no ffq-prev, it is an error, unless --noop-ok.
100 You should consider using B<conclude> instead,
101 because that launders the branch too.
103 =item git-debrebase new-upstream <new-version> [<upstream-details>...]
105 Rebases the delta queue
106 onto a new upstream version. In detail:
108 Firstly, checks that the proposed rebase seems to make sense:
109 It is a snag unless the new upstream(s)
110 are fast forward from the previous upstream(s)
111 as found in the current breakwater anchor.
112 And, in the case of a multi-piece upstream
113 (a multi-component upstream, in dpkg-source terminology),
114 if the pieces are not in the same order, with the same names.
116 If all seems well, unstitches and launders the branch.
120 (in a private working area)
121 a new anchor merge commit,
122 on top of the breakwater tip,
123 and on top of that a commit to
124 update the version number in debian/changelog.
128 of the delta queue onto these new commits.
130 That git-rebase may complete successfully,
131 or it may require your assistance,
132 just like a normal git-rebase.
134 If you git-rebase --abort,
135 the whole new upstream operation is aborted,
136 except for the laundering.
139 may be whole new Debian version, including revision,
140 or just the upstream part,
141 in which case -1 will be appended
142 to make the new Debian version.
144 The <upstream-details> are, optionally, in order:
148 =item <upstream-commit-ish>
150 The new upstream branch (or commit-ish).
151 The default is to look for one of these tags, in this order:
153 where U is the new upstream version.
154 (This is the same algorithm as L<git-deborig(1)>.)
156 It is a snag if the upstream contains a debian/ directory;
157 if forced to proceed,
158 git-debrebase will disregard the upstream's debian/ and
159 take (only) the packaging from the current breakwater.
161 =item <piece-name> <piece-upstream-commit-ish>
163 Specifies that this is a multi-piece upstream.
166 When such a pair is specified,
167 git-debrebase will first combine the pieces of the upstream
169 and then use the result as the combined new upstream.
171 For each <piece-name>,
172 the tree of the <piece-upstream-commit-ish>
173 becomes the subdirectory <piece-name>
174 in the combined new upstream
175 (supplanting any subdirectory that might be there in
176 the main upstream branch).
178 <piece-name> has a restricted syntax:
179 it may contain only ASCII alphanumerics and hyphens.
181 The combined upstream is itself recorded as a commit,
182 with each of the upstream pieces' commits as parents.
183 The combined commit contains an annotation
184 to allow a future git-debrebase new upstream operation
185 to make the coherency checks described above.
187 =item <git-rebase options>
189 These will be passed to git rebase.
191 If the upstream rebase is troublesome, -i may be helpful.
192 As with plain git-debrebase,
193 do not specify a base, or --onto, or --fork-point.
197 If you are planning to generate a .dsc,
198 you will also need to have, or generate,
199 actual orig tarball(s),
200 which must be identical to the rev-spec(s)
201 passed to git-debrebase.
202 git-debrebase does not concern itself with source packages
203 so neither helps with this, nor checks it.
205 L<git-archive(1)>, L<dgit(1)> and
206 L<gbp-import-orig(1)> may be able to help.
208 =item git-debrebase make-patches [--quiet-would-amend]
210 Generate patches in debian/patches/
211 representing the changes made to upstream files.
213 It is not normally necessary to run this command explicitly.
214 When uploading to Debian,
215 dgit and git-debrebase
216 will cooperate to regenerate patches as necessary.
217 When working with pure git remotes,
218 the patches are not needed.
220 Normally git-debrebase make-patches will
221 require a laundered branch.
222 (A laundered branch does not contain any patches.)
223 But if there are already some patches made by
224 git-debrebase make-patches,
225 and all that has happened is that more
226 changes to upstream files have been committed,
227 running it again can add the missing patches.
229 If the patches implied by the current branch
230 are not a simple superset of those already in debian/patches,
231 make-patches will fail with exit status 7,
232 and an error message.
233 (The message can be suppress with --quiet-would-amend.)
234 If the problem is simply that
235 the existing patches were not made by git-debrebase,
236 using dgit quilt-fixup instead should succeed.
238 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
240 Cnnverts a gbp patches-unapplied branch
241 (not a gbp pq patch queue branch)
242 into a git-debrebase interchange branch.
244 This is done by generating a new anchor merge,
245 converting the quilt patches as a delta queue,
246 and dropping the patches from the tree.
248 The upstream commit-ish should correspond to
249 the gbp upstream branch, if there is one.
250 It is a snag if it is not an ancestor of HEAD,
251 or if the history between the upstream and HEAD
252 contains commits which make changes to upstream files.
254 It is also a snag if the specified upstream
255 has a debian/ subdirectory.
256 This check exists to detect certain likely user errors,
257 but if this situation is true and expected,
260 The result is a well-formed git-debrebase interchange branch.
261 The result is also fast-forward from the gbp branch.
263 Note that it is dangerous not to know whether you are
264 dealing with a gbp patches-unappled branch containing quilt patches,
265 or a git-debrebase interchange branch.
267 using the wrong tool for the branch format might result in
268 a dropped patch queue!
272 =head1 UNDERLYING AND SUPPLEMENTARY OPERATIONS
276 =item git-debrebase breakwater
278 Prints the breakwater tip commitid.
279 If your HEAD branch is not fully laundered,
280 prints the tip of the so-far-laundered breakwater.
282 =item git-debrebase anchor
284 Prints the breakwater anchor commitid.
286 =item git-debrebase analyse
288 Walks the history of the current branch,
289 most recent commit first,
290 back until the most recent anchor,
291 printing the commit object id,
292 and commit type and info
293 (ie the semantics in the git-debrebase model)
296 =item git-debrebase record-ffq-prev
298 Establishes the current branch's ffq-prev,
299 as discussed in L</UNSTITCHING AND LAUNDERING>,
300 but does not launder the branch or move HEAD.
302 It is an error if the ffq-prev could not be recorded.
303 It is also an error if an ffq-prev has already been recorded,
306 =item git-debrebase launder-v0
308 Launders the branch without recording anything in ffq-prev.
309 Then prints some information about the current branch.
310 Do not use this operation;
311 it will be withdrawn soon.
313 =item git-debrebase convert-to-gbp
315 Converts a laundered branch into a
316 gbp patches-unapplied branch containing quilt patches.
317 The result is not fast forward from the interchange branch,
318 and any ffq-prev is deleted.
320 This is provided mostly for the test suite
321 and for unusual situations.
322 It should only be used with a care and
323 with a proper understanding of the underlying theory.
325 Be sure to not accidentally treat the result as
326 a git-debrebase branch,
327 or you will drop all the patches!
333 This section documents the general options
335 (ie, the ones which immediately follow
339 on the command line).
340 Individual operations may have their own options which are
341 docuented under each operation.
347 Turns snag(s) with id <snag-id> into warnings.
349 Some troublesome things which git-debrebase encounters
351 (The specific instances are discussed
352 in the text for the relevant operation.)
354 When a snag is detected,
355 a message is printed to stderr containing the snag id
356 (in the form C<-f<snag-idE<gt>>),
357 along with some prose.
359 If snags are detected, git-debrebase does not continue,
360 unless the relevant -f<snag-id> is specified,
361 or --force is specified.
365 Turns all snags into warnings.
366 See the -f<snag-id> option.
368 Do not invoke git-debrebase --force in scripts and aliases;
369 instead, specify the particular -f<snag-id> for expected snags.
373 Suppresses the error in
374 some situations where git-debrebase does nothing,
375 because there is nothing to do.
377 The specific instances are discussed
378 in the text for the relvant operation.
380 =item --anchor=<commit-ish>
382 Treats <commit-ish> as an anchor.
383 This overrides the usual logic which automatically classifies
384 commits as anchors, pseudomerges, delta queue commits, etc.
386 It also disables some coherency checks
387 which depend on metadata extracted from its commit message,
389 it is a snag if <commit-ish> is the anchor
390 for the previous upstream version in
391 git-debrebase new-upstream operations.
395 Requests (more) debugging. May be repeated.
399 =head1 UNSTITCHING AND LAUNDERING
401 Several operations unstitch and launder the branch first.
402 In detail this means:
404 =head2 Establish the current branch's ffq-prev
406 If ffq-prev is not yet recorded,
407 git-debrebase checks that the current branch is ahead of relevant
408 remote tracking branches.
409 The relevant branches depend on
410 the current branch (and its
418 The branch that git would merge from
419 (remote.<branch>.merge, remote.<branch>.remote);
423 The branch git would push to, if different
424 (remote.<branch>.pushRemote etc.);
428 For local dgit suite branches,
429 the corresponding tracking remote;
433 If you are on C<master>,
434 remotes/dgit/dgit/sid.
438 The apparently relevant ref names to check are filtered through
439 branch.<branch>.ffq-ffrefs,
440 which is a semicolon-separated list of glob patterns,
441 each optionally preceded by !; first match wins.
443 In each case it is a snag if
444 the local HEAD is behind the checked remote,
445 or if local HEAD has diverged from it.
446 All the checks are done locally using the remote tracking refs:
447 git-debrebase does not fetch anything from anywhere.
449 If these checks pass,
451 git-debrebse then records the current tip as ffq-prev.
453 =head2 Examine the branch
456 analyses the current HEAD's history to find the anchor
458 and the most recent breakwater tip.
460 =head2 Rewrite the commits into laundered form
462 Mixed debian+upstream commits are split into two commits each.
463 Delta queue (upstream files) commits bubble to the top.
465 and quilt patch additions,
468 This rewrite will always succeed, by construction.
469 The result is the laundered branch.
474 dgit-maint-rebase(7),