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