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(5)>.
  19 For background, theory of operation,
  20 and definitions see L<git-debrebase(5)>.
  21
  22 You should read this manpage in conjunction 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 conclude
  59
  60 Finishes a git-debrebase session,
  61 tidying up the branch and making it fast forward again.
  62
  63 Specifically: if the branch is unstitched,
  64 launders and restitches it,
  65 making a new pseudomerge.
  66 Otherwise, it is an error,
  67 unless --noop-ok.
  68
  69 =item git-debrebase quick
  70
  71 Unconditionally launders and restitches the branch,
  72 consuming any ffq-prev
  73 and making a new pseudomerge.
  74
  75 If the branch is already laundered and stitched, does nothing.
  76
  77 =item git-debrebase prepush [--prose=<for commit message>]
  78
  79 =item git-debrebase stitch [--prose=<for commit message>]
  80
  81 Stitches the branch,
  82 consuming ffq-prev.
  83 This is a good command to run before pushing to a git server.
  84
  85 If there is no ffq-prev, it is an error, unless --noop-ok.
  86
  87 You should consider using B<conclude> instead,
  88 because that launders the branch too.
  89
  90 =item git-debrebase new-upstream-v0 <new-version> [<upstream-details>...]
  91
  92 Rebases the delta queue
  93 onto a new upstream version.  In detail:
  94
  95 Firstly, checks that the proposed rebase seems to make sense:
  96 It is a snag unless the new upstream(s)
  97 are fast forward from the previous upstream(s)
  98 as found in the current breakwater anchor.
  99 And, in the case of a multi-piece upstream
 100 (a multi-component upstream, in dpkg-source terminology),
 101 if the pieces are not in the same order, with the same names.
 102
 103 If all seems well, unstitches and launders the branch.
 104
 105 Then,
 106 generates
 107 (in a private working area)
 108 a new anchor merge commit,
 109 on top of the breakwater tip,
 110 and on top of that a commit to
 111 update the version number in debian/changelog.
 112
 113 Finally,
 114 starts a git-rebase
 115 of the delta queue onto these new commits.
 116
 117 That git-rebase may complete successfully,
 118 or it may require your assistance,
 119 just like a normal git-rebase.
 120
 121 If you git-rebase --abort,
 122 the whole new upstream operation is aborted,
 123 except for the laundering.
 124
 125 The <upstream-details> are, optionally, in order:
 126
 127 =over
 128
 129 =item <upstream-commit-ish>
 130
 131 The new upstream branch (or commit-ish).
 132 Default is C<upstream>.
 133
 134 It is a snag if the upstream contains a debian/ directory;
 135 if forced to proceed,
 136 git-debrebase will disregard the upstream's debian/ and
 137 take (only) the packaging from the current breakwater.
 138
 139 =item <piece-name> <piece-upstream-commit-ish>
 140
 141 Specifies that this is a multi-piece upstream.
 142 May be repeated.
 143
 144 When such a pair is specified,
 145 git-debrebase will first combine the pieces of the upstream
 146 together,
 147 and then use the result as the combined new upstream.
 148
 149 For each <piece-name>,
 150 the tree of the <piece-upstream-commit-ish>
 151 becomes the subdirectory <piece-name>
 152 in the combined new upstream
 153 (supplanting any subdirectory that might be there in
 154 the main upstream branch).
 155
 156 <piece-name> has a restricted syntax:
 157 it may contain only ASCII alphanumerics and hyphens.
 158
 159 The combined upstream is itself recorded as a commit,
 160 with each of the upstream pieces' commits as parents.
 161 The combined commit contains an annotation
 162 to allow a future git-debrebase new upstream operation
 163 to make the coherency checks described above.
 164
 165 =item <git-rebase options>
 166
 167 These will be passed to git rebase.
 168
 169 If the upstream rebase is troublesome, -i may be helpful.
 170 As with plain git-debrebase,
 171 do not specify a base, or --onto, or --fork-point.
 172
 173 =back
 174
 175 If you are planning to generate a .dsc,
 176 you will also need to have, or generate,
 177 actual orig tarball(s),
 178 which must be identical to the rev-spec(s)
 179 passed to git-debrebase.
 180 git-debrebase does not concern itself with source packages
 181 so neither helps with this, nor checks it.
 182 L<git-deborig(1)>,
 183 L<git-archive(1)>, L<dgit(1)> and
 184 L<gbp-import-orig(1)> may be able to help.
 185
 186 This subcommand has -v0 in its name because we are not yet sure
 187 that its command line syntax is optimal.
 188 We may want to introduce an incompatible replacement syntax
 189 under the name C<new-upstream>.
 190
 191 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
 192
 193 Cnnverts a gbp patches-unapplied branch
 194 (not a gbp pq patch queue branch)
 195 into a git-debrebase interchange branch.
 196
 197 This is done by generating a new anchor merge,
 198 converting the quilt patches as a delta queue,
 199 and dropping the patches from the tree.
 200
 201 The upstream commit-ish should correspond to
 202 the gbp upstream branch, if there is one.
 203 It is a snag if it is not an ancestor of HEAD,
 204 or if the history between the upstream and HEAD
 205 contains commits which make changes to upstream files.
 206
 207 It is also a snag if the specified upstream
 208 has a debian/ subdirectory.
 209 This check exists to detect certain likely user errors,
 210 but if this situation is true and expected,
 211 forcing it is fine.
 212
 213 The result is a well-formed git-debrebase interchange branch.
 214 The result is also fast-forward from the gbp branch.
 215
 216 Note that it is dangerous not to know whether you are
 217 dealing with a gbp patches-unappled branch containing quilt patches,
 218 or a git-debrebase interchange branch.
 219 At worst,
 220 using the wrong tool for the branch format might result in
 221 a dropped patch queue!
 222
 223 =back
 224
 225 =head1 UNDERLYING AND SUPPLEMENTARY OPERATIONS
 226
 227 =over
 228
 229 =item git-debrebase breakwater
 230
 231 Prints the breakwater tip commitid.
 232 If your HEAD branch is not fully laundered,
 233 prints the tip of the so-far-laundered breakwater.
 234
 235 =item git-debrebase anchor
 236
 237 Prints the breakwater anchor commitid.
 238
 239 =item git-debrebase analyse
 240
 241 Walks the history of the current branch,
 242 most recent commit first,
 243 back until the most recent anchor,
 244 printing the commit object id,
 245 and commit type and info
 246 (ie the semantics in the git-debrebase model)
 247 for each commit.
 248
 249 =item git-debrebase record-ffq-prev
 250
 251 Establishes the current branch's ffq-prev,
 252 as discussed in L</UNSTITCHING AND LAUNDERING>,
 253 but does not launder the branch or move HEAD.
 254
 255 It is an error if the ffq-prev could not be recorded.
 256 It is also an error if an ffq-prev has already been recorded,
 257 unless --noop-ok.
 258
 259 =item git-debrebase launder-v0
 260
 261 Launders the branch without recording anything in ffq-prev.
 262 Then prints some information about the current branch.
 263 Do not use this operation;
 264 it will be withdrawn soon.
 265
 266 =item git-debrebase convert-to-gbp
 267
 268 Converts a laundered branch into a
 269 gbp patches-unapplied branch containing quilt patches.
 270 The result is not fast forward from the interchange branch,
 271 and any ffq-prev is deleted.
 272
 273 This is provided mostly for the test suite
 274 and for unusual situations.
 275 It should only be used with a care and
 276 with a proper understanding of the underlying theory.
 277
 278 Be sure to not accidentally treat the result as
 279 a git-debrebase branch,
 280 or you will drop all the patches!
 281
 282 =back
 283
 284 =head1 OPTIONS
 285
 286 This section documents the general options
 287 to git-debrebase
 288 (ie, the ones which immediately follow
 289 git-debrebase
 290 or
 291 git debrebase
 292 on the command line).
 293 Individual operations may have their own options which are
 294 docuented under each operation.
 295
 296 =over
 297
 298 =item -f<snag-id>
 299
 300 Turns snag(s) with id <snag-id> into warnings.
 301
 302 Some troublesome things which git-debrebase encounters
 303 are B<snag>s.
 304 (The specific instances are discussed
 305 in the text for the relvant operation.)
 306
 307 When a snag is detected,
 308 a message is printed to stderr containing the snag id
 309 (in the form C<-f<snag-idE<gt>>),
 310 along with some prose.
 311
 312 If snags are detected, git-debrebase does not continue,
 313 unless the relevant -f<snag-id> is specified,
 314 or --force is specified.
 315
 316 =item --force
 317
 318 Turns all snags into warnings.
 319 See the -f<snag-id> option.
 320
 321 Do not invoke git-debrebase --force in scripts and aliases;
 322 instead, specify the particular -f<snag-id> for expected snags.
 323
 324 =item --noop-ok
 325
 326 Suppresses the error in
 327 some situations where git-debrebase does nothing,
 328 because there is nothing to do.
 329
 330 The specific instances are discussed
 331 in the text for the relvant operation.
 332
 333 =item --anchor=<commit-ish>
 334
 335 Treats <commit-ish> as an anchor.
 336 This overrides the usual logic which automatically classifies
 337 commits as anchors, pseudomerges, delta queue commits, etc.
 338
 339 It also disables some coherency checks
 340 which depend on metadata extracted from its commit message,
 341 so
 342 it is a snag if <commit-ish> is the anchor
 343 for the previous upstream version in
 344 git-debrebase new-upstream operations.
 345
 346 =item -D
 347
 348 Requests (more) debugging.  May be repeated.
 349
 350 =back
 351
 352 =head1 UNSTITCHING AND LAUNDERING
 353
 354 Several operations unstitch and launder the branch first.
 355 In detail this means:
 356
 357 =head2 Establish the current branch's ffq-prev
 358
 359 If ffq-prev is not yet recorded,
 360 git-debrebase checks that the current branch is ahead of relevant
 361 remote tracking branches.
 362 The relevant branches depend on
 363 the current branch (and its
 364 git configuration)
 365 and are as follows:
 366
 367 =over
 368
 369 =item
 370
 371 The branch that git would merge from
 372 (remote.<branch>.merge, remote.<branch>.remote);
 373
 374 =item
 375
 376 The branch git would push to, if different
 377 (remote.<branch>.pushRemote etc.);
 378
 379 =item
 380
 381 For local dgit suite branches,
 382 the corresponding tracking remote;
 383
 384 =item
 385
 386 If you are on C<master>,
 387 remotes/dgit/dgit/sid.
 388
 389 =back
 390
 391 The apparently relevant ref names to check are filtered through
 392 branch.<branch>.ffq-ffrefs,
 393 which is a semicolon-separated list of glob patterns,
 394 each optionally preceded by !; first match wins.
 395
 396 In each case it is a snag if
 397 the local HEAD is behind the checked remote,
 398 or if local HEAD has diverged from it.
 399 All the checks are done locally using the remote tracking refs:
 400 git-debrebase does not fetch anything from anywhere.
 401
 402 If these checks pass,
 403 or are forced,
 404 git-debrebse then records the current tip as ffq-prev.
 405
 406 =head2 Examine the branch
 407
 408 git-debrebase
 409 analyses the current HEAD's history to find the anchor
 410 in its breakwater,
 411 and the most recent breakwater tip.
 412
 413 =head2 Rewrite the commits into laundered form
 414
 415 Mixed debian+upstream commits are split into two commits each.
 416 Delta queue (upstream files) commits bubble to the top.
 417 Pseudomerges,
 418 and quilt patch additions,
 419 are dropped.
 420
 421 This rewrite will always succeed, by construction.
 422 The result is the laundered branch.
 423
 424 =head1 SEE ALSO
 425
 426 git-debrebase(1),
 427 dgit-maint-rebase(7),
 428 dgit(1),
 429 gitglossary(7)