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(5)>.
19 For background, theory of operation,
20 and definitions see L<git-debrebase(5)>.
22 You should read this manpage in conjunction 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 Analyise the current branch,
61 both in terms of its conents,
62 and the refs which are relevant to git-debrebase,
63 and print 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-v0 <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.
138 The <upstream-details> are, optionally, in order:
142 =item <upstream-commit-ish>
144 The new upstream branch (or commit-ish).
145 Default is C<upstream>.
147 It is a snag if the upstream contains a debian/ directory;
148 if forced to proceed,
149 git-debrebase will disregard the upstream's debian/ and
150 take (only) the packaging from the current breakwater.
152 =item <piece-name> <piece-upstream-commit-ish>
154 Specifies that this is a multi-piece upstream.
157 When such a pair is specified,
158 git-debrebase will first combine the pieces of the upstream
160 and then use the result as the combined new upstream.
162 For each <piece-name>,
163 the tree of the <piece-upstream-commit-ish>
164 becomes the subdirectory <piece-name>
165 in the combined new upstream
166 (supplanting any subdirectory that might be there in
167 the main upstream branch).
169 <piece-name> has a restricted syntax:
170 it may contain only ASCII alphanumerics and hyphens.
172 The combined upstream is itself recorded as a commit,
173 with each of the upstream pieces' commits as parents.
174 The combined commit contains an annotation
175 to allow a future git-debrebase new upstream operation
176 to make the coherency checks described above.
178 =item <git-rebase options>
180 These will be passed to git rebase.
182 If the upstream rebase is troublesome, -i may be helpful.
183 As with plain git-debrebase,
184 do not specify a base, or --onto, or --fork-point.
188 If you are planning to generate a .dsc,
189 you will also need to have, or generate,
190 actual orig tarball(s),
191 which must be identical to the rev-spec(s)
192 passed to git-debrebase.
193 git-debrebase does not concern itself with source packages
194 so neither helps with this, nor checks it.
196 L<git-archive(1)>, L<dgit(1)> and
197 L<gbp-import-orig(1)> may be able to help.
199 This subcommand has -v0 in its name because we are not yet sure
200 that its command line syntax is optimal.
201 We may want to introduce an incompatible replacement syntax
202 under the name C<new-upstream>.
204 =item git-debrebase make-patches
206 Generate patches in debian/patches/
207 representing the changes made to upstream files.
209 It is not normally necessary to run this command explicitly.
210 When uploading to Debian,
211 dgit and git-debrebase
212 will cooperate to regenerate patches as necessary.
213 When working with pure git remotes,
214 the patches are not needed.
216 Normally git-debrebase make-patches will
217 require a laundered branch.
218 (A laundered branch does not contain any patches.)
219 But if there are already some patches made by
220 git-debrebase make-patches,
221 and all that has happened is that more
222 changes to upstream files have been committed,
223 running it again can add the missing patches.
225 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
227 Cnnverts a gbp patches-unapplied branch
228 (not a gbp pq patch queue branch)
229 into a git-debrebase interchange branch.
231 This is done by generating a new anchor merge,
232 converting the quilt patches as a delta queue,
233 and dropping the patches from the tree.
235 The upstream commit-ish should correspond to
236 the gbp upstream branch, if there is one.
237 It is a snag if it is not an ancestor of HEAD,
238 or if the history between the upstream and HEAD
239 contains commits which make changes to upstream files.
241 It is also a snag if the specified upstream
242 has a debian/ subdirectory.
243 This check exists to detect certain likely user errors,
244 but if this situation is true and expected,
247 The result is a well-formed git-debrebase interchange branch.
248 The result is also fast-forward from the gbp branch.
250 Note that it is dangerous not to know whether you are
251 dealing with a gbp patches-unappled branch containing quilt patches,
252 or a git-debrebase interchange branch.
254 using the wrong tool for the branch format might result in
255 a dropped patch queue!
259 =head1 UNDERLYING AND SUPPLEMENTARY OPERATIONS
263 =item git-debrebase breakwater
265 Prints the breakwater tip commitid.
266 If your HEAD branch is not fully laundered,
267 prints the tip of the so-far-laundered breakwater.
269 =item git-debrebase anchor
271 Prints the breakwater anchor commitid.
273 =item git-debrebase analyse
275 Walks the history of the current branch,
276 most recent commit first,
277 back until the most recent anchor,
278 printing the commit object id,
279 and commit type and info
280 (ie the semantics in the git-debrebase model)
283 =item git-debrebase record-ffq-prev
285 Establishes the current branch's ffq-prev,
286 as discussed in L</UNSTITCHING AND LAUNDERING>,
287 but does not launder the branch or move HEAD.
289 It is an error if the ffq-prev could not be recorded.
290 It is also an error if an ffq-prev has already been recorded,
293 =item git-debrebase launder-v0
295 Launders the branch without recording anything in ffq-prev.
296 Then prints some information about the current branch.
297 Do not use this operation;
298 it will be withdrawn soon.
300 =item git-debrebase convert-to-gbp
302 Converts a laundered branch into a
303 gbp patches-unapplied branch containing quilt patches.
304 The result is not fast forward from the interchange branch,
305 and any ffq-prev is deleted.
307 This is provided mostly for the test suite
308 and for unusual situations.
309 It should only be used with a care and
310 with a proper understanding of the underlying theory.
312 Be sure to not accidentally treat the result as
313 a git-debrebase branch,
314 or you will drop all the patches!
320 This section documents the general options
322 (ie, the ones which immediately follow
326 on the command line).
327 Individual operations may have their own options which are
328 docuented under each operation.
334 Turns snag(s) with id <snag-id> into warnings.
336 Some troublesome things which git-debrebase encounters
338 (The specific instances are discussed
339 in the text for the relvant operation.)
341 When a snag is detected,
342 a message is printed to stderr containing the snag id
343 (in the form C<-f<snag-idE<gt>>),
344 along with some prose.
346 If snags are detected, git-debrebase does not continue,
347 unless the relevant -f<snag-id> is specified,
348 or --force is specified.
352 Turns all snags into warnings.
353 See the -f<snag-id> option.
355 Do not invoke git-debrebase --force in scripts and aliases;
356 instead, specify the particular -f<snag-id> for expected snags.
360 Suppresses the error in
361 some situations where git-debrebase does nothing,
362 because there is nothing to do.
364 The specific instances are discussed
365 in the text for the relvant operation.
367 =item --anchor=<commit-ish>
369 Treats <commit-ish> as an anchor.
370 This overrides the usual logic which automatically classifies
371 commits as anchors, pseudomerges, delta queue commits, etc.
373 It also disables some coherency checks
374 which depend on metadata extracted from its commit message,
376 it is a snag if <commit-ish> is the anchor
377 for the previous upstream version in
378 git-debrebase new-upstream operations.
382 Requests (more) debugging. May be repeated.
386 =head1 UNSTITCHING AND LAUNDERING
388 Several operations unstitch and launder the branch first.
389 In detail this means:
391 =head2 Establish the current branch's ffq-prev
393 If ffq-prev is not yet recorded,
394 git-debrebase checks that the current branch is ahead of relevant
395 remote tracking branches.
396 The relevant branches depend on
397 the current branch (and its
405 The branch that git would merge from
406 (remote.<branch>.merge, remote.<branch>.remote);
410 The branch git would push to, if different
411 (remote.<branch>.pushRemote etc.);
415 For local dgit suite branches,
416 the corresponding tracking remote;
420 If you are on C<master>,
421 remotes/dgit/dgit/sid.
425 The apparently relevant ref names to check are filtered through
426 branch.<branch>.ffq-ffrefs,
427 which is a semicolon-separated list of glob patterns,
428 each optionally preceded by !; first match wins.
430 In each case it is a snag if
431 the local HEAD is behind the checked remote,
432 or if local HEAD has diverged from it.
433 All the checks are done locally using the remote tracking refs:
434 git-debrebase does not fetch anything from anywhere.
436 If these checks pass,
438 git-debrebse then records the current tip as ffq-prev.
440 =head2 Examine the branch
443 analyses the current HEAD's history to find the anchor
445 and the most recent breakwater tip.
447 =head2 Rewrite the commits into laundered form
449 Mixed debian+upstream commits are split into two commits each.
450 Delta queue (upstream files) commits bubble to the top.
452 and quilt patch additions,
455 This rewrite will always succeed, by construction.
456 The result is the laundered branch.
461 dgit-maint-rebase(7),