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 =item git-debrebase new-upstream-v0 <new-version> [<upstream-details>...]
  60
  61 Rebases the delta queue
  62 onto a new upstream version.  In detail:
  63
  64 Firstly, checks that the proposed rebase seems to make sense:
  65 It is a problem unless the new upstream(s)
  66 are fast forward from the previous upstream(s)
  67 as found in the current breakwater anchor.
  68 And, in the case of a multi-piece upstream,
  69 if the pieces are not in the same order, with the same names.
  70
  71 If all seems well, unstitches and launders the branch.
  72
  73 Then,
  74 generates
  75 (in a private working area)
  76 a new anchor merge commit,
  77 on top of the breakwater tip,
  78 and on top of that a commit to
  79 update the version number in debian/changelog.
  80
  81 Finally,
  82 starts a git-rebase
  83 of the delta queue onto these new commits.
  84
  85 That git-rebase may complete successfully,
  86 or it may require your assistance,
  87 just like a normal git-rebase.
  88
  89 If you git-rebase --abort,
  90 the whole new upstream operation is aborted,
  91 but the laundering will still have been done.
  92
  93 The <upstream-details> are, optionally, in order:
  94
  95 =over
  96
  97 =item <upstream-commitish>
  98
  99 The new upstream branch (or commitish).
 100 Default is C<upstream>.
 101
 102 It is a problem if the upstream contains a debian/ directory;
 103 if forced to proceed,
 104 git-debrebase will disregard the upstream's debian/ and
 105 take (only) the packaging from the current breakwater.
 106
 107 =item <piece-name> <piece-upstream-commitish>
 108
 109 Specifies that this is a multi-piece upstream.
 110 (A multi-component upstream, in dpkg-source terminology.)
 111 May be repeated.
 112
 113 When such a pair is specified,
 114 git-debrebase will first combine the pieces of the upstream
 115 together,
 116 and then use the result as the combined new upstream.
 117
 118 For each <piece-name>,
 119 the tree of the <piece-upstream-commitish>
 120 becomes the subdirectory <piece-name>
 121 in the combined new upstream
 122 (supplanting any subdirectory that might be there in
 123 the main upstream branch).
 124
 125 <piece-name> has a restricted syntax:
 126 it may contain only ASCII alphanumerics and hyphens.
 127
 128 The combined upstream is itself recorded as a commit,
 129 with each of the upstream pieces' commits as parents.
 130 The combined commit contains an annotation
 131 to allow a future git-debrebase new upstream operation
 132 to make the coherency checks described above.
 133
 134 =item <git-rebase options>
 135
 136 These will be passed to git rebase.
 137
 138 If the upstream rebase is troublesome, -i may be helpful.
 139 As with plain git-debrebase,
 140 do not specify a base, or --onto, or --fork-point.
 141
 142 =back
 143
 144 If you are planning to generate a .dsc,
 145 you will also need to have, or generate,
 146 actual orig tarball(s),
 147 which must be identical to the rev-spec(s)
 148 passed to git-debrebase.
 149 git-debrebase does not concern itself with source packages
 150 so neither helps with this, nor checks it.
 151 L<git-archive(1)>, L<dgit(1)> and L<gbp(1)> may be able to help.
 152
 153 This subcommand has -v0 in its name because we are not yet sure
 154 that its command line syntax is optimal.
 155 We may want to introduce an incompatible replacement syntax
 156 under the name C<new-upstream>.
 157
 158 =back
 159
 160 =head1 UNDERLYING AND SUPPLEMENTARY OPERATIONS
 161
 162 =over
 163
 164 =item git-debrebase breakwater
 165
 166 Prints the breakwater tip commitid.
 167 Fails if your HEAD branch is not laundered.
 168
 169 =back
 170
 171 =head1 UNSTITCHING AND LAUNDERING
 172
 173 Several operations unstitch and launder the branch first.
 174 In detail this means:
 175
 176 =head2 Establish the current branch's ffq-prev
 177
 178 If it is not yet recorded,
 179 git-debrebase checks that the current branch is ahead of relevant
 180 remote tracking branches.
 181
 182 The remote tracking branches checked by default are
 183 obtained from the git config.
 184 In each case it is a problem if
 185 the local HEAD is behind the checked remote,
 186 or if local HEAD has diverged from it.
 187 All the checks are done locally using the remote tracking refs:
 188 git-debrebase does not fetch anything from anywhere.
 189
 190 git-debrebase checks the branch that git would merge from
 191 (remote.<branch>.merge, remote.<branch>.remote)
 192 and the branch git would push to
 193 (remote.<branch>.pushRemote etc.).
 194 For local dgit suite branches
 195 it checks the corresponding tracking remote.
 196 If you are on C<master>, it checks remotes/dgit/dgit/sid.
 197 The resulting ref names to check are filtered through
 198 branch.<branch>.ffq-ffrefs,
 199 which is a semicolon-separated list of glob patterns,
 200 each optionally preceded by !; first match wins.
 201
 202 If these checks pass,
 203 or are forced,
 204 git-debrebse then records the current tip as ffq-prev.
 205
 206 =head2 Examine the branch
 207
 208 git-debrebase
 209 analyses the current HEAD's history to find the anchor
 210 in its breakwater,
 211 and the most recent breakwater tip.
 212
 213 =head2 Rewrite the commits into laundered form
 214
 215 Mixed debian+upstream commits are split into two commits each.
 216 Delta queue (upstream files) commits bubble to the top.
 217 Pseudomerges,
 218 and quilt patch additions,
 219 are dropped.
 220
 221 This rewrite will always succeed, by construction.
 222 The result is the laundered branch.
 223
 224 =head1 SEE ALSO
 225
 226 git-debrebase(1),
 227 dgit-maint-rebase(7),
 228 dgit(1)