chiark / gitweb /
infra: dgit-repos-server: Break out mkscript
[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-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<alioth.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 git.debian.org:/git/collab-maint/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 =head2 When upstream releases only tarballs
124
125 We need a virtual upstream branch with virtual release tags.
126 gbp-import-orig(1) can manage this for us.  To begin
127
128 =over 4
129
130     % mkdir foo
131     % cd foo
132     % git init
133
134 =back
135
136 Now create I<debian/gbp.conf>:
137
138 =over 4
139
140     [DEFAULT]
141     upstream-branch = upstream
142     debian-branch = master
143     upstream-tag = %(version)s
144
145     sign-tags = True
146     pristine-tar = False
147     pristine-tar-commit = False
148
149 =back
150
151 Then we can import the upstream version:
152
153 =over 4
154
155     % git add debian/gbp.conf && git commit -m "create gbp.conf"
156     % gbp import-orig ../foo_1.2.2.orig.tar.xz
157
158 =back
159
160 You are now ready to proceed as above, making commits to both the
161 upstream source and the I<debian/> directory.
162
163 If you want to maintain a copy of your repository on
164 B<alioth.debian.org>, you should push both the origin and the upstream
165 branches:
166
167 =over 4
168
169     % git remote add -f origin git.debian.org:/git/collab-maint/foo.git
170     % git push --follow-tags -u origin master upstream
171
172 =back
173
174 =head1 CONVERTING AN EXISTING PACKAGE
175
176 This section explains how to convert an existing Debian package to
177 this workflow.  It should be skipped when debianising a new package.
178
179 =head2 No existing git history
180
181 =over 4
182
183     % dgit clone foo
184     % cd foo
185     % git remote add -f upstream https://some.upstream/foo.git
186
187 =back
188
189 =head2 Existing git history using another workflow
190
191 First, dump any existing patch queue:
192
193 =over 4
194
195     % git rm -rf debian/patches
196     % git commit -m "drop existing quilt patch queue"
197
198 =back
199
200 Then make new upstream tags available:
201
202 =over 4
203
204     % git remote add -f upstream https://some.upstream/foo.git
205
206 =back
207
208 Now you simply need to ensure that your git HEAD is dgit-compatible,
209 i.e., it is exactly what you would get if you ran B<dpkg-buildpackage
210 -i\.git/ -I.git -S> and then unpacked the resultant source package.
211
212 To achieve this, you might need to delete
213 I<debian/source/local-options>.  One way to have dgit check your
214 progress is to run B<dgit build-source>.
215
216 The first dgit push will require I<--overwrite>.
217
218 =head1 SOURCE PACKAGE CONFIGURATION
219
220 =head2 debian/source/options
221
222 We set some source package options such that dgit can transparently
223 handle the "dropping" and "refreshing" of changes to the upstream
224 source:
225
226 =over 4
227
228     single-debian-patch
229     auto-commit
230
231 =back
232
233 You don't need to create this file if you are using the version 1.0
234 source package format.
235
236 =head2 Sample text for debian/source/patch-header
237
238 It is a good idea to explain how a user can obtain a breakdown of the
239 changes to the upstream source:
240
241 =over 4
242
243 The Debian packaging of foo is maintained in git,
244 using the merging workflow described in dgit-maint-merge(7).
245 There isn't a patch queue that can be represented as a quilt series.
246
247 A detailed breakdown of the changes is available from their
248 canonical representation -
249 git commits in the packaging repository.
250 For example, to see the changes made by the Debian maintainer in the
251 first upload of upstream version 1.2.3, you could use:
252
253 =over 4
254
255     % git clone https://git.dgit.debian.org/foo
256     % cd foo
257     % git log --oneline 1.2.3..debian/1.2.3-1 -- . ':!debian'
258
259 =back
260
261 (If you have dgit, use `dgit clone foo`,
262 rather than plain `git clone`.)
263
264 A single combined diff, containing all the changes, follows.
265
266 =back
267
268 Alternatively, this text could be added to README.source. However,
269 this might distract from more important information present in the
270 latter file.
271
272 =head1 BUILDING AND UPLOADING
273
274 Use B<dgit build>, B<dgit sbuild>, B<dgit build-source>, and B<dgit
275 push> as detailed in dgit(1).  If any command fails, dgit will provide
276 a carefully-worded error message explaining what you should do.  If
277 it's not clear, file a bug against dgit.  Remember to pass I<--new>
278 for the first upload.
279
280 As an alternative to B<dgit build> and friends, you can use a tool
281 like gitpkg(1).  This works because like dgit, gitpkg(1) enforces that
282 HEAD has exactly the contents of the source package.  gitpkg(1) is
283 highly configurable, and one dgit user reports using it to produce and
284 test multiple source packages, from different branches corresponding
285 to each of the current Debian suites.
286
287 If you want to skip dgit's checks while iterating on a problem with
288 the package build (for example, you don't want to commit your changes
289 to git), you can just run dpkg-buildpackage(1) or debuild(1) instead.
290
291 =head1 NEW UPSTREAM RELEASES
292
293 =head2 When upstream tags releases in git
294
295 It's a good idea to preview the merge of the new upstream release.
296 First, just check for any new or deleted files that may need
297 accounting for in your copyright file:
298
299 =over 4
300
301     % git remote update
302     % git diff --stat master..1.2.3 -- . ':!debian'
303
304 =back
305
306 You can then review the full merge diff:
307
308 =over 4
309
310     % git merge-tree `git merge-base master 1.2.3` master 1.2.3 | $PAGER
311
312 =back
313
314 Once you're satisfied with what will be merged, update your package:
315
316 =over 4
317
318     % git merge 1.2.3
319     % dch -v1.2.3-1 New upstream release.
320     % git add debian/changelog && git commit -m changelog
321     % git deborig
322
323 =back
324
325 and you are ready to try a build.
326
327 =head2 When upstream releases only tarballs
328
329 You will need the I<debian/gbp.conf> from "When upstream releases only
330 tarballs", above.
331
332 Then, either
333
334 =over 4
335
336     % gbp import-orig ../foo_1.2.2.orig.tar.xz
337
338 =back
339
340 or if you have a working watch file
341
342 =over 4
343
344     % gbp import-orig --uscan
345
346 =back
347
348 =head1 HANDLING DFSG-NON-FREE MATERIAL
349
350 =head2 When upstream tags releases in git
351
352 We create a DFSG-clean tag to merge to master:
353
354 =over 4
355
356     % git checkout -b pre-dfsg 1.2.3
357     % git rm evil.bin
358     % git commit -m "upstream version 1.2.3 DFSG-cleaned"
359     % git tag -s 1.2.3+dfsg
360     % git checkout master
361     % git branch -D pre-dfsg
362
363 =back
364
365 Before merging the new 1.2.3+dfsg tag to master, you should first
366 determine whether it would be legally dangerous for the non-free
367 material to be publicly accessible in the git history on
368 B<dgit-repos>.
369
370 If it would be dangerous, there is a big problem;
371 in this case please consult your archive administrators
372 (for Debian this is the dgit administrator dgit-owner@debian.org
373 and the ftpmasters ftpmaster@ftp-master.debian.org).
374
375 =head2 When upstream releases only tarballs
376
377 The easiest way to handle this is to add a B<Files-Excluded> field to
378 I<debian/copyright>, and a B<uversionmangle> setting in
379 I<debian/watch>.  See uscan(1).  Alternatively, see the I<--filter>
380 option detailed in gbp-import-orig(1).
381
382 =head1 FORWARDING PATCHES UPSTREAM
383
384 The basic steps are:
385
386 =over 4
387
388 =item 1.
389
390 Create a new branch based off upstream's master branch.
391
392 =item 2.
393
394 git-cherry-pick(1) commits from your master branch onto your new
395 branch.
396
397 =item 3.
398
399 Push the branch somewhere and ask upstream to merge it, or use
400 git-format-patch(1) or git-request-pull(1).
401
402 =back
403
404 For example (and it is only an example):
405
406 =over 4
407
408     % # fork foo.git on GitHub
409     % git remote add -f fork git@github.com:spwhitton/foo.git
410     % git checkout -b fix-error upstream/master
411     % git config branch.fix-error.pushRemote fork
412     % git cherry-pick master^2
413     % git push
414     % # submit pull request on GitHub
415
416 =back
417
418 Note that when you merge an upstream release containing your forwarded
419 patches, git and dgit will transparently handle "dropping" the patches
420 that have been forwarded, "retaining" the ones that haven't.
421
422 =head1 INCORPORATING NMUS
423
424 =over 4
425
426     % dgit pull
427
428 =back
429
430 Alternatively, you can apply the NMU diff to your repository.  The
431 next push will then require I<--overwrite>.
432
433 =head1 SEE ALSO
434
435 dgit(1), dgit(7)
436
437 =head1 AUTHOR
438
439 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.