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