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