chiark / gitweb /
dgit: build_source mostly uses a playtree, not $maindir
[dgit.git] / git-debrebase.1.pod
1 =head1 NAME
2
3 git-debrebase - delta queue rebase tool for Debian packaging
4
5 =head1 SYNOPSYS
6
7  git-debrebase [<options...>] [-- <git-rebase options...>]
8  git-debrebase [<options...>] <operation> [<operation options...>
9
10 =head1 INTRODUCTION
11
12 git-debrebase is a tool for representing in git,
13 and manpulating,
14 Debian packages based on upstream source code.
15
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)>.
21
22 You should read this manpage in cojnunction with
23 L<git-debrebase(5)/TERMINOLOGY>,
24 which defines many important terms used here.
25
26 =head1 PRINCIPAL OPERATIONS
27
28 =over
29
30 =item git-debrebase [-- <git-rebase options...>]
31
32 =item git-debrebase [-i <further git-rebase options...>]
33
34 Unstitches and launders the branch.
35 (See L</UNSTITCHING AND LAUNDERING> below.)
36
37 Then, if any git-rebase options were supplied,
38 edits the Debian delta queue,
39 using git-rebase, by running
40
41     git rebase <git-rebase options> <breakwater-tip>
42
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.
47
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.
53
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.
57
58 =item git-debrebase status
59
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.
64
65 Please do not attempt to parse the output;
66 it may be reformatted or reorganised in the future.
67 Instead,
68 use one of the L<UNDERLYING AND SUPPLEMENTARY OPERATIONS>
69 described below.
70
71 =item git-debrebase conclude
72
73 Finishes a git-debrebase session,
74 tidying up the branch and making it fast forward again.
75
76 Specifically: if the branch is unstitched,
77 launders and restitches it,
78 making a new pseudomerge.
79 Otherwise, it is an error,
80 unless --noop-ok.
81
82 =item git-debrebase quick
83
84 Unconditionally launders and restitches the branch,
85 consuming any ffq-prev
86 and making a new pseudomerge.
87
88 If the branch is already laundered and stitched, does nothing.
89
90 =item git-debrebase prepush [--prose=<for commit message>]
91
92 =item git-debrebase stitch [--prose=<for commit message>]
93
94 Stitches the branch,
95 consuming ffq-prev.
96 This is a good command to run before pushing to a git server.
97
98 If there is no ffq-prev, it is an error, unless --noop-ok.
99
100 You should consider using B<conclude> instead,
101 because that launders the branch too.
102
103 =item git-debrebase new-upstream <new-version> [<upstream-details>...]
104
105 Rebases the delta queue
106 onto a new upstream version.  In detail:
107
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.
115
116 If all seems well, unstitches and launders the branch.
117
118 Then,
119 generates
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.
125
126 Finally,
127 starts a git-rebase
128 of the delta queue onto these new commits.
129
130 That git-rebase may complete successfully,
131 or it may require your assistance,
132 just like a normal git-rebase.
133
134 If you git-rebase --abort,
135 the whole new upstream operation is aborted,
136 except for the laundering.
137
138 <new-version>
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.
143
144 The <upstream-details> are, optionally, in order:
145
146 =over
147
148 =item <upstream-commit-ish>
149
150 The new upstream branch (or commit-ish).
151 The default is to look for one of these tags, in this order:
152 U vU upstream/U;
153 where U is the new upstream version.
154 (This is the same algorithm as L<git-deborig(1)>.)
155
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.
160
161 =item <piece-name> <piece-upstream-commit-ish>
162
163 Specifies that this is a multi-piece upstream.
164 May be repeated.
165
166 When such a pair is specified,
167 git-debrebase will first combine the pieces of the upstream
168 together,
169 and then use the result as the combined new upstream.
170
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).
177
178 <piece-name> has a restricted syntax:
179 it may contain only ASCII alphanumerics and hyphens.
180
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.
186
187 =item <git-rebase options>
188
189 These will be passed to git rebase.
190
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.
194
195 =back
196
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.
204 L<git-deborig(1)>,
205 L<git-archive(1)>, L<dgit(1)> and
206 L<gbp-import-orig(1)> may be able to help.
207
208 =item git-debrebase make-patches [--quiet-would-amend]
209
210 Generate patches in debian/patches/
211 representing the changes made to upstream files.
212
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.
219
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.
228
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.
237
238 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
239
240 Cnnverts a gbp patches-unapplied branch
241 (not a gbp pq patch queue branch)
242 into a git-debrebase interchange branch.
243
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.
247
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.
253
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,
258 forcing it is fine.
259
260 git-debrebase will try to look for the dgit archive view
261 of the most recent release,
262 and if it finds it will make a pseduomerge so that
263 your new git-debrebase view is appropriately fast forward.
264
265 The result is a well-formed git-debrebase interchange branch.
266 The result is also fast-forward from the gbp branch.
267
268 It is a snag if the new branch looks like it will have diverged,
269 just as for a laundering/unstitching call to git-debrebase;
270 See L</Establish the current branch's ffq-prev>, below.
271
272 Note that it is dangerous not to know whether you are
273 dealing with a gbp patches-unappled branch containing quilt patches,
274 or a git-debrebase interchange branch.
275 At worst,
276 using the wrong tool for the branch format might result in
277 a dropped patch queue!
278
279 =back
280
281 =head1 UNDERLYING AND SUPPLEMENTARY OPERATIONS
282
283 =over
284
285 =item git-debrebase breakwater
286
287 Prints the breakwater tip commitid.
288 If your HEAD branch is not fully laundered,
289 prints the tip of the so-far-laundered breakwater.
290
291 =item git-debrebase anchor
292
293 Prints the breakwater anchor commitid.
294
295 =item git-debrebase analyse
296
297 Walks the history of the current branch,
298 most recent commit first,
299 back until the most recent anchor,
300 printing the commit object id,
301 and commit type and info
302 (ie the semantics in the git-debrebase model)
303 for each commit.
304
305 =item git-debrebase record-ffq-prev
306
307 Establishes the current branch's ffq-prev,
308 as discussed in L</UNSTITCHING AND LAUNDERING>,
309 but does not launder the branch or move HEAD.
310
311 It is an error if the ffq-prev could not be recorded.
312 It is also an error if an ffq-prev has already been recorded,
313 unless --noop-ok.
314
315 =item git-debrebase launder-v0
316
317 Launders the branch without recording anything in ffq-prev.
318 Then prints some information about the current branch.
319 Do not use this operation;
320 it will be withdrawn soon.
321
322 =item git-debrebase convert-to-gbp
323
324 Converts a laundered branch into a
325 gbp patches-unapplied branch containing quilt patches.
326 The result is not fast forward from the interchange branch,
327 and any ffq-prev is deleted.
328
329 This is provided mostly for the test suite
330 and for unusual situations.
331 It should only be used with a care and 
332 with a proper understanding of the underlying theory.
333
334 Be sure to not accidentally treat the result as
335 a git-debrebase branch,
336 or you will drop all the patches!
337
338 =back
339
340 =head1 OPTIONS
341
342 This section documents the general options
343 to git-debrebase
344 (ie, the ones which immediately follow
345 git-debrebase
346 or
347 git debrebase
348 on the command line).
349 Individual operations may have their own options which are
350 docuented under each operation.
351
352 =over
353
354 =item -f<snag-id>
355
356 Turns snag(s) with id <snag-id> into warnings.
357
358 Some troublesome things which git-debrebase encounters
359 are B<snag>s.
360 (The specific instances are discussed
361 in the text for the relevant operation.)
362
363 When a snag is detected,
364 a message is printed to stderr containing the snag id
365 (in the form C<-f<snag-idE<gt>>),
366 along with some prose.
367
368 If snags are detected, git-debrebase does not continue,
369 unless the relevant -f<snag-id> is specified,
370 or --force is specified.
371
372 =item --force
373
374 Turns all snags into warnings.
375 See the -f<snag-id> option.
376
377 Do not invoke git-debrebase --force in scripts and aliases;
378 instead, specify the particular -f<snag-id> for expected snags.
379
380 =item --noop-ok
381
382 Suppresses the error in
383 some situations where git-debrebase does nothing,
384 because there is nothing to do.
385
386 The specific instances are discussed
387 in the text for the relvant operation.
388
389 =item --anchor=<commit-ish>
390
391 Treats <commit-ish> as an anchor.
392 This overrides the usual logic which automatically classifies
393 commits as anchors, pseudomerges, delta queue commits, etc.
394
395 It also disables some coherency checks
396 which depend on metadata extracted from its commit message,
397 so
398 it is a snag if <commit-ish> is the anchor
399 for the previous upstream version in
400 git-debrebase new-upstream operations.
401
402 =item -D
403
404 Requests (more) debugging.  May be repeated.
405
406 =back
407
408 =head1 UNSTITCHING AND LAUNDERING
409
410 Several operations unstitch and launder the branch first.
411 In detail this means:
412
413 =head2 Establish the current branch's ffq-prev
414
415 If ffq-prev is not yet recorded,
416 git-debrebase checks that the current branch is ahead of relevant
417 remote tracking branches.
418 The relevant branches depend on
419 the current branch (and its
420 git configuration)
421 and are as follows:
422
423 =over
424
425 =item
426
427 The branch that git would merge from
428 (remote.<branch>.merge, remote.<branch>.remote);
429
430 =item
431
432 The branch git would push to, if different
433 (remote.<branch>.pushRemote etc.);
434
435 =item
436
437 For local dgit suite branches,
438 the corresponding tracking remote;
439
440 =item
441
442 If you are on C<master>,
443 remotes/dgit/dgit/sid.
444
445 =back
446
447 The apparently relevant ref names to check are filtered through
448 branch.<branch>.ffq-ffrefs,
449 which is a semicolon-separated list of glob patterns,
450 each optionally preceded by !; first match wins.
451
452 In each case it is a snag if
453 the local HEAD is behind the checked remote,
454 or if local HEAD has diverged from it.
455 All the checks are done locally using the remote tracking refs:
456 git-debrebase does not fetch anything from anywhere.
457
458 If these checks pass,
459 or are forced,
460 git-debrebse then records the current tip as ffq-prev.
461
462 =head2 Examine the branch
463
464 git-debrebase
465 analyses the current HEAD's history to find the anchor
466 in its breakwater,
467 and the most recent breakwater tip.
468
469 =head2 Rewrite the commits into laundered form
470
471 Mixed debian+upstream commits are split into two commits each.
472 Delta queue (upstream files) commits bubble to the top.
473 Pseudomerges,
474 and quilt patch additions,
475 are dropped.
476
477 This rewrite will always succeed, by construction.
478 The result is the laundered branch.
479
480 =head1 SEE ALSO
481
482 git-debrebase(1),
483 dgit-maint-rebase(7),
484 dgit(1),
485 gitglossary(7)