chiark / gitweb /
dgit-sponsorship(7): Correct sponsee/sponsor
[dgit.git] / dgit.1
1 .TH dgit 1 "" "Debian Project" "dgit"
2 .SH NAME
3 dgit \- git integration with the Debian archive
4 .
5 .SH SYNOPSIS
6 .B dgit
7 [\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
8 \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
9 .br
10 .B dgit
11 [\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]
12 [\fIsuite\fP]
13 .br
14 .B dgit
15 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP
16 [\fIbuild\-opts\fp]
17 .br
18 .B dgit
19 [\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]
20 [\fIsuite\fP]
21 .br
22 .B dgit
23 [\fIdgit\-opts\fP] \fBrpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR
24 [\fIpush args...\fR]
25 .br
26 .B dgit
27 [\fIdgit\-opts\fP] \fIaction\fR ...
28 .SH DESCRIPTION
29 .B dgit
30 allows you to treat the Debian archive as if it were a git
31 repository.  See \fBdgit\fP(7) for detailed information about the data
32 model, common problems likely to arise with certain kinds of package,
33 etc.
34
35 The usual workflow is:
36 .br
37 1.      \fBdgit clone\fR or \fBfetch\fR;
38 .br
39 2.      make, do dev tests, and commit changes in git as desired;
40 .br
41 3.      build packages for upload, using e.g. \fBdgit sbuild\fR
42 .br
43 4.      do pre-upload tests of the proposed upload;
44 .br
45 5.      \fBdgit push\fR.
46 .SH OPERATIONS
47 .TP
48 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
49 Consults the archive and dgit-repos to construct the git view of
50 history for
51 .I package
52 in
53 .I suite
54 .RB ( sid
55 by default)
56 in a new directory (named
57 .BI ./ package
58 by default);
59 also, downloads any necessary orig tarballs.
60
61 The suite's git tip is
62 left on the local branch
63 .BI dgit/ suite
64 ready for work, and on the corresponding dgit remote tracking branch.
65 The
66 .B origin
67 remote will be set up to point to the package's dgit-repos tree
68 for the distro to which
69 .I suite
70 belongs.
71
72 For your convenience, the
73 .B vcs-git
74 remote will be set up from the package's Vcs-Git field, if there is
75 one - but note that in the general case the history found there may be
76 different to or even disjoint from dgit's view.
77 .TP
78 \fBdgit fetch\fR [\fIsuite\fP]
79 Consults the archive and git-repos to update the git view of
80 history for a specific suite (and downloads any necessary orig
81 tarballs), and updates the remote tracking branch
82 .BR remotes/dgit/dgit/ \fIsuite\fR.
83 If the current branch is
84 .BI dgit/ suite
85 then dgit fetch defaults to
86 .IR suite ;
87 otherwise it parses debian/changelog and uses the suite specified
88 there.
89 .TP
90 \fBdgit pull\fR [\fIsuite\fP]
91 Does dgit fetch, and then merges the new head of the remote tracking
92 branch
93 .BI remotes/dgit/dgit/ suite
94 into the current branch.
95 .TP
96 \fBdgit build\fR ...
97 Runs
98 .B dpkg-buildpackage
99 with some suitable options.  Options and arguments after build
100 will be passed on to dpkg-buildpackage.  It is not necessary to use
101 dgit build when using dgit; it is OK to use any approach which ensures
102 that the generated source package corresponds to the relevant git
103 commit.
104
105 Tagging, signing and actually uploading should be left to dgit push.
106 .TP
107 \fBdgit build-source\fR ...
108 Builds the source package, and a changes file for a prospective
109 source-only upload, using
110 .BR dpkg-source .
111 The output is left in
112 .IR package \fB_\fR version \fB.dsc\fR
113 and
114 .IR package \fB_\fR version \fB_source.changes\fR.
115
116 Tagging, signing and actually uploading should be left to dgit push.
117 .TP
118 .B dgit clean
119 Cleans the current working tree (according to the --clean= option in
120 force).
121 .TP
122 .B dgit help
123 Print a usage summary.
124 .TP
125 \fBdgit sbuild\fR ...
126 Constructs the source package, uses
127 .B  sbuild
128 to do a binary build, and uses mergechanges to merge the source and
129 binary changes files.  Options and arguments after sbuild will be
130 passed on to sbuild.
131 The output is left in
132 .IR package \fB_\fR version \fB_multi.changes\fR.
133
134 Tagging, signing and actually uploading should be left to dgit push.
135 .TP
136 \fBdgit gbp-build\fR ...
137 Runs
138 .B git-buildpackage
139 with some suitable options.  Options and arguments after gbp-build
140 will be passed on to git-buildpackage.
141
142 By default this uses \-\-quilt=gbp, so HEAD should be a
143 git-buildpackage style branch, not a patches-applied branch.
144
145 Tagging, signing and actually uploading should be left to dgit push.
146 .TP
147 \fBdgit push\fR [\fIsuite\fP]
148 Does an `upload', pushing the current HEAD to the archive (as a source
149 package) and to dgit-repos (as git commits).  The package must already
150 have been built ready for upload, with the .dsc and .changes
151 left in the parent directory.  It is normally best to do the build
152 with dgit too (eg with dgit sbuild): some existing build tools pass
153 unhelpful options to dpkg-source et al by default, which can result in
154 the built source package not being identical to the git tree.
155
156 In more detail: dgit push checks that the current HEAD corresponds to
157 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
158 makes a signed git tag, edits the .dsc to contain the dgit metadata
159 field, runs debsign to sign the upload (.dsc and .changes), pushes the
160 signed tag, and finally uses dput to upload the .changes to the
161 archive.
162
163 dgit push always uses the package, suite and version specified in the
164 debian/changelog and the .dsc, which must agree.  If the command line
165 specifies a suite then that must match too.
166
167 If dgit push fails while uploading, it is fine to simply retry the
168 dput on the .changes file at your leisure.
169 .TP
170 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
171 Pushes the contents of the specified directory on a remote machine.
172 This is like running dgit push on build-host with build-dir as the
173 current directory; however, signing operations are done on the
174 invoking host.  This allows you to do a push when the system which has
175 the source code and the build outputs has no access to the key:
176
177 1.      Clone on build host (dgit clone)
178 .br
179 2.      Edit code on build host (edit, git commit)
180 .br
181 3.      Build package on build host (dgit build)
182 .br
183 4.      Test package on build host or elsewhere (dpkg -i, test)
184 .br
185 5.      Upload by invoking dgit rpush on host with your GPG key.
186
187 However, the build-host must be able to ssh to the dgit repos.  If
188 this is not already the case, you must organise it separately, for
189 example by the use of ssh agent forwarding.
190
191 The remaining arguments are treated just as dgit push would handle
192 them.
193
194 build-host and build\-dir can be passed as separate
195 arguments; this is assumed to be the case if the first argument
196 contains no : (except perhaps one in [ ], to support IPv6 address
197 literals).
198
199 You will need similar enough versions of dgit on the build-host and
200 the invocation host.  The build-host needs gnupg installed, with your
201 public key in its keyring (but not your private key, obviously).
202 .TP
203 .B dgit setup-new-tree
204 Configure the current working tree the way that dgit clone would have
205 set it up.  Like running
206 .B dgit setup-useremail
207 and
208 .B setup-mergechangelogs
209 (but only does each thing if dgit is configured to do it automatically).
210 You can use these in any git repository, not just ones used with
211 the other dgit operations.
212 .TP
213 .B dgit setup-useremail
214 Set the working tree's user.name and user.email from the
215 distro-specific dgit configuration
216 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
217 or DEBFULLNAME or DEBEMAIL.
218 .TP
219 .B dgit setup-mergechangelogs
220 Configures a git merge helper for the file
221 .B debian/changelog
222 which uses
223 .BR dpkg-mergechangelogs .
224 .TP
225 .B dgit quilt-fixup
226 `3.0 (quilt)' format source packages need changes representing not
227 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
228 checks whether this has been done; if not, dgit will make appropriate
229 patches in debian/patches and also commit the resulting changes to
230 git.
231
232 This is normally done automatically by dgit build and dgit push.
233
234 dgit will try to turn each relevant commit in your git history into a
235 new quilt patch.  dgit cannot convert nontrivial merges, or certain
236 other kinds of more exotic history.  If dgit can't find a suitable
237 linearisation of your history, by default it will fail, but you can
238 ask it to generate a single squashed patch instead.
239 .TP
240 .B dgit version
241 Prints version information and exits.
242 .TP
243 .BI "dgit clone-dgit-repos-server" " destdir"
244 Tries to fetch a copy of the source code for the dgit-repos-server,
245 as actually being used on the dgit git server, as a git tree.
246 .SH OPTIONS
247 .TP
248 .BR --dry-run " | " -n
249 Go through the motions, fetching all information needed, but do not
250 actually update the output(s).  For push, dgit does
251 the required checks and leaves the new .dsc in a temporary file,
252 but does not sign, tag, push or upload.
253 .TP
254 .BR --damp-run " | " -L
255 Go through many more of the motions: do everything that doesn't
256 involve either signing things, or making changes on the public
257 servers.
258 .TP
259 .BI -k keyid
260 Use
261 .I keyid
262 for signing the tag and the upload.  The default comes from the
263 distro's
264 .B keyid
265 config setting (see CONFIGURATION, below), or failing that, the
266 uploader trailer line in debian/changelog.
267 .TP
268 .BR --no-sign
269 does not sign tags or uploads (meaningful only with push).
270 .TP
271 .TP
272 .BI -p package
273 Specifies that we should process source package
274 .I package
275 rather than looking in debian/control or debian/changelog.
276 Valid with dgit fetch and dgit pull, only.
277 .TP
278 .BR --clean=git " | " -wg
279 Use
280 .BR "git clean -xdf"
281 to clean the working tree,
282 rather than running the package's rules clean target.
283
284 This will delete all files which are not tracked by git.
285 (Including any files you forgot to git add.)
286
287 .BI --clean= ...
288 options other than dpkg-source
289 are useful when the package's clean target is troublesome, or
290 to avoid needing the build-dependencies.
291 .TP
292 .BR --clean=git-ff " | " -wgf
293 Use
294 .BR "git clean -xdff"
295 to clean the working tree.
296 Like
297 git clean -xdf
298 but it also removes any subdirectories containing different git
299 trees (which only unusual packages are likely to create).
300 .TP
301 .BR --clean=check " | " -wc
302 Merely check that the tree is clean (does not contain uncommitted
303 files).
304 Avoids running rules clean,
305 and can avoid needing the build-dependencies.
306 .TP
307 .BR --clean=none " | " -wn
308 Do not clean the tree, nor check that it is clean.
309 Avoids running rules clean,
310 and can avoid needing the build-dependencies.
311 If there are
312 files which are not in git, or if the build creates such files, a
313 subsequent dgit push will fail.
314 .TP
315 .BR --clean=dpkg-source " | " -wd
316 Use dpkg-buildpackage to do the clean, so that the source package
317 is cleaned by dpkg-source running the package's clean target.
318 This is the default.
319 Requires the package's build dependencies.
320 .TP
321 .BR --clean=dpkg-source-d " | " -wdd
322 Use
323 .B dpkg-buildpackage -d
324 to do the clean,
325 so that the source package
326 is cleaned by dpkg-source running the package's clean target.
327 The build-dependencies are not checked (due to
328 .BR -d ),
329 which violates policy, but may work in practice.
330 .TP
331 .BR -N " | " --new
332 The package is or may be new in this suite.  Without this, dgit will
333 refuse to push.  It may (for Debian, will) be unable to access the git
334 history for any packages which have been newly pushed and have not yet
335 been published.
336 .TP
337 .BR --ignore-dirty
338 Do not complain if the working tree does not match your git HEAD.
339 This can be useful with build, if you plan to commit later.  (dgit
340 push will still ensure that the .dsc you upload and the git tree
341 you push are identical, so this option won't make broken pushes.)
342 .TP
343 .BR --overwrite =\fIprevious-version\fR
344 Declare that even though your git branch is not a descendant
345 of the version in the archive
346 according to the revision history,
347 it really does contain
348 all the (wanted) changes from that version.
349
350 This option is useful if you are the maintainer, and you have
351 incorporated NMU changes into your own git workflow in a way that
352 doesn't make your branch a fast forward from the NMU.
353
354 .I previous-version
355 ought to be the version currently in the archive.  If
356 .I previous-version
357 is not
358 specified, dgit will check that the version in the archive is
359 mentioned in your debian/changelog.
360 (This will avoid losing
361 changes unless someone committed to git a finalised changelog
362 entry, and then made later changes to that version.)
363
364 dgit push --overwrite
365 will make a
366 pseudo-merge (that is, something that looks like the result
367 of git merge -s ours) to stitch the archive's version into your own
368 git history, so that your push is a fast forward from the archive.
369
370 (In quilt mode
371 .BR gbp ", " dpm " or " unpatched ,
372 implying a split between the dgit view and the
373 maintainer view, the pseudo-merge will appear only in the dgit view.)
374 .TP
375 .BI --deliberately- something
376 Declare that you are deliberately doing
377 .IR something .
378 This can be used to override safety catches, including safety catches
379 which relate to distro-specific policies.
380 The use of --deliberately is declared and published in the signed tags
381 generated for you by dgit,
382 so that the archive software can give effect to your intent,
383 and
384 for the benefit humans looking at the history.
385 The meanings of
386 .IR something s
387 understood in the context of Debian are discussed below:
388 .TP
389 .BR --deliberately-not-fast-forward
390 Declare that you are deliberately rewinding history.  When pushing to
391 Debian, use this when you are making a renewed upload of an entirely
392 new source package whose previous version was not accepted for release
393 from NEW because of problems with copyright or redistributibility.
394 .TP
395 .BR --deliberately-include-questionable-history
396 Declare that you are deliberately including, in the git history of
397 your current push, history which contains a previously-submitted
398 version of this package which was not approved (or has not yet been
399 approved) by the ftpmasters.  When pushing to Debian, only use this
400 option after verifying that: none of the rejected-from-NEW (or
401 never-accepted) versions in the git history of your current push, were
402 rejected by ftpmaster for copyright or redistributability reasons.
403 .TP
404 .BR --deliberately-fresh-repo
405 Declare that you are deliberately rewinding history and want to
406 throw away the existing repo.  Not relevant when pushing to Debian,
407 as the Debian server will do this automatically when necessary.
408 .TP
409 .BR --quilt=linear
410 When fixing up source format `3.0 (quilt)' metadata, insist on
411 generating a linear patch stack: one new patch for each relevant
412 commit.
413 If such a stack cannot be generated, fail.
414 This is the default for Debian.
415
416 HEAD should be a series of plain commits
417 (not touching debian/patches/),
418 and pseudomerges,
419 with as ancestor a patches-applied branch.
420 .TP
421 .BR --quilt=auto
422 When fixing up source format `3.0 (quilt)' metadata, prefer to
423 generate a linear patch stack
424 (as with --quilt=auto)
425 but if that doesn't seem possible,
426 try to generate a single squashed patch for all the changes made in git
427 (as with --quilt=smash).
428 This is not a good idea for an NMU in Debian.
429 .TP
430 .BR --quilt=smash
431 When fixing up source format `3.0 (quilt)' metadata,
432 generate a single additional patch for all the changes made in git.
433 This is not a good idea for an NMU in Debian.
434
435 (If HEAD has any in-tree patches already, they must apply cleanly.
436 This will be the case for any trees produced by dgit fetch or clone;
437 if you do not change the upstream version
438 nor make changes in debian/patches,
439 it will remain true.)
440 .TP
441 .BR --quilt=nofix
442 Check whether source format `3.0 (quilt)' metadata would need fixing
443 up, but, if it does, fail.  You must then fix the metadata yourself
444 somehow before pushing.  (NB that dpkg-source --commit will not work
445 because the dgit git tree does not have a
446 .B .pc
447 directory.)
448 .TP
449 .BR --quilt=nocheck " | " --no-quilt-fixup
450 Do not check whether up source format `3.0 (quilt)' metadata needs
451 fixing up.  If you use this option and the metadata did in fact need
452 fixing up, dgit push will fail.
453 .TP
454 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
455 Tell dgit that you are using a nearly-dgit-compatible git branch,
456 aka a
457 .BR "maintainer view" ,
458 and
459 do not want your branch changed by dgit.
460
461 .B --gbp
462 (short for
463 .BR --quilt=gbp )
464 is for use with git-buildpackage.
465 Your HEAD is expected to be
466 a patches-unapplied git branch, except that it might contain changes
467 to upstream .gitignore files.  This is the default for dgit gbp-build.
468
469 .B --dpm
470 (short for
471 .BR --quilt=dpm )
472 is for use with git-dpm.
473 Your HEAD is expected to be
474 a patches-applied git branch,
475 except that it might contain changes to upstream .gitignore files.
476
477 .B --quilt=unapplied
478 specifies that your HEAD is a patches-unapplied git branch (and
479 that any changes to upstream .gitignore files are represented as
480 patches in debian/patches).
481
482 With --quilt=gbp|dpm|unapplied,
483 dgit push (or precursors like quilt-fixup and build) will automatically
484 generate a conversion of your git branch into the right form.
485 dgit push will push the
486 dgit-compatible form (the
487 .BR "dgit view" )
488 to the dgit git server.
489 The dgit view will be visible to you
490 in the dgit remote tracking branches, but your own branch will
491 not be modified.
492 dgit push will create a tag
493 .BI debian/ version
494 for the maintainer view, and the dgit tag
495 .BI archive/debian/ version
496 for the dgit view.
497 dgit quilt-fixup will merely do some checks,
498 and cache the maintainer view.
499
500 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
501 This is because it is not always possible to tell: a patches-unapplied
502 git branch of a package with one patch, for example, looks very like
503 a patches-applied branch where the user has used git revert to
504 undo the patch, expecting to actually revert it.
505 However, if you fail to specify the right \-\-quilt option,
506 and you aren't too lucky, dgit will notice the problem and stop,
507 with a useful hint. 
508 .TP
509 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
510 Specifies that the suite to be operated on is part of distro
511 .IR distro .
512 This overrides the default value found from the git config option
513 .BR dgit-suite. \fIsuite\fR .distro .
514 The only effect is that other configuration variables (used
515 for accessing the archive and dgit-repos) used are
516 .BR dgit-distro. \fIdistro\fR .* .
517
518 If your suite is part of a distro that dgit already knows about, you
519 can use this option to make dgit work even if your dgit doesn't know
520 about the suite.  For example, specifying
521 .B -ddebian
522 will work when the suite is an unknown suite in the Debian archive.
523
524 To define a new distro it is necessary to define methods and URLs
525 for fetching (and, for dgit push, altering) a variety of information both
526 in the archive and in dgit-repos.
527 How to set this up is not yet documented.
528 .TP
529 .BI -C changesfile
530 Specifies the .changes file which is to be uploaded.  By default
531 dgit push looks for single .changes file in the parent directory whose
532 filename suggests it is for the right package and version.
533
534 If the specified
535 .I changesfile
536 pathname contains slashes, the directory part is also used as
537 the value for
538 .BR --build-products-dir ;
539 otherwise, the changes file is expected in that directory (by
540 default, in
541 .BR .. ).
542 .TP
543 .B --rm-old-changes
544 When doing a build, delete any changes files matching
545 .IB package _ version _*.changes
546 before starting.  This ensures that
547 dgit push (and dgit sbuild) will be able to unambigously
548 identify the relevant changes files from the most recent build, even
549 if there have been previous builds with different tools or options.
550 The default is not to remove, but
551 .B \-\-no-rm-old-changes
552 can be used to override a previous \-\-rm-old-changes
553 or the .rm-old-changes configuration setting.
554 .TP
555 .BI --build-products-dir= directory
556 Specifies where to find the built files to be uploaded.
557 By default, dgit looks in the parent directory
558 .RB ( .. ).
559 .TP
560 .BI --no-rm-on-error
561 Do not delete the destination directory if clone fails.
562 .TP
563 .BI -D
564 Prints debugging information to stderr.  Repeating the option produces
565 more output (currently, up to -DDDD is meaningfully different).
566 .TP
567 .BI -c name = value
568 Specifies a git configuration option, to be used for this run.
569 dgit itself is also controlled by git configuration options.
570 .TP
571 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
572 Specifies the
573 .BI -v version
574 option to pass to dpkg-genchanges, during builds.  Changes (from
575 debian/changelog) since this version will be included in the built
576 changes file, and hence in the upload.  If this option is not
577 specified, dgit will query the archive and use the latest version
578 uploaded to the intended suite.
579
580 Specifying
581 .B _
582 inhibits this, so that no -v option will be passed to dpkg-genchanges
583 (and as a result, only the last stanza from debian/changelog will
584 be used for the build and upload).
585 .TP
586 .RI \fB-m\fR maintaineraddress
587 Passed to dpkg-genchanges (eventually).
588 .TP
589 .RI \fB--ch:\fR option
590 Specifies a single additional option to pass, eventually, to
591 dpkg-genchanges.
592
593 Options which are safe to pass include
594 .BR "-si -sa -sd -C" .
595
596 For other options the caveat below applies.
597 .TP
598 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
599 Specifies a single additional option to pass to
600 .BR curl ,
601 .BR dput ,
602 .BR debsign ,
603 .BR dpkg-source ,
604 .BR dpkg-buildpackage ,
605 .BR dpkg-genchanges ,
606 .BR sbuild ,
607 .BR ssh ,
608 .BR dgit ,
609 .BR gbp-pq ,
610 .BR gbp-build ,
611 or
612 .BR mergechanges .
613 Can be repeated as necessary.
614
615 Use of this ability should not normally be necessary.
616 It is provided for working around bugs,
617 or other unusual situations.
618 If you use these options,
619 you may violate dgit's assumptions
620 about the behaviour of its subprograms
621 and cause lossage.
622
623 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
624 the option applies only when the program is invoked directly by dgit.
625 Usually, for passing options to dpkg-genchanges, you should use
626 .BR --ch: \fIoption\fR.
627
628 Specifying --git is not effective for some lower-level read-only git
629 operations performed by dgit, and also not when git is invoked by
630 another program run by dgit.
631
632 See notes below regarding ssh and dgit.
633
634 NB that --gpg:option is not supported (because debsign does not
635 have that facility).
636 But see
637 .B -k
638 and the
639 .B keyid
640 distro config setting.
641 .TP
642 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
643 Specifies alternative programs to use instead of
644 .BR curl ,
645 .BR dput ,
646 .BR debsign ,
647 .BR dpkg-source ,
648 .BR dpkg-buildpackage ,
649 .BR dpkg-genchanges ,
650 .BR sbuild ,
651 .BR gpg ,
652 .BR ssh ,
653 .BR dgit ,
654 .BR git ,
655 .BR gbp-pq ,
656 .BR gbp-build ,
657 or
658 .BR mergechanges .
659
660 For
661 .BR dpkg-buildpackage ,
662 .BR dpkg-genchanges ,
663 .B mergechanges
664 and
665 .BR sbuild ,
666 this applies only when the program is invoked directly by dgit.
667
668 For
669 .BR dgit ,
670 specifies the command to run on the remote host when dgit
671 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
672 itself as the EDITOR for dpkg-source --commit; this is done using
673 argv[0], and is not affected by --dgit=).
674
675 .BR gbp-build 's
676 value
677 is used instead of gbp build or git-buildpackage.  (The default is
678 the latter unless the former exists on PATH.)
679 .BR gbp-pq 's
680 value
681 is used instead of gbp pq.
682 In both cases,
683 unusually, the specified value is split on whitespace
684 to produce a command and possibly some options and/or arguments.
685
686 For
687 .BR ssh ,
688 the default value is taken from the
689 .B DGIT_SSH
690 or
691 .B GIT_SSH
692 environment variables, if set (see below).  And, for ssh, when accessing the
693 archive and dgit-repos, this command line setting is overridden by the
694 git config variables
695 .BI dgit-distro. distro .ssh
696 and
697 .B .dgit.default.ssh
698 (which can in turn be overridden with -c).  Also, when dgit is using
699 git to access dgit-repos, only git's idea of what ssh to use (eg,
700 .BR GIT_SSH )
701 is relevant.
702 .TP
703 .BI --existing-package= package
704 dgit push needs to canonicalise the suite name.  Sometimes, dgit
705 lacks a way to ask the archive to do this without knowing the
706 name of an existing package.  Without --new we can just use the
707 package we are trying to push.  But with --new that will not work, so
708 we guess
709 .B dpkg
710 or use the value of this option.  This option is not needed with the
711 default mechanisms for accessing the archive.
712 .TP
713 .BR -h | --help
714 Print a usage summary.
715 .TP
716 .BI --initiator-tempdir= directory
717 dgit rpush uses a temporary directory on the invoking (signing) host.
718 This option causes dgit to use
719 .I directory
720 instead.  Furthermore, the specified directory will be emptied,
721 removed and recreated before dgit starts, rather than removed
722 after dgit finishes.  The directory specified must be an absolute
723 pathname.
724 .TP
725 .BI --force- something
726 Instructs dgit to try to proceed despite detecting
727 what it thinks is going to be a fatal problem.
728 .B This is probably not going to work.
729 These options are provided as an escape hatch,
730 in case dgit is confused.
731 (They might also be useful for testing error cases.)
732 .TP
733 .B --force-unrepresentable
734 Carry on even if
735 dgit thinks that your git tree contains changes
736 (relative to your .orig tarballs)
737 which dpkg-source is not able to represent.
738 Your build or push will probably fail later.
739 .TP
740 .B --force-unsupported-source-format
741 Carry on despite dgit not understanding your source package format.
742 dgit will probably mishandle it.
743 .TP
744 .B --force-dsc-changes-mismatch
745 Do not check whether .dsc and .changes match.
746 The archive will probably reject your upload.
747 .TP
748 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
749 Force on or off the use of the absurd git-apply emulation
750 when running gbp pq import
751 when importing a package from a .dsc.
752 See Debian bug #841867.
753 .SH WORKFLOW - SIMPLE
754 It is always possible with dgit to clone or fetch a package, make
755 changes in git (using git-commit) on the suite branch
756 .RB ( "git checkout dgit/" \fIsuite\fR)
757 and then dgit push.  You can use whatever gitish techniques you like
758 to construct the commits to push;
759 the only requirement is that what you push is a
760 descendant of the state of the archive, as provided by dgit in the
761 remote tracking branch
762 .BR remotes/dgit/dgit/ \fIsuite\fR.
763
764 If you are using dgit to do an NMU (in Debian),
765 and don't know about the
766 maintainers' preferred packaging workflows, you should make your
767 changes as a linear series of (logicially separated) commits on top of
768 what's already in the archive.
769
770 If you are lucky the other uploaders have also used dgit and
771 integrated the other relevant git history; if not you can fetch it
772 into your tree and cherry-pick etc. as you wish.
773 .SH WORKFLOW - INTEGRATING BETWEEN DGIT AND OTHER GIT HISTORY
774 If you are the maintainer of a package dealing with uploads made
775 without dgit, you will probably want to merge the synthetic commits
776 (made by dgit to represent the uploads) into your git history.
777 Normally you can just merge the dgit branch into your own master, or
778 indeed if you do your work on the dgit local suite branch
779 .BI dgit/ suite
780 you can just use dgit pull.
781
782 However the first time dgit is used it will generate a new origin
783 commit from the archive which won't be linked into the rest of your
784 git history.  You will need to merge this.
785
786 If last upload was in fact made with git, you should usually proceed
787 as follows: identify the commit which was actually used to build the
788 package.  (Hopefully you have a tag for this.)  Check out the dgit
789 branch
790 .RB ( "git checkout dgit/" \fIsuite\fR)
791 and merge that other commit
792 .RB ( "git merge debian/" \fIversion\fR).
793 Hopefully this merge will be trivial because the two trees should
794 be very similar.  The resulting branch head can be merged into your
795 working branches
796 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
797
798 If last upload was not made with git, a different approach is required
799 to start using dgit.  First, do
800 .B dgit fetch
801 (or clone) to obtain a git history representation of what's in the
802 archive and record it in the
803 .BI remotes/dgit/dgit/ suite
804 tracking branch.  Then somehow, using your other git history
805 plus appropriate diffs and cherry picks from the dgit remote tracking
806 branch, construct a git commit whose tree corresponds to the tree to use for the
807 next upload. 
808
809 between what's in the archive and what you intend to upload.
810 Then run
811 .BR "dgit push"
812 to actually upload the result.
813
814 If the commit-to-be-uploaded is not a descendant of the
815 dgit remote tracking branch, you will need to pass
816 .B --overwrite
817 to dgit.
818 .SH CONFIGURATION
819 dgit can be configured via the git config system.
820 You may set keys with git-config (either in system-global or per-tree
821 configuration), or provide
822 .BI -c key = value
823 on the dgit command line.
824 .LP
825 Settings likely to be useful for an end user include:
826 .TP
827 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
828 Specifies the distro for a suite.  dgit keys off the suite name (which
829 appears in changelogs etc.), and uses that to determine the distro
830 which is involved.  The config used is thereafter that for the distro.
831 .TP
832 .BI dgit.default.distro " distro"
833 The default distro for an unknown suite.
834 .TP
835 .BR dgit.default. *
836 for each
837 .BR dgit-distro. \fIdistro\fR . *,
838 the default value used if there is no distro-specific setting.
839 .TP
840 .BR dgit-distro. \fIdistro\fR .clean-mode
841 One of the values for the command line --clean= option; used if
842 --clean is not specified.
843 .TP
844 .BR dgit-distro. \fIdistro\fR .quilt-mode
845 One of the values for the command line --quilt= option; used if
846 --quilt is not specified.
847 .TP
848 .BR dgit-distro. \fIdistro\fR .rm-old-changes
849 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
850 is specified.  The default is not to remove.
851 .TP
852 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
853 Whether you have push access to the distro.
854 For Debian, it is OK to use auto, which uses readonly mode if you are
855 not pushing right now;
856 but, setting this to false will avoid relying on the mirror of the dgit
857 git repository server.
858 .TP
859 .BI dgit-distro. distro .keyid
860 See also
861 .BR -k .
862 .TP
863 .BI dgit-distro. distro .mirror " url"
864 .TP
865 .BI dgit-distro. distro .username
866 Not relevant for Debian.
867 .TP
868 .BI dgit-distro. distro .upload-host
869 Might be useful if you have an intermediate queue server.
870 .TP
871 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
872 Values to configure for user.name and user.email in new git trees.  If
873 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
874 used, respectively.  Only used if .setup-usermail is not disabled.
875 .TP
876 .BI dgit-distro. distro .setup-useremail
877 Whether to set user.name and user.email in new git trees.
878 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
879 .TP
880 .BI dgit-distro. distro .setup-mergechangelogs
881 Whether to setup a merge driver which uses dpkg-mergechangelogs for
882 debian/changelog.  True by default.  Ignored for dgit
883 setup-mergechangelogs, which does it anyway.
884 .TP
885 .BI dgit-distro. distro .cmd- cmd
886 Program to use instead of
887 .IR cmd .
888 Works like
889 .BR -- \fIcmd\fR = "... ."
890 .TP
891 .BI dgit-distro. distro .opts- cmd
892 Extra options to pass to
893 .IR cmd .
894 Works like
895 .BR -- \fIcmd\fR : "... ."
896 To pass several options, configure multiple values in git config
897 (with git config --add).  The options for
898 .BI dgit.default.opts- cmd
899 .BI dgit-distro. distro /push.opts- cmd
900 and are all used, followed by options from dgit's command line.
901 .SH ACCESS CONFIGURATION
902 There are many other settings which specify how a particular distro's
903 services (archive and git) are provided.  These should not normally be
904 adjusted, but are documented for the benefit of distros who wish to
905 adopt dgit.
906 .TP
907 .BR dgit-distro. \fIdistro\fR /push. *
908 If set, overrides corresponding non \fB/push\fR config when
909 .BR readonly=false ,
910 or when pushing and
911 .BR readonly=auto .
912 .TP
913 .BI dgit-distro. distro .git-url
914 .TP
915 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
916 .TP
917 .BI dgit-distro. distro .git-proto
918 .TP
919 .BI dgit-distro. distro .git-path
920 .TP
921 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
922 .TP
923 .BI dgit-distro. distro .git-check-suffix
924 .TP
925 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
926 .TP
927 .BI dgit-distro. distro .git-create " " ssh-cmd | true
928 .TP
929 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
930 .TP
931 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
932 .TP
933 .BI dgit-distro. distro .madison-distro
934 .TP
935 .BI dgit-distro. distro .archive-query-default-component
936 .TP
937 .BI dgit-distro. distro .dgit-tag-format
938 .TP
939 .BI dgit-distro. distro .ssh
940 .TP
941 .BI dgit-distro. distro .sshpsql-dbname
942 .TP
943 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
944 .TP
945 .BI dgit-distro. distro .backports-quirk
946 .SH ENVIRONMENT VARIABLES
947 .TP
948 .BR DGIT_SSH ", " GIT_SSH
949 specify an alternative default program (and perhaps arguments) to use
950 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
951 if it contains any whitespace will be passed to the shell.  GIT_SSH
952 specifies just the program; no arguments can be specified, so dgit
953 interprets it the same way as git does.
954 See
955 also the --ssh= and --ssh: options.
956 .TP
957 .BR DEBEMAIL ", " DEBFULLNAME
958 Default git user.email and user.name for new trees.  See
959 .BR "dgit setup-new-tree" .
960 .TP
961 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
962 and other subprograms and modules used by dgit are affected by various
963 environment variables.  Consult the documentaton for those programs
964 for details.
965 .SH BUGS
966 dgit's git representation of format `3.0 (quilt)' source packages does
967 not represent the patch stack as git commits.  Currently the patch
968 series representation cannot round trip between git and the archive.
969 Ideally dgit would represent a quilty package with an origin commit of
970 some kind followed by the patch stack as a series of commits followed
971 by a pseudo-merge (to make the branch fast-forwarding).  This would
972 also mean a new `dgit rebase-prep' command or some such to turn such a
973 fast-forwarding branch back into a rebasing patch stack, and a `force'
974 option to dgit push (perhaps enabled automatically by a note left by
975 rebase-prep) which will make the required pseudo-merge.
976
977 If the dgit push fails halfway through, it should be restartable and
978 idempotent.  However this is not true for the git tag operation.
979 Also, it would be good to check that the proposed signing key is
980 available before starting work.
981
982 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
983 the .orig.tar.gz could be transported via the git repo as git tags.
984 Doing this is made more complicated by the possibility of a `3.0
985 (quilt)' package with multiple .orig tarballs.
986
987 dgit's build functions, and dgit push, should not make any changes to
988 your current HEAD.  Sadly this is necessary for packages in the `3.0
989 (quilt)' source format.  This is ultimately due to what I consider
990 design problems in quilt and dpkg-source.
991
992 There should be an option which arranges for the `3.0 (quilt)'
993 autocommit(s) to not appear on your HEAD, but instead only in the
994 remote tracking suite branch.
995
996 --dry-run does not always work properly, as not doing some of the git
997 fetches may result in subsequent actions being different.  Doing a
998 non-dry-run dgit fetch first will help.
999 .SH SEE ALSO
1000 \fBdgit\fP(7),
1001 \fBdgit-maint-merge\fP(7),
1002 \fBcurl\fP(1),
1003 \fBdput\fP(1),
1004 \fBdebsign\fP(1),
1005 \fBgit-config\fP(1),
1006 \fBgit-buildpackage\fP(1),
1007 \fBdpkg-buildpackage\fP(1),
1008 .br
1009 https://browse.dgit.debian.org/