chiark / gitweb /
po4a: Fix gitignore to actually ignore right .po4a.LANG.cfg
[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 It is hazardous to use plain git-rebase on a git-debrebase branch,
59 because git-rebase has a tendency to start the rebase
60 too far back in history,
61 and then drop important commits.
62 Soo L<git-debrebase(5)/ILLEGAL OPERATIONS>
63
64 =item git-debrebase status
65
66 Analyses the current branch,
67 both in terms of its contents,
68 and the refs which are relevant to git-debrebase,
69 and prints a human-readable summary.
70
71 Please do not attempt to parse the output;
72 it may be reformatted or reorganised in the future.
73 Instead,
74 use one of the L<UNDERLYING AND SUPPLEMENTARY OPERATIONS>
75 described below.
76
77 =item git-debrebase conclude
78
79 Finishes a git-debrebase session,
80 tidying up the branch and making it fast forward again.
81
82 Specifically: if the branch is unstitched,
83 launders and restitches it,
84 making a new pseudomerge.
85 Otherwise, it is an error,
86 unless --noop-ok.
87
88 =item git-debrebase quick
89
90 Unconditionally launders and restitches the branch,
91 consuming any ffq-prev
92 and making a new pseudomerge.
93
94 If the branch is already laundered and stitched, does nothing.
95
96 =item git-debrebase prepush [--prose=<for commit message>]
97
98 If the branch is unstitched,
99 stitches it,
100 consuming ffq-prev.
101
102 This is a good command to run before pushing to a git server.
103 You should consider using B<conclude> instead,
104 because that launders the branch too.
105
106 =item git-debrebase stitch [--prose=<for commit message>]
107
108 Stitches the branch,
109 consuming ffq-prev.
110
111 If there is no ffq-prev, it is an error, unless --noop-ok.
112
113 You should consider using B<prepush> or B<conclude> instead.
114
115 =item git-debrebase scrap
116
117 Throws away all the work since the branch was last stitched.
118 This is done by rewinding you to ffq-prev.
119
120 If you are in the middle of a git-rebase, will abort that too.
121
122 =item git-debrebase new-upstream <new-version> [<upstream-details>...]
123
124 Rebases the delta queue
125 onto a new upstream version.  In detail:
126
127 Firstly, checks that the proposed rebase seems to make sense:
128 It is a snag unless the new upstream(s)
129 are fast forward from the previous upstream(s)
130 as found in the current breakwater anchor.
131 And, in the case of a multi-piece upstream
132 (a multi-component upstream, in dpkg-source terminology),
133 if the pieces are not in the same order, with the same names.
134
135 If all seems well, unstitches and launders the branch.
136
137 Then,
138 generates
139 (in a private working area)
140 a new anchor merge commit,
141 on top of the breakwater tip,
142 and on top of that a commit to
143 update the version number in debian/changelog.
144
145 Finally,
146 starts a git-rebase
147 of the delta queue onto these new commits.
148
149 That git-rebase may complete successfully,
150 or it may require your assistance,
151 just like a normal git-rebase.
152
153 If you git-rebase --abort,
154 the whole new upstream operation is aborted,
155 except for the laundering.
156
157 <new-version>
158 may be whole new Debian version, including revision,
159 or just the upstream part,
160 in which case -1 will be appended
161 to make the new Debian version.
162
163 The <upstream-details> are, optionally, in order:
164
165 =over
166
167 =item <upstream-commit-ish>
168
169 The new upstream branch (or commit-ish).
170 The default is to look for one of these tags, in this order:
171 U vU upstream/U;
172 where U is the new upstream version.
173 (This is the same algorithm as L<git-deborig(1)>.)
174
175 It is a snag if the upstream contains a debian/ directory;
176 if forced to proceed,
177 git-debrebase will disregard the upstream's debian/ and
178 take (only) the packaging from the current breakwater.
179
180 =item <piece-name> <piece-upstream-commit-ish>
181
182 Specifies that this is a multi-piece upstream.
183 May be repeated.
184
185 When such a pair is specified,
186 git-debrebase will first combine the pieces of the upstream
187 together,
188 and then use the result as the combined new upstream.
189
190 For each <piece-name>,
191 the tree of the <piece-upstream-commit-ish>
192 becomes the subdirectory <piece-name>
193 in the combined new upstream
194 (supplanting any subdirectory that might be there in
195 the main upstream branch).
196
197 <piece-name> has a restricted syntax:
198 it may contain only ASCII alphanumerics and hyphens.
199
200 The combined upstream is itself recorded as a commit,
201 with each of the upstream pieces' commits as parents.
202 The combined commit contains an annotation
203 to allow a future git-debrebase new upstream operation
204 to make the coherency checks described above.
205
206 =item <git-rebase options>
207
208 These will be passed to git rebase.
209
210 If the upstream rebase is troublesome, -i may be helpful.
211 As with plain git-debrebase,
212 do not specify a base, or --onto, or --fork-point.
213
214 =back
215
216 If you are planning to generate a .dsc,
217 you will also need to have, or generate,
218 actual orig tarball(s),
219 which must be identical to the rev-spec(s)
220 passed to git-debrebase.
221 git-debrebase does not concern itself with source packages
222 so neither helps with this, nor checks it.
223 L<git-deborig(1)>,
224 L<git-archive(1)>, L<dgit(1)> and
225 L<gbp-import-orig(1)> may be able to help.
226
227 =item git-debrebase make-patches [--quiet-would-amend]
228
229 Generate patches in debian/patches/
230 representing the changes made to upstream files.
231
232 It is not normally necessary to run this command explicitly.
233 When uploading to Debian,
234 dgit and git-debrebase
235 will cooperate to regenerate patches as necessary.
236 When working with pure git remotes,
237 the patches are not needed.
238
239 Normally git-debrebase make-patches will
240 require a laundered branch.
241 (A laundered branch does not contain any patches.)
242 But if there are already some patches made by
243 git-debrebase make-patches,
244 and all that has happened is that more
245 changes to upstream files have been committed,
246 running it again can add the missing patches.
247
248 If the patches implied by the current branch
249 are not a simple superset of those already in debian/patches,
250 make-patches will fail with exit status 7,
251 and an error message.
252 (The message can be suppress with --quiet-would-amend.)
253 If the problem is simply that
254 the existing patches were not made by git-debrebase,
255 using dgit quilt-fixup instead should succeed.
256
257 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
258
259 Cnnverts a gbp patches-unapplied branch
260 (not a gbp pq patch queue branch)
261 into a git-debrebase interchange branch.
262
263 This is done by generating a new anchor merge,
264 converting the quilt patches as a delta queue,
265 and dropping the patches from the tree.
266
267 The upstream commit-ish should correspond to
268 the gbp upstream branch, if there is one.
269 It is a snag if it is not an ancestor of HEAD,
270 or if the history between the upstream and HEAD
271 contains commits which make changes to upstream files.
272 If it is not specified,
273 the same algorithm is used as for git-debrebase new-upstream.
274
275 It is also a snag if the specified upstream
276 has a debian/ subdirectory.
277 This check exists to detect certain likely user errors,
278 but if this situation is true and expected,
279 forcing it is fine.
280
281 git-debrebase will try to look for the dgit archive view
282 of the most recent release,
283 and if it finds it will make a pseduomerge so that
284 your new git-debrebase view is appropriately fast forward.
285
286 The result is a well-formed git-debrebase interchange branch.
287 The result is also fast-forward from the gbp branch.
288
289 It is a snag if the new branch looks like it will have diverged,
290 just as for a laundering/unstitching call to git-debrebase;
291 See L</Establish the current branch's ffq-prev>, below.
292
293 Note that it is dangerous not to know whether you are
294 dealing with a gbp patches-unapplied branch containing quilt patches,
295 or a git-debrebase interchange branch.
296 At worst,
297 using the wrong tool for the branch format might result in
298 a dropped patch queue!
299
300 =back
301
302 =head1 UNDERLYING AND SUPPLEMENTARY OPERATIONS
303
304 =over
305
306 =item git-debrebase breakwater
307
308 Prints the breakwater tip commitid.
309 If your HEAD branch is not fully laundered,
310 prints the tip of the so-far-laundered breakwater.
311
312 =item git-debrebase anchor
313
314 Prints the breakwater anchor commitid.
315
316 =item git-debrebase analyse
317
318 Walks the history of the current branch,
319 most recent commit first,
320 back until the most recent anchor,
321 printing the commit object id,
322 and commit type and info
323 (ie the semantics in the git-debrebase model)
324 for each commit.
325
326 =item git-debrebase record-ffq-prev
327
328 Establishes the current branch's ffq-prev,
329 as discussed in L</UNSTITCHING AND LAUNDERING>,
330 but does not launder the branch or move HEAD.
331
332 It is an error if the ffq-prev could not be recorded.
333 It is also an error if an ffq-prev has already been recorded,
334 unless --noop-ok.
335
336 =item git-debrebase launder-v0
337
338 Launders the branch without recording anything in ffq-prev.
339 Then prints some information about the current branch.
340 Do not use this operation;
341 it will be withdrawn soon.
342
343 =item git-debrebase convert-to-gbp
344
345 Converts a laundered branch into a
346 gbp patches-unapplied branch containing quilt patches.
347 The result is not fast forward from the interchange branch,
348 and any ffq-prev is deleted.
349
350 This is provided mostly for the test suite
351 and for unusual situations.
352 It should only be used with a care and 
353 with a proper understanding of the underlying theory.
354
355 Be sure to not accidentally treat the result as
356 a git-debrebase branch,
357 or you will drop all the patches!
358
359 =item git-debrebase convert-from-dgit-view [<convert-options>] [upstream]
360
361 Converts any dgit-compatible git branch
362 corresponding to a (possibly hypothetical) 3.0 quilt dsc source package
363 into a git-debrebase-compatible branch.
364
365 This operation should not be used
366 if the branch is already in git-debrebase form.
367 Normally git-debrebase will refuse to continue in this case
368 (or silently do nothing if the global --noop-ok option is used).
369
370 Some representation of the original upstream source code will be needed.
371 If I<upstream> is supplied, that must be a suitable upstream commit.
372 By default,
373 git-debrebase will look first for git tags (as for new-upstream),
374 and then for orig tarballs which it will ask dgit to process.
375
376 The upstream source must be exactly right and
377 all the patches in debian/patches must be up to date.
378 Applying the patches from debian/patches to the upstream source
379 must result in exactly your HEAD.
380
381 The output is laundered and stitched.
382 The resulting history is not particularly pretty,
383 especially if orig tarball(s) were imported
384 to produce a synthetic upstream commit.
385
386 The available convert-options are as follows.
387 (These must come after convert-from-dgit-view.)
388
389 =over
390
391 =item --[no-]diagnose
392
393 Print additional error messages to help diagnose
394 failure to find an appropriate upstream.
395 --no-diagnose is the default.
396
397 =item --build-products-dir
398
399 Directory to look in for orig tarballs.
400 The default is the git config option
401 dgit.default.build-products-dir
402 or failing that, C<..>.
403 Passed on to dgit, if git-debrebase invokes dgit.
404
405 =item --[no-]origs
406
407 Whether to try to look for or use any orig tarballs.
408 --origs is the default.
409
410 =item --[no-]tags
411
412 Whether to try to look for or use any upstream git tags.
413 --tags is the default.
414
415 =item --always-convert-anyway
416
417 Perform the conversion operation,
418 producing unpleasant extra history,
419 even if the branch seems to be in git-debrebase form already.
420 This should not be done unless necessary,
421 and it should not be necessary.
422
423 =back
424
425 =item git-debrebase forget-was-ever-debrebase
426
427 Deletes the ffq-prev and debrebase-last refs
428 associated with this branch,
429 that git-debrebase and dgit use to determine
430 whether this branch is managed by git-debrebase,
431 and what previous head may need to be stitched back in.
432
433 This can be useful if you were just playing with git-debrebase,
434 and have used git-reset --hard to go back to a commit
435 before your experiments.
436
437 Do not use this if you expect to run git-debrebase on the branch again.
438
439 =back
440
441 =head1 OPTIONS
442
443 This section documents the general options
444 to git-debrebase
445 (ie, the ones which immediately follow
446 git-debrebase
447 or
448 git debrebase
449 on the command line).
450 Individual operations may have their own options which are
451 docuented under each operation.
452
453 =over
454
455 =item -f<snag-id>
456
457 Turns snag(s) with id <snag-id> into warnings.
458
459 Some troublesome things which git-debrebase encounters
460 are B<snag>s.
461 (The specific instances are discussed
462 in the text for the relevant operation.)
463
464 When a snag is detected,
465 a message is printed to stderr containing the snag id
466 (in the form C<-f<snag-idE<gt>>),
467 along with some prose.
468
469 If snags are detected, git-debrebase does not continue,
470 unless the relevant -f<snag-id> is specified,
471 or --force is specified.
472
473 =item --force
474
475 Turns all snags into warnings.
476 See the -f<snag-id> option.
477
478 Do not invoke git-debrebase --force in scripts and aliases;
479 instead, specify the particular -f<snag-id> for expected snags.
480
481 =item --noop-ok
482
483 Suppresses the error in
484 some situations where git-debrebase does nothing,
485 because there is nothing to do.
486
487 The specific instances are discussed
488 in the text for the relvant operation.
489
490 =item --anchor=<commit-ish>
491
492 Treats <commit-ish> as an anchor.
493 This overrides the usual logic which automatically classifies
494 commits as anchors, pseudomerges, delta queue commits, etc.
495
496 It also disables some coherency checks
497 which depend on metadata extracted from its commit message,
498 so
499 it is a snag if <commit-ish> is the anchor
500 for the previous upstream version in
501 git-debrebase new-upstream operations.
502
503 =item --dgit=<program>
504
505 Run <program>, instead of dgit from PATH,
506 when invocation of dgit is necessary.
507 This is provided mostly for the benefit of the test suite.
508
509 =item -D
510
511 Requests (more) debugging.  May be repeated.
512
513 =item --experimntal-merge-resolution
514
515 Enable experimental code for handling general merges
516 (see L<git-debrebase(5)/General merges>).
517
518 This option may generate lossage of various kinds,
519 including misleading error messages,
520 references to nonexistent documentation, and
521 you being handed an incomprehensible pile of
522 multidimensional merge wreckage.
523
524 =back
525
526 =head1 UNSTITCHING AND LAUNDERING
527
528 Several operations unstitch and launder the branch first.
529 In detail this means:
530
531 =head2 Establish the current branch's ffq-prev
532
533 If ffq-prev is not yet recorded,
534 git-debrebase checks that the current branch is ahead of relevant
535 remote tracking branches.
536 The relevant branches depend on
537 the current branch (and its
538 git configuration)
539 and are as follows:
540
541 =over
542
543 =item
544
545 The branch that git would merge from
546 (remote.<branch>.merge, remote.<branch>.remote);
547
548 =item
549
550 The branch git would push to, if different
551 (remote.<branch>.pushRemote etc.);
552
553 =item
554
555 For local dgit suite branches,
556 the corresponding tracking remote;
557
558 =item
559
560 If you are on C<master>,
561 remotes/dgit/dgit/sid.
562
563 =back
564
565 The apparently relevant ref names to check are filtered through
566 branch.<branch>.ffq-ffrefs,
567 which is a semicolon-separated list of glob patterns,
568 each optionally preceded by !; first match wins.
569
570 In each case it is a snag if
571 the local HEAD is behind the checked remote,
572 or if local HEAD has diverged from it.
573 All the checks are done locally using the remote tracking refs:
574 git-debrebase does not fetch anything from anywhere.
575
576 If these checks pass,
577 or are forced,
578 git-debrebse then records the current tip as ffq-prev.
579
580 =head2 Examine the branch
581
582 git-debrebase
583 analyses the current HEAD's history to find the anchor
584 in its breakwater,
585 and the most recent breakwater tip.
586
587 =head2 Rewrite the commits into laundered form
588
589 Mixed debian+upstream commits are split into two commits each.
590 Delta queue (upstream files) commits bubble to the top.
591 Pseudomerges,
592 and quilt patch additions,
593 are dropped.
594
595 This rewrite will always succeed, by construction.
596 The result is the laundered branch.
597
598 =head1 SEE ALSO
599
600 git-debrebase(1),
601 dgit-maint-rebase(7),
602 dgit(1),
603 gitglossary(7)