chiark / gitweb /
changelog: start 9.13
[dgit.git] / dgit-maint-merge.7.pod
1 =head1 NAME
2
3 dgit - tutorial for package maintainers, using a workflow centered around git-merge(1)
4
5 =head1 INTRODUCTION
6
7 This document describes elements of a workflow for maintaining a
8 non-native Debian package using B<dgit>.  The workflow makes the
9 following opinionated assumptions:
10
11 =over 4
12
13 =item
14
15 Git histories should be the non-linear histories produced by
16 git-merge(1), preserving all information about divergent development
17 that was later brought together.
18
19 =item
20
21 Maintaining convenient and powerful git workflows takes priority over
22 the usefulness of the raw Debian source package.  The Debian archive
23 is thought of as an output format.
24
25 For example, we don't spend time curating a series of quilt patches.
26 However,
27 in straightforward cases,
28 the information such a series would contain is readily
29 available from B<dgit-repos>.
30
31 =item
32
33 It is more important to have the Debian package's git history be a
34 descendent of upstream's git history than to use exactly the orig.tar
35 that upstream makes available for download.
36
37 =back
38
39 This workflow is less suitable for some packages.
40 When the Debian delta contains multiple pieces which interact,
41 or which you aren't going to be able to upstream soon,
42 it might be preferable to
43 maintain the delta as a rebasing patch series.
44 For such a workflow see for example
45 dgit-maint-debrebase(7) and dgit-maint-gbp(7).
46
47 =head1 INITIAL DEBIANISATION
48
49 This section explains how to start using this workflow with a new
50 package.  It should be skipped when converting an existing package to
51 this workflow.
52
53 =head2 When upstream tags releases in git
54
55 Suppose that the latest stable upstream release is 1.2.2, and this has
56 been tagged '1.2.2' by upstream.
57
58 =over 4
59
60     % git clone -oupstream https://some.upstream/foo.git
61     % cd foo
62     % git verify-tag 1.2.2
63     % git reset --hard 1.2.2
64     % git branch --unset-upstream
65
66 =back
67
68 The final command detaches your master branch from the upstream remote,
69 so that git doesn't try to push anything there, or merge unreleased
70 upstream commits.  If you want to maintain a copy of your packaging
71 branch on B<salsa.debian.org> in addition to B<dgit-repos>, you can
72 do something like this:
73
74 =over 4
75
76     % git remote add -f origin salsa.debian.org:Debian/foo.git
77     % git push --follow-tags -u origin master
78
79 =back
80
81 Now go ahead and Debianise your package.  Just make commits on the
82 master branch, adding things in the I<debian/> directory.  If you need
83 to patch the upstream source, just make commits that change files
84 outside of the I<debian/> directory.  It is best to separate commits
85 that touch I<debian/> from commits that touch upstream source, so that
86 the latter can be cherry-picked by upstream.
87
88 Note that there is no need to maintain a separate 'upstream' branch,
89 unless you also happen to be involved in upstream development.  We
90 work with upstream tags rather than any branches, except when
91 forwarding patches (see FORWARDING PATCHES UPSTREAM, below).
92
93 Finally, you need an orig tarball:
94
95 =over 4
96
97     % git deborig
98
99 =back
100
101 See git-deborig(1) if this fails.
102
103 This tarball is ephemeral and easily regenerated, so we don't commit
104 it anywhere (e.g. with tools like pristine-tar(1)).
105
106 =head3 Verifying upstream's tarball releases
107
108 =over 4
109
110 It can be a good idea to compare upstream's released tarballs with the
111 release tags, at least for the first upload of the package.  If they
112 are different, you might need to add some additional steps to your
113 I<debian/rules>, such as running autotools.
114
115 A convenient way to perform this check is to import the tarball as
116 described in the following section, using a different value for
117 'upstream-tag', and then use git-diff(1) to compare the imported
118 tarball to the release tag.  If they are the same, you can use
119 upstream's tarball instead of running git-deborig(1).
120
121 =back
122
123 =head3 Using untagged upstream commits
124
125 =over 4
126
127 Sometimes upstream does not tag their releases, or you want to package
128 an unreleased git snapshot.  In such a case you can create your own
129 upstream release tag, of the form B<upstream/>I<ver>, where I<ver> is
130 the upstream version you plan to put in I<debian/changelog>.  The
131 B<upstream/> prefix ensures that your tag will not clash with any tags
132 upstream later creates.
133
134 For example, suppose that the latest upstream release is 1.2.2 and you
135 want to package git commit ab34c21 which was made on 2013-12-11.  A
136 common convention is to use the upstream version number
137 1.2.2+git20131211.ab34c21 and so you could use
138
139 =over 4
140
141     % git tag -s upstream/1.2.2+git20131211.ab34c21 ab34c21
142
143 =back
144
145 to obtain a release tag, and then proceed as above.
146
147 =back
148
149 =head2 When upstream releases only tarballs
150
151 We need a virtual upstream branch with virtual release tags.
152 gbp-import-orig(1) can manage this for us.  To begin
153
154 =over 4
155
156     % mkdir foo
157     % cd foo
158     % git init
159
160 =back
161
162 Now create I<debian/gbp.conf>:
163
164 =over 4
165
166     [DEFAULT]
167     upstream-branch = upstream
168     debian-branch = master
169     upstream-tag = upstream/%(version)s
170
171     sign-tags = True
172     pristine-tar = False
173     pristine-tar-commit = False
174
175     [import-orig]
176     merge-mode = merge
177     merge = False
178
179 =back
180
181 gbp-import-orig(1) requires a pre-existing upstream branch:
182
183 =over 4
184
185     % git add debian/gbp.conf && git commit -m "create gbp.conf"
186     % git checkout --orphan upstream
187     % git rm -rf .
188     % git commit --allow-empty -m "initial, empty branch for upstream source"
189     % git checkout -f master
190
191 =back
192
193 Then we can import the upstream version:
194
195 =over 4
196
197     % gbp import-orig --merge --merge-mode=replace ../foo_1.2.2.orig.tar.xz
198
199 =back
200
201 Our upstream branch cannot be pushed to B<dgit-repos>, but since we
202 will need it whenever we import a new upstream version, we must push
203 it somewhere.  The usual choice is B<salsa.debian.org>:
204
205 =over 4
206
207     % git remote add -f origin salsa.debian.org:Debian/foo.git
208     % git push --follow-tags -u origin master upstream
209
210 =back
211
212 You are now ready to proceed as above, making commits to both the
213 upstream source and the I<debian/> directory.
214
215 =head1 CONVERTING AN EXISTING PACKAGE
216
217 This section explains how to convert an existing Debian package to
218 this workflow.  It should be skipped when debianising a new package.
219
220 =head2 No existing git history
221
222 =over 4
223
224     % dgit clone foo
225     % cd foo
226     % git remote add -f upstream https://some.upstream/foo.git
227
228 =back
229
230 =head2 Existing git history using another workflow
231
232 First, if you don't already have the git history locally, clone it,
233 and obtain the corresponding orig.tar from the archive:
234
235 =over 4
236
237     % git clone git.debian.org:collab-maint/foo
238     % cd foo
239     % origtargz
240
241 =back
242
243 Now dump any existing patch queue:
244
245 =over 4
246
247     % git rm -rf debian/patches
248     % git commit -m "drop existing quilt patch queue"
249
250 =back
251
252 Then make new upstream tags available:
253
254 =over 4
255
256     % git remote add -f upstream https://some.upstream/foo.git
257
258 =back
259
260 =for dgit-test dpkg-source-ignores begin
261
262 Now you simply need to ensure that your git HEAD is dgit-compatible,
263 i.e., it is exactly what you would get if you ran
264 B<dpkg-buildpackage -i'(?:^|/)\.git(?:/|$)' -I.git -S>
265 and then unpacked the resultant source package.
266
267 =for dgit-test dpkg-source-ignores end
268
269 To achieve this, you might need to delete
270 I<debian/source/local-options>.  One way to have dgit check your
271 progress is to run B<dgit build-source>.
272
273 The first dgit push will require I<--overwrite>.  If this is the first
274 ever dgit push of the package, consider passing
275 I<--deliberately-not-fast-forward> instead of I<--overwrite>.  This
276 avoids introducing a new origin commit into your git history.  (This
277 origin commit would represent the most recent non-dgit upload of the
278 package, but this should already be represented in your git history.)
279
280 =head1 SOURCE PACKAGE CONFIGURATION
281
282 =head2 debian/source/options
283
284 We set some source package options such that dgit can transparently
285 handle the "dropping" and "refreshing" of changes to the upstream
286 source:
287
288 =over 4
289
290     single-debian-patch
291     auto-commit
292
293 =back
294
295 You don't need to create this file if you are using the version 1.0
296 source package format.
297
298 =head2 Sample text for debian/source/patch-header
299
300 It is a good idea to explain how a user can obtain a breakdown of the
301 changes to the upstream source:
302
303 =over 4
304
305 The Debian packaging of foo is maintained in git,
306 using the merging workflow described in dgit-maint-merge(7).
307 There isn't a patch queue that can be represented as a quilt series.
308
309 A detailed breakdown of the changes is available from their
310 canonical representation -
311 git commits in the packaging repository.
312 For example, to see the changes made by the Debian maintainer in the
313 first upload of upstream version 1.2.3, you could use:
314
315 =over 4
316
317     % git clone https://git.dgit.debian.org/foo
318     % cd foo
319     % git log --oneline 1.2.3..debian/1.2.3-1 -- . ':!debian'
320
321 =back
322
323 (If you have dgit, use `dgit clone foo`,
324 rather than plain `git clone`.)
325
326 A single combined diff, containing all the changes, follows.
327
328 =back
329
330 If you are using the version 1.0 source package format, this text
331 should be added to README.source instead.  The version 1.0 source
332 package format ignores debian/source/patch-header.
333
334 If you're using the version 3.0 (quilt) source package format, you
335 could add this text to README.source instead of
336 debian/source/patch-header, but this might distract from more
337 important information present in README.source.
338
339 =head1 BUILDING AND UPLOADING
340
341 Use B<dgit build>, B<dgit sbuild>, B<dgit pbuilder>, B<dgit
342 cowbuilder>, B<dgit push-source>, and B<dgit push> as detailed in
343 dgit(1).  If any command fails, dgit will provide a carefully-worded
344 error message explaining what you should do.  If it's not clear, file
345 a bug against dgit.  Remember to pass I<--new> for the first upload.
346
347 As an alternative to B<dgit build> and friends, you can use a tool
348 like gitpkg(1).  This works because like dgit, gitpkg(1) enforces that
349 HEAD has exactly the contents of the source package.  gitpkg(1) is
350 highly configurable, and one dgit user reports using it to produce and
351 test multiple source packages, from different branches corresponding
352 to each of the current Debian suites.
353
354 If you want to skip dgit's checks while iterating on a problem with
355 the package build (for example, you don't want to commit your changes
356 to git), you can just run dpkg-buildpackage(1) or debuild(1) instead.
357
358 =head1 NEW UPSTREAM RELEASES
359
360 =head2 Obtaining the release
361
362 =head3 When upstream tags releases in git
363
364 =over 4
365
366     % git fetch --tags upstream
367
368 =back
369
370 If you want to package an untagged upstream commit (because upstream
371 does not tag releases or because you want to package an upstream
372 development snapshot), see "Using untagged upstream commits" above.
373
374 =head3 When upstream releases only tarballs
375
376 You will need the I<debian/gbp.conf> from "When upstream releases only
377 tarballs", above.  You will also need your upstream branch.  Above, we
378 pushed this to B<salsa.debian.org>.  You will need to clone or fetch
379 from there, instead of relying on B<dgit clone>/B<dgit fetch> alone.
380
381 Then, either
382
383 =over 4
384
385     % gbp import-orig ../foo_1.2.3.orig.tar.xz
386
387 =back
388
389 or if you have a working watch file
390
391 =over 4
392
393     % gbp import-orig --uscan
394
395 =back
396
397 In the following, replace I<1.2.3> with I<upstream/1.2.3>.
398
399 =head2 Reviewing & merging the release
400
401 It's a good idea to preview the merge of the new upstream release.
402 First, just check for any new or deleted files that may need
403 accounting for in your copyright file:
404
405 =over 4
406
407     % git diff --name-status --diff-filter=ADR master..1.2.3 -- . ':!debian'
408
409 =back
410
411 You can then review the full merge diff:
412
413 =over 4
414
415     % git merge-tree `git merge-base master 1.2.3` master 1.2.3 | $PAGER
416
417 =back
418
419 Once you're satisfied with what will be merged, update your package:
420
421 =over 4
422
423     % git merge 1.2.3
424     % dch -v1.2.3-1 New upstream release.
425     % git add debian/changelog && git commit -m changelog
426
427 =back
428
429 If you obtained a tarball from upstream, you are ready to try a build.
430 If you merged a git tag from upstream, you will first need to generate
431 a tarball:
432
433 =over 4
434
435     % git deborig
436
437 =back
438
439 =head1 HANDLING DFSG-NON-FREE MATERIAL
440
441 =head2 When upstream tags releases in git
442
443 We create a DFSG-clean tag to merge to master:
444
445 =over 4
446
447     % git checkout -b pre-dfsg 1.2.3
448     % git rm evil.bin
449     % git commit -m "upstream version 1.2.3 DFSG-cleaned"
450     % git tag -s 1.2.3+dfsg
451     % git checkout master
452     % git branch -D pre-dfsg
453
454 =back
455
456 Before merging the new 1.2.3+dfsg tag to master, you should first
457 determine whether it would be legally dangerous for the non-free
458 material to be publicly accessible in the git history on
459 B<dgit-repos>.
460
461 If it would be dangerous, there is a big problem;
462 in this case please consult your archive administrators
463 (for Debian this is the dgit administrator dgit-owner@debian.org
464 and the ftpmasters ftpmaster@ftp-master.debian.org).
465
466 =head2 When upstream releases only tarballs
467
468 The easiest way to handle this is to add a B<Files-Excluded> field to
469 I<debian/copyright>, and a B<uversionmangle> setting in
470 I<debian/watch>.  See uscan(1).  Alternatively, see the I<--filter>
471 option detailed in gbp-import-orig(1).
472
473 =head1 FORWARDING PATCHES UPSTREAM
474
475 The basic steps are:
476
477 =over 4
478
479 =item 1.
480
481 Create a new branch based off upstream's master branch.
482
483 =item 2.
484
485 git-cherry-pick(1) commits from your master branch onto your new
486 branch.
487
488 =item 3.
489
490 Push the branch somewhere and ask upstream to merge it, or use
491 git-format-patch(1) or git-request-pull(1).
492
493 =back
494
495 For example (and it is only an example):
496
497 =over 4
498
499     % # fork foo.git on GitHub
500     % git remote add -f fork git@github.com:spwhitton/foo.git
501     % git checkout -b fix-error upstream/master
502     % git config branch.fix-error.pushRemote fork
503     % git cherry-pick master^2
504     % git push
505     % # submit pull request on GitHub
506
507 =back
508
509 Note that when you merge an upstream release containing your forwarded
510 patches, git and dgit will transparently handle "dropping" the patches
511 that have been forwarded, "retaining" the ones that haven't.
512
513 =head1 INCORPORATING NMUS
514
515 =over 4
516
517     % dgit pull
518
519 =back
520
521 Alternatively, you can apply the NMU diff to your repository.  The
522 next push will then require I<--overwrite>.
523
524 =head1 SEE ALSO
525
526 dgit(1), dgit(7)
527
528 =head1 AUTHOR
529
530 This tutorial was written and is maintained by Sean Whitton <spwhitton@spwhitton.name>.  It contains contributions from other dgit contributors too - see the dgit copyright file.