chiark / gitweb /
dgit(1): Remove comment about retries
[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: doing a straightforward NMU
40 dgit-maint-native(7)    for maintainers of Debian-native packages
41 dgit-maint-merge(7)     for maintainers who want a pure git workflow
42 dgit-maint-gbp(7)       for maintainers already using git-buildpackage
43 dgit-sponsorship(7)     for sponsors and sponsored contributors
44 .TE
45 .LP
46 See \fBdgit(7)\fP for detailed information about the data
47 model,
48 common problems likely to arise with certain kinds of package,
49 etc.
51 .TP
52 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
53 Consults the archive and dgit-repos to construct the git view of
54 history for
55 .I package
56 in
57 .I suite
58 .RB ( sid
59 by default)
60 in a new directory (named
61 .BI ./ package
62 by default);
63 also, downloads any necessary orig tarballs.
65 The suite's git tip is
66 left on the local branch
67 .BI dgit/ suite
68 ready for work, and on the corresponding dgit remote tracking branch.
69 The
70 .B origin
71 remote will be set up to point to the package's dgit-repos tree
72 for the distro to which
73 .I suite
74 belongs.
76 .I suite
77 may be a combination of several underlying suites in the form
78 .IR mainsuite \fB,\fR subsuite ...;
79 see COMBINED SUITES in dgit(7).
81 For your convenience, the
82 .B vcs-git
83 remote will be set up from the package's Vcs-Git field, if there is
84 one - but note that in the general case the history found there may be
85 different to or even disjoint from dgit's view.
86 .TP
87 \fBdgit fetch\fR [\fIsuite\fP]
88 Consults the archive and git-repos to update the git view of
89 history for a specific suite (and downloads any necessary orig
90 tarballs), and updates the remote tracking branch
91 .BR remotes/dgit/dgit/ \fIsuite\fR.
92 If the current branch is
93 .BI dgit/ suite
94 then dgit fetch defaults to
95 .IR suite ;
96 otherwise it parses debian/changelog and uses the suite specified
97 there.
98 suite may be a combined suite, as for clone.
99 .TP
100 \fBdgit pull\fR [\fIsuite\fP]
101 Does dgit fetch, and then merges the new head of the remote tracking
102 branch
103 .BI remotes/dgit/dgit/ suite
104 into the current branch.
105 .TP
106 \fBdgit build\fR ...
107 Runs
108 .B dpkg-buildpackage
109 with some suitable options.  Options and arguments after build
110 will be passed on to dpkg-buildpackage.  It is not necessary to use
111 dgit build when using dgit; it is OK to use any approach which ensures
112 that the generated source package corresponds to the relevant git
113 commit.
115 Tagging, signing and actually uploading should be left to dgit push.
116 .TP
117 \fBdgit build-source\fR ...
118 Builds the source package, and a changes file for a prospective
119 source-only upload, using
120 .BR dpkg-source .
121 The output is left in
122 .IR package \fB_\fR version \fB.dsc\fR
123 and
124 .IR package \fB_\fR version \fB_source.changes\fR.
126 Tagging, signing and actually uploading should be left to dgit push.
127 .TP
128 .B dgit clean
129 Cleans the current working tree (according to the --clean= option in
130 force).
131 .TP
132 .B dgit help
133 Print a usage summary.
134 .TP
135 \fBdgit sbuild\fR ...
136 Constructs the source package, uses
137 .B  sbuild
138 to do a binary build, and uses mergechanges to merge the source and
139 binary changes files.  Options and arguments after sbuild will be
140 passed on to sbuild.
141 The output is left in
142 .IR package \fB_\fR version \fB_multi.changes\fR.
143 .IP
144 Note that by default
145 sbuild does not build arch-independent packages.
146 You probably want to pass -A, to request those.
147 .IP
148 Tagging, signing and actually uploading should be left to dgit push.
149 .TP
150 \fBdgit gbp-build\fR ...
151 Runs
152 .B git-buildpackage
153 with some suitable options.  Options and arguments after gbp-build
154 will be passed on to git-buildpackage.
156 By default this uses \-\-quilt=gbp, so HEAD should be a
157 git-buildpackage style branch, not a patches-applied branch.
159 Tagging, signing and actually uploading should be left to dgit push.
160 .TP
161 \fBdgit push\fR [\fIsuite\fP]
162 Does an `upload', pushing the current HEAD to the archive (as a source
163 package) and to dgit-repos (as git commits).  The package must already
164 have been built ready for upload, with the .dsc and .changes
165 left in the parent directory.  It is normally best to do the build
166 with dgit too (eg with dgit sbuild): some existing build tools pass
167 unhelpful options to dpkg-source et al by default, which can result in
168 the built source package not being identical to the git tree.
170 In more detail: dgit push checks that the current HEAD corresponds to
171 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
172 adjusts the .changes to include any .origs which the archive lacks
173 and exclude .origs which the archive has
174 (so -sa and -sd are not needed when building for dgit push),
175 makes a signed git tag, edits the .dsc to contain the dgit metadata
176 field, runs debsign to sign the upload (.dsc and .changes), pushes the
177 signed tag, and finally uses dput to upload the .changes to the
178 archive.
180 dgit push always uses the package, suite and version specified in the
181 debian/changelog and the .dsc, which must agree.  If the command line
182 specifies a suite then that must match too.
183 .TP
184 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
185 Pushes the contents of the specified directory on a remote machine.
186 This is like running dgit push on build-host with build-dir as the
187 current directory; however, signing operations are done on the
188 invoking host.  This allows you to do a push when the system which has
189 the source code and the build outputs has no access to the key:
191 .TS
192 l l.
193 1.      Clone on build host (dgit clone)
194 2.      Edit code on build host (edit, git commit)
195 3.      Build package on build host (dgit build)
196 4.      Test package on build host or elsewhere (dpkg -i, test)
197 5.      Upload by invoking dgit rpush on host with your GPG key.
198 .TE
200 However, the build-host must be able to ssh to the dgit repos.  If
201 this is not already the case, you must organise it separately, for
202 example by the use of ssh agent forwarding.
204 The remaining arguments are treated just as dgit push would handle
205 them.
207 build-host and build\-dir can be passed as separate
208 arguments; this is assumed to be the case if the first argument
209 contains no : (except perhaps one in [ ], to support IPv6 address
210 literals).
212 You will need similar enough versions of dgit on the build-host and
213 the invocation host.  The build-host needs gnupg installed, with your
214 public key in its keyring (but not your private key, obviously).
215 .TP
216 .B dgit setup-new-tree
217 Configure the current working tree the way that dgit clone would have
218 set it up.  Like running
219 .B dgit setup-useremail
220 and
221 .B setup-mergechangelogs
222 (but only does each thing if dgit is configured to do it automatically).
223 You can use these in any git repository, not just ones used with
224 the other dgit operations.
225 .TP
226 .B dgit setup-useremail
227 Set the working tree's and from the
228 distro-specific dgit configuration
229 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
231 .TP
232 .B dgit setup-mergechangelogs
233 Configures a git merge helper for the file
234 .B debian/changelog
235 which uses
236 .BR dpkg-mergechangelogs .
237 .TP
238 .B dgit quilt-fixup
239 `3.0 (quilt)' format source packages need changes representing not
240 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
241 checks whether this has been done; if not, dgit will make appropriate
242 patches in debian/patches and also commit the resulting changes to
243 git.
245 This is normally done automatically by dgit build and dgit push.
247 dgit will try to turn each relevant commit in your git history into a
248 new quilt patch.  dgit cannot convert nontrivial merges, or certain
249 other kinds of more exotic history.  If dgit can't find a suitable
250 linearisation of your history, by default it will fail, but you can
251 ask it to generate a single squashed patch instead.
252 .TP
253 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
254 Import a Debian-format source package,
255 specified by its .dsc,
256 into git,
257 the way dgit fetch would do.
259 This does about half the work of dgit fetch:
260 it will convert the .dsc into a new, orphan git branch.
261 Since dgit has no access to a corresponding source package archive
262 or knowledge of the history
263 it does not consider whether this version is newer
264 than any previous import
265 or corresponding git branches;
266 and it therefore does not
267 make a pseudomerge to bind the import
268 into any existing git history.
270 Because a .dsc can contain a Dgit field naming a git commit
271 (which you might not have),
272 and specifying where to find that commit
273 (and any history rewrite table),
274 import-dsc might need online access.
275 If this is a problem
276 (or dgit's efforts to find the commit fail),
277 consider --no-chase-dsc-distro
278 or --force-import-dsc-with-dgit-field.
280 There is only only sub-option:
282 .B --require-valid-signature
283 causes dgit to insist that the signature on the .dsc is valid
284 (using the same criteria as dpkg-source -x).
285 Otherwise, dgit tries to verify the signature but
286 the outcome is reported only as messages to stderr.
288 If
289 .I branch
290 is prefixed with
291 .B +
292 then if it already exists, it will be simply ovewritten,
293 no matter its existing contents.
294 If
295 .I branch
296 is prefixed with
297 .B ..
298 then if it already exists
299 and dgit actually imports the dsc
300 (rather than simply reading the git commit out of the Dgit field),
301 dgit will make a pseudomerge
302 so that the result is necessarily fast forward
303 from the existing branch.
304 Otherwise, if branch already exists,
305 dgit will stop with an error message.
307 If
308 .I branch
309 does not start with refs/, refs/heads/ is prepended.
310 The specified branch is unconditionally updated.
311 .TP
312 .B dgit version
313 Prints version information and exits.
314 .TP
315 .BI "dgit clone-dgit-repos-server" " destdir"
316 Tries to fetch a copy of the source code for the dgit-repos-server,
317 as actually being used on the dgit git server, as a git tree.
318 .TP
319 .BI "dgit print-dgit-repos-server-source-url"
320 Prints the url used by dgit clone-dgit-repos-server.
321 This is hopefully suitable for use as a git remote url.
322 It may not be useable in a browser.
324 .TP
325 .BR --dry-run " | " -n
326 Go through the motions, fetching all information needed, but do not
327 actually update the output(s).  For push, dgit does
328 the required checks and leaves the new .dsc in a temporary file,
329 but does not sign, tag, push or upload.
330 .TP
331 .BR --damp-run " | " -L
332 Go through many more of the motions: do everything that doesn't
333 involve either signing things, or making changes on the public
334 servers.
335 .TP
336 .BI -k keyid
337 Use
338 .I keyid
339 for signing the tag and the upload.  The default comes from the
340 distro's
341 .B keyid
342 config setting (see CONFIGURATION, below), or failing that, the
343 uploader trailer line in debian/changelog.
344 .TP
345 .BR --no-sign
346 does not sign tags or uploads (meaningful only with push).
347 .TP
348 .TP
349 .BI -p package
350 Specifies that we should process source package
351 .I package
352 rather than looking in debian/control or debian/changelog.
353 Valid with dgit fetch and dgit pull, only.
354 .TP
355 .BR --clean=git " | " -wg
356 Use
357 .BR "git clean -xdf"
358 to clean the working tree,
359 rather than running the package's rules clean target.
361 This will delete all files which are not tracked by git.
362 (Including any files you forgot to git add.)
364 .BI --clean= ...
365 options other than dpkg-source
366 are useful when the package's clean target is troublesome, or
367 to avoid needing the build-dependencies.
368 .TP
369 .BR --clean=git-ff " | " -wgf
370 Use
371 .BR "git clean -xdff"
372 to clean the working tree.
373 Like
374 git clean -xdf
375 but it also removes any subdirectories containing different git
376 trees (which only unusual packages are likely to create).
377 .TP
378 .BR --clean=check " | " -wc
379 Merely check that the tree is clean (does not contain uncommitted
380 files).
381 Avoids running rules clean,
382 and can avoid needing the build-dependencies.
383 .TP
384 .BR --clean=none " | " -wn
385 Do not clean the tree, nor check that it is clean.
386 Avoids running rules clean,
387 and can avoid needing the build-dependencies.
388 If there are
389 files which are not in git, or if the build creates such files, a
390 subsequent dgit push will fail.
391 .TP
392 .BR --clean=dpkg-source " | " -wd
393 Use dpkg-buildpackage to do the clean, so that the source package
394 is cleaned by dpkg-source running the package's clean target.
395 This is the default.
396 Requires the package's build dependencies.
397 .TP
398 .BR --clean=dpkg-source-d " | " -wdd
399 Use
400 .B dpkg-buildpackage -d
401 to do the clean,
402 so that the source package
403 is cleaned by dpkg-source running the package's clean target.
404 The build-dependencies are not checked (due to
405 .BR -d ),
406 which violates policy, but may work in practice.
407 .TP
408 .BR -N " | " --new
409 The package is or may be new in this suite.  Without this, dgit will
410 refuse to push.  It may (for Debian, will) be unable to access the git
411 history for any packages which have been newly pushed and have not yet
412 been published.
413 .TP
414 .BR --ignore-dirty
415 Do not complain if the working tree does not match your git HEAD.
416 This can be useful with build, if you plan to commit later.  (dgit
417 push will still ensure that the .dsc you upload and the git tree
418 you push are identical, so this option won't make broken pushes.)
419 .TP
420 .BR --overwrite =\fIprevious-version\fR
421 Declare that even though your git branch is not a descendant
422 of the version in the archive
423 according to the revision history,
424 it really does contain
425 all the (wanted) changes from that version.
427 This option is useful if you are the maintainer, and you have
428 incorporated NMU changes into your own git workflow in a way that
429 doesn't make your branch a fast forward from the NMU.
431 .I previous-version
432 ought to be the version currently in the archive.  If
433 .I previous-version
434 is not
435 specified, dgit will check that the version in the archive is
436 mentioned in your debian/changelog.
437 (This will avoid losing
438 changes unless someone committed to git a finalised changelog
439 entry, and then made later changes to that version.)
441 dgit push --overwrite
442 will make a
443 pseudo-merge (that is, something that looks like the result
444 of git merge -s ours) to stitch the archive's version into your own
445 git history, so that your push is a fast forward from the archive.
447 (In quilt mode
448 .BR gbp ", " dpm " or " unpatched ,
449 implying a split between the dgit view and the
450 maintainer view, the pseudo-merge will appear only in the dgit view.)
451 .TP
452 .BR --delayed =\fIdays\fR
453 Upload to a DELAYED queue.
456 If the maintainer responds by cancelling
457 your upload from the queue,
458 and does not make an upload of their own,
459 this will not rewind the git branch on the dgit git server.
460 Other dgit users will then see your push
461 (with a warning message from dgit)
462 even though the maintainer wanted to abolish it.
463 Such users might unwittingly reintroduce your changes.
465 If this situation arises,
466 someone should make a suitable dgit push
467 to update the contents of dgit-repos
468 to a version without the controversial changes.
469 .TP
470 .BR --no-chase-dsc-distro
471 Tells dgit not to look online
472 for additional git repositories
473 containing information about a particular .dsc being imported.
474 Chasing is the default.
476 For most operations
477 (such as fetch and pull),
478 disabling chasing
479 means dgit will access only the git server
480 for the distro you are directly working with,
481 even if the .dsc was copied verbatim from another distro.
482 For import-dsc,
483 disabling chasing
484 means dgit will work completely offline.
486 Disabling chasing can be hazardous:
487 if the .dsc names a git commit which has been rewritten
488 by those in charge of the distro,
489 this option may prevent that rewrite from being effective.
490 Also,
491 using it can mean that
492 dgit fails to find necessary git commits.
493 .TP
494 .BR --dgit-view-save= \fIbranch\fR|\fIref\fR
495 Specifies that when a split view quilt mode is in operation,
496 and dgit calculates
497 (or looks up in its cache)
498 a dgit view corresponding to your HEAD,
499 the dgit view will be left in
500 .IR ref .
501 The specified ref is unconditionally overwritten,
502 so don't specify a branch you want to keep.
504 This option is effective only with the following operations:
505 quilt-fixup; push; all builds.
506 And it is only effective with
507 --[quilt=]gbp,
508 --[quilt=]dpm,
509 --quilt=unpatched.
511 If ref does not start with refs/
512 it is taken to to be a branch -
513 i.e. refs/heads/ is prepended.
514 .TP
515 .BI --deliberately- something
516 Declare that you are deliberately doing
517 .IR something .
518 This can be used to override safety catches, including safety catches
519 which relate to distro-specific policies.
520 The use of --deliberately is declared and published in the signed tags
521 generated for you by dgit,
522 so that the archive software can give effect to your intent,
523 and
524 for the benefit humans looking at the history.
525 The meanings of
526 .IR something s
527 understood in the context of Debian are discussed below:
528 .TP
529 .BR --deliberately-not-fast-forward
530 Declare that you are deliberately rewinding history.  When pushing to
531 Debian, use this when you are making a renewed upload of an entirely
532 new source package whose previous version was not accepted for release
533 from NEW because of problems with copyright or redistributibility.
534 .TP
535 .BR --deliberately-include-questionable-history
536 Declare that you are deliberately including, in the git history of
537 your current push, history which contains a previously-submitted
538 version of this package which was not approved (or has not yet been
539 approved) by the ftpmasters.  When pushing to Debian, only use this
540 option after verifying that: none of the rejected-from-NEW (or
541 never-accepted) versions in the git history of your current push, were
542 rejected by ftpmaster for copyright or redistributability reasons.
543 .TP
544 .BR --deliberately-fresh-repo
545 Declare that you are deliberately rewinding history and want to
546 throw away the existing repo.  Not relevant when pushing to Debian,
547 as the Debian server will do this automatically when necessary.
548 .TP
549 .BR --quilt=linear
550 When fixing up source format `3.0 (quilt)' metadata, insist on
551 generating a linear patch stack: one new patch for each relevant
552 commit.
553 If such a stack cannot be generated, fail.
554 This is the default for Debian.
556 HEAD should be a series of plain commits
557 (not touching debian/patches/),
558 and pseudomerges,
559 with as ancestor a patches-applied branch.
560 .TP
561 .BR --quilt=auto
562 When fixing up source format `3.0 (quilt)' metadata, prefer to
563 generate a linear patch stack
564 (as with --quilt=auto)
565 but if that doesn't seem possible,
566 try to generate a single squashed patch for all the changes made in git
567 (as with --quilt=smash).
568 This is not a good idea for an NMU in Debian.
569 .TP
570 .BR --quilt=smash
571 When fixing up source format `3.0 (quilt)' metadata,
572 generate a single additional patch for all the changes made in git.
573 This is not a good idea for an NMU in Debian.
575 (If HEAD has any in-tree patches already, they must apply cleanly.
576 This will be the case for any trees produced by dgit fetch or clone;
577 if you do not change the upstream version
578 nor make changes in debian/patches,
579 it will remain true.)
580 .TP
581 .BR --quilt=nofix
582 Check whether source format `3.0 (quilt)' metadata would need fixing
583 up, but, if it does, fail.  You must then fix the metadata yourself
584 somehow before pushing.  (NB that dpkg-source --commit will not work
585 because the dgit git tree does not have a
586 .B .pc
587 directory.)
588 .TP
589 .BR --quilt=nocheck " | " --no-quilt-fixup
590 Do not check whether up source format `3.0 (quilt)' metadata needs
591 fixing up.  If you use this option and the metadata did in fact need
592 fixing up, dgit push will fail.
593 .TP
594 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
595 Tell dgit that you are using a nearly-dgit-compatible git branch,
596 aka a
597 .BR "maintainer view" ,
598 and
599 do not want your branch changed by dgit.
601 .B --gbp
602 (short for
603 .BR --quilt=gbp )
604 is for use with git-buildpackage.
605 Your HEAD is expected to be
606 a patches-unapplied git branch, except that it might contain changes
607 to upstream .gitignore files.  This is the default for dgit gbp-build.
609 .B --dpm
610 (short for
611 .BR --quilt=dpm )
612 is for use with git-dpm.
613 Your HEAD is expected to be
614 a patches-applied git branch,
615 except that it might contain changes to upstream .gitignore files.
617 .B --quilt=unapplied
618 specifies that your HEAD is a patches-unapplied git branch (and
619 that any changes to upstream .gitignore files are represented as
620 patches in debian/patches).
622 With --quilt=gbp|dpm|unapplied,
623 dgit push (or precursors like quilt-fixup and build) will automatically
624 generate a conversion of your git branch into the right form.
625 dgit push will push the
626 dgit-compatible form (the
627 .BR "dgit view" )
628 to the dgit git server.
629 The dgit view will be visible to you
630 in the dgit remote tracking branches, but your own branch will
631 not be modified.
632 dgit push will create a tag
633 .BI debian/ version
634 for the maintainer view, and the dgit tag
635 .BI archive/debian/ version
636 for the dgit view.
637 dgit quilt-fixup will merely do some checks,
638 and cache the maintainer view.
640 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
641 This is because it is not always possible to tell: a patches-unapplied
642 git branch of a package with one patch, for example, looks very like
643 a patches-applied branch where the user has used git revert to
644 undo the patch, expecting to actually revert it.
645 However, if you fail to specify the right \-\-quilt option,
646 and you aren't too lucky, dgit will notice the problem and stop,
647 with a useful hint. 
648 .TP
649 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
650 Specifies that the suite to be operated on is part of distro
651 .IR distro .
652 This overrides the default value found from the git config option
653 .BR dgit-suite. \fIsuite\fR .distro .
654 The only effect is that other configuration variables (used
655 for accessing the archive and dgit-repos) used are
656 .BR dgit-distro. \fIdistro\fR .* .
658 If your suite is part of a distro that dgit already knows about, you
659 can use this option to make dgit work even if your dgit doesn't know
660 about the suite.  For example, specifying
661 .B -ddebian
662 will work when the suite is an unknown suite in the Debian archive.
664 To define a new distro it is necessary to define methods and URLs
665 for fetching (and, for dgit push, altering) a variety of information both
666 in the archive and in dgit-repos.
667 How to set this up is not yet documented.
668 .TP
669 .BI -C changesfile
670 Specifies the .changes file which is to be uploaded.  By default
671 dgit push looks for single .changes file in the parent directory whose
672 filename suggests it is for the right package and version.
674 If the specified
675 .I changesfile
676 pathname contains slashes, the directory part is also used as
677 the value for
678 .BR --build-products-dir ;
679 otherwise, the changes file is expected in that directory (by
680 default, in
681 .BR .. ).
682 .TP
683 .B --rm-old-changes
684 When doing a build, delete any changes files matching
685 .IB package _ version _*.changes
686 before starting.  This ensures that
687 dgit push (and dgit sbuild) will be able to unambigously
688 identify the relevant changes files from the most recent build, even
689 if there have been previous builds with different tools or options.
690 The default is not to remove, but
691 .B \-\-no-rm-old-changes
692 can be used to override a previous \-\-rm-old-changes
693 or the .rm-old-changes configuration setting.
694 .TP
695 .BI --build-products-dir= directory
696 Specifies where to find the built files to be uploaded.
697 By default, dgit looks in the parent directory
698 .RB ( .. ).
699 .TP
700 .BI --no-rm-on-error
701 Do not delete the destination directory if clone fails.
702 .TP
703 .BI --dep14tag
704 Generates a DEP-14 tag (eg
705 .BR debian/ \fIversion\fR)
706 as well as a dgit tag (eg
707 .BR archive/debian/ \fIversion\fR)
708 where possible.  This is the default.
709 .TP
710 .BI --no-dep14tag
711 Do not generate a DEP-14 tag, except in split quilt view mode.
712 (On servers where only the old tag format is supported,
713 the dgit tag will have the DEP-14 name.
714 This option does not prevent that.)
715 .TP
716 .BI --dep14tag-always
717 Insist on generating a DEP-14 tag
718 as well as a dgit tag.
719 If the server does not support that, dgit push will fail.
720 .TP
721 .BI -D
722 Prints debugging information to stderr.  Repeating the option produces
723 more output (currently, up to -DDDD is meaningfully different).
724 .TP
725 .BI -c name = value
726 Specifies a git configuration option, to be used for this run.
727 dgit itself is also controlled by git configuration options.
728 .TP
729 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
730 Specifies the
731 .BI -v version
732 option to pass to dpkg-genchanges, during builds.  Changes (from
733 debian/changelog) since this version will be included in the built
734 changes file, and hence in the upload.  If this option is not
735 specified, dgit will query the archive and use the latest version
736 uploaded to the intended suite.
738 Specifying
739 .B _
740 inhibits this, so that no -v option will be passed to dpkg-genchanges
741 (and as a result, only the last stanza from debian/changelog will
742 be used for the build and upload).
743 .TP
744 .RI \fB-m\fR maintaineraddress
745 Passed to dpkg-genchanges (eventually).
746 .TP
747 .RI \fB--ch:\fR option
748 Specifies a single additional option to pass, eventually, to
749 dpkg-genchanges.
751 Options which are safe to pass include
752 .BR -C
753 (and also
754 .BR "-si -sa -sd"
755 although these should never be necessary with Debian since dgit
756 automatically calculates whether .origs need to be uploaded.)
758 For other options the caveat below applies.
759 .TP
760 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
761 Specifies a single additional option to pass to
762 .BR curl ,
763 .BR dput ,
764 .BR debsign ,
765 .BR dpkg-source ,
766 .BR dpkg-buildpackage ,
767 .BR dpkg-genchanges ,
768 .BR sbuild ,
769 .BR ssh ,
770 .BR dgit ,
771 .BR apt-get ,
772 .BR apt-cache ,
773 .BR gbp-pq ,
774 .BR gbp-build ,
775 or
776 .BR mergechanges .
777 Can be repeated as necessary.
779 Use of this ability should not normally be necessary.
780 It is provided for working around bugs,
781 or other unusual situations.
782 If you use these options,
783 you may violate dgit's assumptions
784 about the behaviour of its subprograms
785 and cause lossage.
787 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
788 the option applies only when the program is invoked directly by dgit.
789 Usually, for passing options to dpkg-genchanges, you should use
790 .BR --ch: \fIoption\fR.
792 Specifying --git is not effective for some lower-level read-only git
793 operations performed by dgit, and also not when git is invoked by
794 another program run by dgit.
796 See notes below regarding ssh and dgit.
798 NB that --gpg:option is not supported (because debsign does not
799 have that facility).
800 But see
801 .B -k
802 and the
803 .B keyid
804 distro config setting.
805 .TP
806 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
807 Specifies alternative programs to use instead of
808 .BR curl ,
809 .BR dput ,
810 .BR debsign ,
811 .BR dpkg-source ,
812 .BR dpkg-buildpackage ,
813 .BR dpkg-genchanges ,
814 .BR sbuild ,
815 .BR gpg ,
816 .BR ssh ,
817 .BR dgit ,
818 .BR apt-get ,
819 .BR apt-cache ,
820 .BR git ,
821 .BR gbp-pq ,
822 .BR gbp-build ,
823 or
824 .BR mergechanges .
826 For
827 .BR dpkg-buildpackage ,
828 .BR dpkg-genchanges ,
829 .B mergechanges
830 and
831 .BR sbuild ,
832 this applies only when the program is invoked directly by dgit.
834 For
835 .BR dgit ,
836 specifies the command to run on the remote host when dgit
837 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
838 itself as the EDITOR for dpkg-source --commit; this is done using
839 argv[0], and is not affected by --dgit=).
841 .BR gbp-build 's
842 value
843 is used instead of gbp build or git-buildpackage.  (The default is
844 the latter unless the former exists on PATH.)
845 .BR gbp-pq 's
846 value
847 is used instead of gbp pq.
848 In both cases,
849 unusually, the specified value is split on whitespace
850 to produce a command and possibly some options and/or arguments.
852 For
853 .BR ssh ,
854 the default value is taken from the
856 or
857 .B GIT_SSH
858 environment variables, if set (see below).  And, for ssh, when accessing the
859 archive and dgit-repos, this command line setting is overridden by the
860 git config variables
861 .BI dgit-distro. distro .ssh
862 and
863 .B .dgit.default.ssh
864 (which can in turn be overridden with -c).  Also, when dgit is using
865 git to access dgit-repos, only git's idea of what ssh to use (eg,
866 .BR GIT_SSH )
867 is relevant.
868 .TP
869 .BI --existing-package= package
870 dgit push needs to canonicalise the suite name.  Sometimes, dgit
871 lacks a way to ask the archive to do this without knowing the
872 name of an existing package.  Without --new we can just use the
873 package we are trying to push.  But with --new that will not work, so
874 we guess
875 .B dpkg
876 or use the value of this option.  This option is not needed with the
877 default mechanisms for accessing the archive.
878 .TP
879 .BR -h | --help
880 Print a usage summary.
881 .TP
882 .BI --initiator-tempdir= directory
883 dgit rpush uses a temporary directory on the invoking (signing) host.
884 This option causes dgit to use
885 .I directory
886 instead.  Furthermore, the specified directory will be emptied,
887 removed and recreated before dgit starts, rather than removed
888 after dgit finishes.  The directory specified must be an absolute
889 pathname.
890 .TP
891 .BI --force- something
892 Instructs dgit to try to proceed despite detecting
893 what it thinks is going to be a fatal problem.
894 .B This is probably not going to work.
895 These options are provided as an escape hatch,
896 in case dgit is confused.
897 (They might also be useful for testing error cases.)
898 .TP
899 .B --import-dsc-with-dgit-field
900 Tell dgit import-dsc to treat a .dsc with a Dgit field
901 like one without it.
902 The result is a fresh import,
903 discarding the git history
904 that the person who pushed that .dsc was working with.
905 .TP
906 .B --force-unrepresentable
907 Carry on even if
908 dgit thinks that your git tree contains changes
909 (relative to your .orig tarballs)
910 which dpkg-source is not able to represent.
911 Your build or push will probably fail later.
912 .TP
913 .B --force-changes-origs-exactly
914 Use the set of .origs specified in your .changes, exactly,
915 without regard to what is in the archive already.
916 The archive may well reject your upload.
917 .TP
918 .B --force-unsupported-source-format
919 Carry on despite dgit not understanding your source package format.
920 dgit will probably mishandle it.
921 .TP
922 .B --force-dsc-changes-mismatch
923 Do not check whether .dsc and .changes match.
924 The archive will probably reject your upload.
925 .TP
926 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
927 Force on or off the use of the absurd git-apply emulation
928 when running gbp pq import
929 when importing a package from a .dsc.
930 See Debian bug #841867.
932 dgit can be configured via the git config system.
933 You may set keys with git-config (either in system-global or per-tree
934 configuration), or provide
935 .BI -c key = value
936 on the dgit command line.
937 .LP
938 Settings likely to be useful for an end user include:
939 .TP
940 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
941 Specifies the distro for a suite.  dgit keys off the suite name (which
942 appears in changelogs etc.), and uses that to determine the distro
943 which is involved.  The config used is thereafter that for the distro.
945 .I suite
946 may be a glob pattern.
947 .TP
948 .BI dgit.default.distro " distro"
949 The default distro for an unknown suite.
950 .TP
951 .BI dgit.default.default-suite " suite"
952 The default suite (eg for clone).
953 .TP
954 .BR dgit.default. *
955 for each
956 .BR dgit-distro. \fIdistro\fR . *,
957 the default value used if there is no distro-specific setting.
958 .TP
959 .BR dgit-distro. \fIdistro\fR .clean-mode
960 One of the values for the command line --clean= option; used if
961 --clean is not specified.
962 .TP
963 .BR dgit-distro. \fIdistro\fR .quilt-mode
964 One of the values for the command line --quilt= option; used if
965 --quilt is not specified.
966 .TP
967 .BR dgit-distro. \fIdistro\fR .rm-old-changes
968 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
969 is specified.  The default is not to remove.
970 .TP
971 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
972 Whether you have push access to the distro.
973 For Debian, it is OK to use auto, which uses readonly mode if you are
974 not pushing right now;
975 but, setting this to false will avoid relying on the mirror of the dgit
976 git repository server.
977 .TP
978 .BI dgit-distro. distro .keyid
979 See also
980 .BR -k .
981 .TP
982 .BI dgit-distro. distro .mirror " url"
983 .TP
984 .BI dgit-distro. distro .username
985 Not relevant for Debian.
986 .TP
987 .BI dgit-distro. distro .upload-host
988 Might be useful if you have an intermediate queue server.
989 .TP
990 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
991 Values to configure for and in new git trees.  If
992 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
993 used, respectively.  Only used if .setup-usermail is not disabled.
994 .TP
995 .BI dgit-distro. distro .setup-useremail
996 Whether to set and in new git trees.
997 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
998 .TP
999 .BI dgit-distro. distro .setup-mergechangelogs
1000 Whether to setup a merge driver which uses dpkg-mergechangelogs for
1001 debian/changelog.  True by default.  Ignored for dgit
1002 setup-mergechangelogs, which does it anyway.
1003 .TP
1004 .BI dgit-distro. distro .cmd- cmd
1005 Program to use instead of
1006 .IR cmd .
1007 Works like
1008 .BR -- \fIcmd\fR = "... ."
1009 .TP
1010 .BI dgit-distro. distro .opts- cmd
1011 Extra options to pass to
1012 .IR cmd .
1013 Works like
1014 .BR -- \fIcmd\fR : "... ."
1015 To pass several options, configure multiple values in git config
1016 (with git config --add).  The options for
1017 .BI dgit.default.opts- cmd
1018 .BI dgit-distro. distro /push.opts- cmd
1019 and are all used, followed by options from dgit's command line.
1021 There are many other settings which specify how a particular distro's
1022 services (archive and git) are provided.  These should not normally be
1023 adjusted, but are documented for the benefit of distros who wish to
1024 adopt dgit.
1025 .TP
1026 .BI dgit-distro. distro .nominal-distro
1027 Shown in git tags, Dgit fields, and so on.
1028 .TP
1029 .BI dgit-distro. distro .alias-canon
1030 Used for all access configuration lookup.
1031 .TP
1032 .BR dgit-distro. \fIdistro\fR /push. *
1033 If set, overrides corresponding non \fB/push\fR config when
1034 .BR readonly=false ,
1035 or when pushing and
1036 .BR readonly=auto .
1037 .TP
1038 .BI dgit-distro. distro .git-url
1039 .TP
1040 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1041 .TP
1042 .BI dgit-distro. distro .git-proto
1043 .TP
1044 .BI dgit-distro. distro .git-path
1045 .TP
1046 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1047 .TP
1048 .BI dgit-distro. distro .git-check-suffix
1049 .TP
1050 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1051 .TP
1052 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1053 .TP
1054 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
1055 .TP
1056 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1057 .TP
1058 .BI dgit-distro. distro .madison-distro
1059 .TP
1060 .BI dgit-distro. distro .archive-query-default-component
1061 .TP
1062 .BI dgit-distro. distro .dgit-tag-format
1063 .TP
1064 .BR dgit-distro. \fIdistro\fR .dep14tag " " want | no | always
1065 .TP
1066 .BI dgit-distro. distro .ssh
1067 .TP
1068 .BI dgit-distro. distro .sshpsql-dbname
1069 .TP
1070 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1071 .TP
1072 .BI dgit-distro. distro .backports-quirk
1073 .TP
1074 .BI dgit-distro. distro .rewrite-map-enable
1075 .TP
1076 .BI dgit.default.old-dsc-distro
1077 .TP
1078 .BI dgit.dsc-url-proto-ok. protocol
1079 .TP
1080 .BI dgit.dsc-url-proto-ok.bad-syntax
1081 .TP
1082 .BI dgit.default.dsc-url-proto-ok
1084 .TP
1085 .BR DGIT_SSH ", " GIT_SSH
1086 specify an alternative default program (and perhaps arguments) to use
1087 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
1088 if it contains any whitespace will be passed to the shell.  GIT_SSH
1089 specifies just the program; no arguments can be specified, so dgit
1090 interprets it the same way as git does.
1091 See
1092 also the --ssh= and --ssh: options.
1093 .TP
1095 Default git and for new trees.  See
1096 .BR "dgit setup-new-tree" .
1097 .TP
1098 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1099 and other subprograms and modules used by dgit are affected by various
1100 environment variables.  Consult the documentaton for those programs
1101 for details.
1102 .SH BUGS
1103 There should be
1104 a `dgit rebase-prep' command or some such to turn a
1105 fast-forwarding branch containing pseudo-merges
1106 back into a rebasing patch stack.
1107 It might have to leave a note
1108 for a future dgit push.
1110 If the dgit push fails halfway through,
1111 it is not necessarily restartable and
1112 idempotent.
1113 It would be good to check that the proposed signing key is
1114 available before starting work.
1116 dgit's build functions, and dgit push, may make changes to
1117 your current HEAD.  Sadly this is necessary for packages in the `3.0
1118 (quilt)' source format.  This is ultimately due to what I consider
1119 design problems in quilt and dpkg-source.
1121 --dry-run does not always work properly, as not doing some of the git
1122 fetches may result in subsequent actions being different.  Doing a
1123 non-dry-run dgit fetch first will help.
1124 --damp-run is likely to work much better.
1126 \fBdgit\fP(7),
1127 \fBdgit-*\fP(7),
1128 \fBcurl\fP(1),
1129 \fBdput\fP(1),
1130 \fBdebsign\fP(1),
1131 \fBgit-config\fP(1),
1132 \fBgit-buildpackage\fP(1),
1133 \fBdpkg-buildpackage\fP(1),
1134 .br