chiark / gitweb /
Fix a formatting problem in --build-products-dir= doc.
[dgit.git] / dgit.1
1 .TH dgit 1 "" "Debian Project" "dgit"
3 dgit \- git integration with the Debian archive
4 .
6 .B dgit
7 [\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
8 \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
9 .br
10 .B dgit
11 [\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]
12 [\fIsuite\fP]
13 .br
14 .B dgit
15 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP
16 [\fIbuild\-opts\fp]
17 .br
18 .B dgit
19 [\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]
20 [\fIsuite\fP]
21 .br
22 .B dgit
23 [\fIdgit\-opts\fP] \fBrpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR
24 [\fIpush args...\fR]
25 .br
26 .B dgit
27 [\fIdgit\-opts\fP] \fIaction\fR ...
29 .B dgit
30 allows you to treat the Debian archive as if it were a git
31 repository.  See \fBdgit\fP(7) for detailed information about the data
32 model, common problems likely to arise with certain kinds of package,
33 etc.
35 The usual workflow is:
36 .br
37 1.      \fBdgit clone\fR or \fBfetch\fR;
38 .br
39 2.      make, do dev tests, and commit changes in git as desired;
40 .br
41 3.      build packages for upload, using e.g. \fBdgit sbuild\fR
42 .br
43 4.      do pre-upload tests of the proposed upload;
44 .br
45 5.      \fBdgit push\fR.
47 .TP
48 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
49 Consults the archive and dgit-repos to construct the git view of
50 history for
51 .I package
52 in
53 .I suite
54 .RB ( sid
55 by default)
56 in a new directory (named
57 .BI ./ package
58 by default);
59 also, downloads any necessary orig tarballs.
61 The suite's git tip is
62 left on the local branch
63 .BI dgit/ suite
64 ready for work, and on the corresponding dgit remote tracking branch.
65 The
66 .B origin
67 remote will be set up to point to the package's dgit-repos tree
68 for the distro to which
69 .I suite
70 belongs.
72 For your convenience, the
73 .B vcs-git
74 remote will be set up from the package's Vcs-Git field, if there is
75 one - but note that in the general case the history found there may be
76 different to or even disjoint from dgit's view.
77 .TP
78 \fBdgit fetch\fR [\fIsuite\fP]
79 Consults the archive and git-repos to update the git view of
80 history for a specific suite (and downloads any necessary orig
81 tarballs), and updates the remote tracking branch
82 .BR remotes/dgit/dgit/ \fIsuite\fR.
83 If the current branch is
84 .BI dgit/ suite
85 then dgit fetch defaults to
86 .IR suite ;
87 otherwise it parses debian/changelog and uses the suite specified
88 there.
89 .TP
90 \fBdgit pull\fR [\fIsuite\fP]
91 Does dgit fetch, and then merges the new head of the remote tracking
92 branch
93 .BI remotes/dgit/dgit/ suite
94 into the current branch.
95 .TP
96 \fBdgit build\fR ...
97 Runs
98 .B dpkg-buildpackage
99 with some suitable options.  Options and arguments after build
100 will be passed on to dpkg-buildpackage.  It is not necessary to use
101 dgit build when using dgit; it is OK to use any approach which ensures
102 that the generated source package corresponds to the relevant git
103 commit.
105 Tagging, signing and actually uploading should be left to dgit push.
106 .TP
107 \fBdgit build-source\fR ...
108 Builds the source package, and a changes file for a prospective
109 source-only upload, using
110 .BR dpkg-source .
111 The output is left in
112 .IR package \fB_\fR version \fB.dsc\fR
113 and
114 .IR package \fB_\fR version \fB_source.changes\fR.
116 Tagging, signing and actually uploading should be left to dgit push.
117 .TP
118 .B dgit clean
119 Cleans the current working tree (according to the --clean= option in
120 force).
121 .TP
122 .B dgit help
123 Print a usage summary.
124 .TP
125 \fBdgit sbuild\fR ...
126 Constructs the source package, uses
127 .B  sbuild
128 to do a binary build, and uses mergechanges to merge the source and
129 binary changes files.  Options and argumments after sbuild will be
130 passed on to sbuild.  Changes files matching
131 .IB package _ version _*.changes
132 in the parent directory will be removed; the output is left in
133 .IR package \fB_\fR version \fB_multi.changes\fR.
135 Tagging, signing and actually uploading should be left to dgit push.
136 .TP
137 \fBdgit git-build\fR ...
138 Runs
139 .B git-buildpackage
140 with some suitable options.  Options and argumments after git-build
141 will be passed on to git-buildpackage.
143 Tagging, signing and actually uploading should be left to dgit push.
144 .TP
145 \fBdgit push\fR [\fIsuite\fP]
146 Does an `upload', pushing the current HEAD to the archive (as a source
147 package) and to dgit-repos (as git commits).  The package must already
148 have been built ready for upload, with the .dsc and .changes
149 left in the parent directory.  It is normally best to do the build
150 with dgit too (eg with dgit sbuild): some existing build tools pass
151 unhelpful options to dpkg-source et al by default, which can result in
152 the built source package not being identical to the git tree.
154 In more detail: dgit push checks that the current HEAD corresponds to
155 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
156 makes a signed git tag, edits the .dsc to contain the dgit metadata
157 field, runs debsign to sign the upload (.dsc and .changes), pushes the
158 signed tag, and finally uses dput to upload the .changes to the
159 archive.
161 dgit push always uses the package, suite and version specified in the
162 debian/changelog and the .dsc, which must agree.  If the command line
163 specifies a suite then that must match too.
165 If dgit push fails while uploading, it is fine to simply retry the
166 dput on the .changes file at your leisure.
167 .TP
168 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
169 Pushes the contents of the specified directory on a remote machine.
170 This is like running dgit push on build-host with build-dir as the
171 current directory; however, signing operations are done on the
172 invoking host.  This allows you to do a push when the system which has
173 the source code and the build outputs has no access to the key:
175 1.      Clone on build host (dgit clone)
176 .br
177 2.      Edit code on build host (edit, git commit)
178 .br
179 3.      Build package on build host (dgit build)
180 .br
181 4.      Test package on build host or elsewhere (dpkg -i, test)
182 .br
183 5.      Upload by invoking dgit rpush on host with your GPG key.
185 However, the build-host must be able to ssh to the dgit repos.  If
186 this is not already the case, you must organise it separately, for
187 example by the use of ssh agent forwarding.
189 The remaining arguments are treated just as dgit push would handle
190 them.
192 build-host and build\-dir can be passed as separate
193 arguments; this is assumed to be the case if the first argument
194 contains no : (except perhaps one in [ ], to support IPv6 address
195 literals).
197 You will need similar enough versions of dgit on the build-host and
198 the invocation host.  The build-host needs gnupg installed, with your
199 public key in its keyring (but not your private key, obviously).
200 .TP
201 .B dgit setup-mergechangelogs
202 Configures a git merge helper for the file
203 .B debian/changelog
204 which uses
205 .BR dpkg-mergechangelogs .
206 You can use this in any git repository, not just ones used with
207 the other dgit operations.
208 .TP
209 .B dgit quilt-fixup
210 `3.0 (quilt)' format source packages need changes representing not
211 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
212 checks whether this has been done; if not, dgit will make appropriate
213 patches in debian/patches and also commit the resulting changes to
214 git.
216 This is normally done automatically by dgit build and dgit push.
218 dgit will try to turn each relevant commit in your git history into a
219 new quilt patch.  dgit cannot convert nontrivial merges, or certain
220 other kinds of more exotic history.  If dgit can't find a suitable
221 linearisation of your history, by default it will fail, but you can
222 ask it to generate a single squashed patch instead.
223 .TP
224 .B dgit version
225 Prints version information and exits.
226 .TP
227 .BI "dgit clone-dgit-repos-server" " destdir"
228 Tries to fetch a copy of the source code for the dgit-repos-server,
229 as actually being used on the dgit git server, as a git tree.
231 .TP
232 .BR --dry-run " | " -n
233 Go through the motions, fetching all information needed, but do not
234 actually update the output(s).  For push, dgit does
235 the required checks and leaves the new .dsc in a temporary file,
236 but does not sign, tag, push or upload.
237 .TP
238 .BR --damp-run " | " -L
239 Go through many more of the motions: do everything that doesn't
240 involve either signing things, or making changes on the public
241 servers.
242 .TP
243 .BI -k keyid
244 Use
245 .I keyid
246 for signing the tag and the upload.
247 .TP
248 .BR --no-sign
249 does not sign tags or uploads (meaningful only with push).
250 .TP
251 .TP
252 .BI -p package
253 Specifies that we should process source package
254 .I package
255 rather than looking in debian/control or debian/changelog.
256 Valid with dgit fetch and dgit pull, only.
257 .TP
258 .BR --clean=git " | " -wg
259 The source tree should be cleaned, before building a source package
260 with one of the build options, using
261 .BR "git clean -xdf" .
262 This will delete all files which are not tracked by git.  Also, -wg
263 causes dgit to pass
264 .B -nc
265 to dpkg-buildpackage, which prevents the package's own clean target
266 from being run.
268 --clean=git is useful when the package's clean target is troublesome;
269 the downside is simply that git clean may delete files you forgot to
270 git add.  --clean=git can also avoid needing the build-dependencies.
271 .TP
272 .BR --clean=git-ff " | " -wgf
273 The source tree should be cleaned, before building a source package
274 with one of the build options, using
275 .BR "git clean -xdff" .
276 This is like
277 "git clean -xdf"
278 but it also removes any subdirectories containing different git
279 trees (which only unusual packages are likely to create).
280 .TP
281 .BR --clean=check " | " -wc
282 Merely check that the tree is clean (does not contain uncommitted
283 files), before building a source package.
284 .TP
285 .BR --clean=none " | " -wn
286 Do not clean the tree before building a source package.  If there are
287 files which are not in git, or if the build creates such files, a
288 subsequent dgit push will fail.
289 .TP
290 .BR --clean=dpkg-source " | " -wd
291 Use dpkg-buildpackage to do the clean, so that the source package
292 is cleaned by dpkg-source running the package's clean target.
293 This is the default.  It requires the package's build dependencies.
294 .TP
295 .BR --clean=dpkg-source-d " | " -wdd
296 Use
297 .B dpkg-buildpackage -d
298 to do the clean, so that the source package
299 is cleaned by dpkg-source running the package's clean target.
300 The build-dependencies are not checked (due to
301 .BR -d ),
302 which violates policy, but may work in practice.
303 .TP
304 .BR -N " | " --new
305 The package may be new in this suite.  Without this, dgit will
306 refuse to push.
307 .TP
308 .BR --ignore-dirty
309 Do not complain if the working tree does not match your git HEAD.
310 This can be useful with build, if you plan to commit later.  (dgit
311 push will still ensure that the .dsc you upload and the git tree
312 you push are identical, so this option won't make broken pushes.)
313 .TP
314 .BI --deliberately- something
315 Declare that you are deliberately doing
316 .IR something .
317 This can be used to override safety catches, including safety catches
318 which relate to distro-specific policies.  The meanings of
319 .IR something s
320 understood in the context of Debian are discussed below:
321 .TP
322 .BR --deliberately-not-fast-forward
323 Declare that you are deliberately rewinding history.  When pushing to
324 Debian, use this when you are making a renewed upload of an entirely
325 new source package whose previous version was not accepted for release
326 from NEW because of problems with copyright or redistributibility.
327 .TP
328 .BR --deliberately-include-questionable-history
329 Declare that you are deliberately including, in the git history of
330 your current push, history which contains a previously-submitted
331 version of this package which was not approved (or has not yet been
332 approved) by the ftpmasters.  When pushing to Debian, only use this
333 option after verifying that: none of the rejected-from-NEW (or
334 never-accepted) versions in the git history of your current push, were
335 rejected by ftpmaster for copyright or redistributability reasons.
336 .TP
337 .BR --deliberately-fresh-repo
338 Declare that you are deliberately rewinding history and want to
339 throw away the existing repo.  Not relevant when pushing to Debian,
340 as the Debian server will do this automatically when necessary.
341 .TP
342 .BR --quilt=linear
343 When fixing up source format `3.0 (quilt)' metadata, insist on
344 generating a linear patch stack.  If such a stack cannot be generated,
345 fail.  This is the default for Debian.
346 .TP
347 .BR --quilt=auto
348 When fixing up source format `3.0 (quilt)' metadata, prefer to
349 generate a linear patch stack, but if that doesn't seem possible,
350 generate a single squashed patch for all the changes made in git.
351 This is not a good idea for an NMU in Debian.
352 .TP
353 .BR --quilt=smash
354 When fixing up source format `3.0 (quilt)' metadata,
355 generate a single squashed patch for all the changes made in git.
356 This is not a good idea for an NMU in Debian.
357 .TP
358 .BR --quilt=nofix
359 Check whether source format `3.0 (quilt)' metadata would need fixing
360 up, but, if it does, fail.  You must then fix the metadata yourself
361 somehow before pushing.  (NB that dpkg-source --commit will not work
362 because the dgit git tree does not have a
363 .B .pc
364 directory.)
365 .TP
366 .BR --quilt=nocheck " | " --no-quilt-fixup
367 Do not check whether up source format `3.0 (quilt)' metadata needs
368 fixing up.  If you use this option and the metadata did in fact need
369 fixing up, dgit push will fail.
370 .TP
371 .BI -D
372 Prints debugging information to stderr.  Repeating the option produces
373 more output (currently, up to -DDD is meaningfully different).
374 .TP
375 .BI -c name = value
376 Specifies a git configuration option, to be used for this run.
377 dgit itself is also controlled by git configuration options.
378 .TP
379 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
380 Specifies the
381 .BI -v version
382 option to pass to dpkg-genchanges, during builds.  Changes (from
383 debian/changelog) since this version will be included in the built
384 changes file, and hence in the upload.  If this option is not
385 specified, dgit will query the archive and use the latest version
386 uploaded to the intended suite.
388 Specifying
389 .B _
390 inhibits this, so that no -v option will be passed to dpkg-genchanges
391 (and as a result, only the last stanza from debian/changelog will
392 be used for the build and upload).
393 .TP
394 .RI \fB-m\fR maintaineraddress
395 Passed to dpkg-genchanges (eventually).
396 .TP
397 .RI \fB--ch:\fR option
398 Specifies a single additional option to pass, eventually, to
399 dpkg-genchanges.
400 .TP
401 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
402 Specifies alternative programs to use instead of
403 .BR curl ,
404 .BR dput ,
405 .BR debsign ,
406 .BR dpkg-source ,
407 .BR dpkg-buildpackage ,
408 .BR dpkg-genchanges ,
409 .BR sbuild ,
410 .BR gpg ,
411 .BR ssh ,
412 .BR dgit ,
413 or
414 .BR mergechanges .
416 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
417 this applies only when the program is invoked directly by dgit.
419 For dgit, specifies the command to run on the remote host when dgit
420 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
421 itself as the EDITOR for dpkg-source --commit; this is done using
422 argv[0], and is not affected by --dgit=).
424 For ssh, the default value is taken from the
426 or
427 .B GIT_SSH
428 environment variables, if set (see below).  And, for ssh, when accessing the
429 archive and dgit-repos, this command line setting is overridden by the
430 git config variables
431 .BI dgit-distro. distro .ssh
432 and
433 .B .dgit.default.ssh
434 (which can in turn be overridden with -c).  Also, when dgit is using
435 git to access dgit-repos, only git's idea of what ssh to use (eg,
436 .BR GIT_SSH )
437 is relevant.
438 .TP
439 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
440 Specifies a single additional option to pass to
441 .BR curl ,
442 .BR dput ,
443 .BR debsign ,
444 .BR dpkg-source ,
445 .BR dpkg-buildpackage ,
446 .BR dpkg-genchanges ,
447 .BR sbuild ,
448 .BR ssh ,
449 .BR dgit ,
450 or
451 .BR mergechanges .
452 Can be repeated as necessary.
454 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
455 this applies only when the program is invoked directly by dgit.
456 Usually, for passing options to dpkg-genchanges, you should use
457 .BR --ch: \fIoption\fR.
459 See notes above regarding ssh and dgit.
461 NB that --gpg:option is not supported (because debsign does not
462 have that facility).  But see -k.
463 .TP
464 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
465 Specifies that the suite to be operated on is part of distro
466 .IR distro .
467 This overrides the default value found from the git config option
468 .BR dgit-suite. \fIsuite\fR .distro .
469 The only effect is that other configuration variables (used
470 for accessing the archive and dgit-repos) used are
471 .BR dgit-distro. \fIdistro\fR .* .
473 If your suite is part of a distro that dgit already knows about, you
474 can use this option to make dgit work even if your dgit doesn't know
475 about the suite.  For example, specifying
476 .B -ddebian
477 will work when the suite is an unknown suite in the Debian archive.
479 To define a new distro it is necessary to define methods and URLs
480 for fetching (and, for dgit push, altering) a variety of information both
481 in the archive and in dgit-repos.
482 How to set this up is not yet documented.
483 .TP
484 .BI -C changesfile
485 Specifies the .changes file which is to be uploaded.  By default
486 dgit push looks for single .changes file in the parent directory whose
487 filename suggests it is for the right package and version - or,
488 if there is a _multi.changes file, dgit uses that.
490 If the specified
491 .I changesfile
492 pathname contains slashes, the directory part is also used as
493 the value for
494 .BR --build-products-dir ;
495 otherwise, the changes file is expected in that directory (by
496 default, in
497 .BR .. ).
498 .TP
499 .BI --build-products-dir= directory
500 Specifies where to find the built files to be uploaded.
501 By default, dgit looks in the parent directory
502 .RB ( .. ).
503 .TP
504 .BI --existing-package= package
505 dgit push needs to canonicalise the suite name.  Sometimes, dgit
506 lacks a way to ask the archive to do this without knowing the
507 name of an existing package.  Without --new we can just use the
508 package we are trying to push.  But with --new that will not work, so
509 we guess
510 .B dpkg
511 or use the value of this option.  This option is not needed with the
512 default mechanisms for accessing the archive.
513 .TP
514 .BR -h | --help
515 Print a usage summary.
516 .TP
517 .BI --initiator-tempdir= directory
518 dgit rpush uses a temporary directory on the invoking (signing) host.
519 This option causes dgit to use
520 .I directory
521 instead.  Furthermore, the specified directory will be emptied,
522 removed and recreated before dgit starts, rather than removed
523 after dgit finishes.  The directory specified must be an absolute
524 pathname.
525 .TP
526 .BI --no-rm-on-error
527 Do not delete the destination directory if clone fails.
529 It is always possible with dgit to clone or fetch a package, make
530 changes in git (using git-commit) on the suite branch
531 .RB ( "git checkout dgit/" \fIsuite\fR)
532 and then dgit push.  You can use whatever gitish techniques you like
533 to construct the commit to push; the only requirement is that it is a
534 descendant of the state of the archive, as provided by dgit in the
535 remote tracking branch
536 .BR remotes/dgit/dgit/ \fIsuite\fR.
538 If you are using dgit to do an NMU, and don't know about the
539 maintainers' preferred packaging workflows, you should make your
540 changes as a linear series of (logicially separated) commits on top of
541 what's already in the archive.
543 If you are lucky the other uploaders have also used dgit and
544 integrated the other relevant git history; if not you can fetch it
545 into your tree and cherry-pick etc. as you wish.
547 If you are the maintainer of a package dealing with uploads made
548 without dgit, you will probably want to merge the synthetic commits
549 (made by dgit to represent the uploads) into your git history.
550 Normally you can just merge the dgit branch into your own master, or
551 indeed if you do your work on the dgit local suite branch
552 .BI dgit/ suite
553 you can just use dgit pull.
555 However the first time dgit is used it will generate a new origin
556 commit from the archive which won't be linked into the rest of your
557 git history.  You will need to merge this.
559 If last upload was in fact made with git, you should usually proceed
560 as follows: identify the commit which was actually used to build the
561 package.  (Hopefully you have a tag for this.)  Check out the dgit
562 branch
563 .RB ( "git checkout dgit/" \fIsuite\fR)
564 and merge that other commit
565 .RB ( "git merge debian/" \fIversion\fR).
566 Hopefully this merge will be trivial because the two trees should
567 be the same.  The resulting branch head can be merged into your
568 working branches
569 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
571 If last upload was not made with git, a different approach is required
572 to start using dgit.  First, do
573 .B dgit fetch
574 (or clone) to obtain a git history representation of what's in the
575 archive and record it in the
576 .BI remotes/dgit/dgit/ suite
577 tracking branch.  Then somehow, using your other git history
578 plus appropriate diffs and cherry picks from the dgit remote tracking
579 branch, construct a git commit whose tree corresponds to the tree to use for the
580 next upload.  If that commit-to-be-uploaded is not a descendant of the
581 dig remote tracking branch, check it out and say
582 .BR "git merge -s ours remotes/dgit/dgit/" \fIsuite\fR;
583 that tells git that we are deliberately throwing away any differences
584 between what's in the archive and what you intend to upload.
585 Then run
586 .BR "dgit push"
587 to actually upload the result.
589 dgit can be configured via the git config system.
590 You may set keys with git-config (either in system-global or per-tree
591 configuration), or provide
592 .BI -c key = value
593 on the dgit command line.
594 .LP
595 Settings likely to be useful for an end user include:
596 .TP
597 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
598 Specifies the distro for a suite.  dgit keys off the suite name (which
599 appears in changelogs etc.), and uses that to determine the distro
600 which is involved.  The config used is thereafter that for the distro.
601 it then looks
602 .TP
603 .BI dgit.default.distro " distro"
604 The default distro for an unknown suite.
605 .TP
606 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
607 Whether you have push access to the distro.
608 For Debian, it is OK to use auto, which uses readonly mode if you are
609 not pushing right now,
610 but setting this to false will avoid relying on the mirror of the dgit
611 git repository server.
612 .TP
613 .BI dgit-distro. distro .keyid
614 .TP
615 .BI dgit-distro. distro .mirror " url"
616 .TP
617 .BI dgit-distro. distro .username
618 Not relevant for Debian.
619 .TP
620 .BI dgit-distro. distro .upload-host
621 Might be useful if you have an intermediate queue server.
623 There are many other settings which specify how a particular distro's
624 services (archive and git) are provided.  These should not normally be
625 adjusted, but are documented for the benefit of distros who wish to
626 adopt dgit.
627 .TP
628 .BR dgit-distro. \fIdistro\fR /push. *
629 If set, overrides corresponding non \fB/push\fR config when
630 .BR readonly=false ,
631 or when pushing and
632 .BR readonly=auto .
633 .TP
634 .BI dgit-distro. distro .git-url
635 .TP
636 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
637 .TP
638 .BI dgit-distro. distro .git-proto
639 .TP
640 .BI dgit-distro. distro .git-path
641 .TP
642 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
643 .TP
644 .BI dgit-distro. distro .git-check-suffix
645 .TP
646 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
647 .TP
648 .BI dgit-distro. distro .git-create " " ssh-cmd | true
649 .TP
650 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
651 .TP
652 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
653 .TP
654 .BI dgit-distro. distro .madison-distro
655 .TP
656 .BI dgit-distro. distro .archive-query-default-component
657 .TP
658 .BI dgit-distro. distro .ssh
659 .TP
660 .BI dgit-distro. distro .sshpsql-dbname
661 .TP
662 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
663 .TP
664 .BI dgit-distro. distro .backports-quirk
665 .TP
666 .BR dgit.default. *
667 for each
668 .BR dgit-distro. \fIdistro\fR . *
670 .TP
672 specify an alternative default program (and perhaps arguments) to use
673 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
674 if it contains any whitespace will be passed to the shell.  GIT_SSH
675 specifies just the program; no arguments can be specified, so dgit
676 interprets it the same way as git does.
677 See
678 also the --ssh= and --ssh: options.
679 .TP
680 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
681 and other subprograms and modules used by dgit are affected by various
682 environment variables.  Consult the documentaton for those programs
683 for details.
684 .SH BUGS
685 dgit's git representation of format `3.0 (quilt)' source packages does
686 not represent the patch stack as git commits.  Currently the patch
687 series representation cannot round trip between git and the archive.
688 Ideally dgit would represent a quilty package with an origin commit of
689 some kind followed by the patch stack as a series of commits followed
690 by a pseudo-merge (to make the branch fast-forwarding).  This would
691 also mean a new `dgit rebase-prep' command or some such to turn such a
692 fast-forwarding branch back into a rebasing patch stack, and a `force'
693 option to dgit push (perhaps enabled automatically by a note left by
694 rebase-prep) which will make the required pseudo-merge.
696 If the dgit push fails halfway through, it should be restartable and
697 idempotent.  However this is not true for the git tag operation.
698 Also, it would be good to check that the proposed signing key is
699 available before starting work.
701 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
702 the .orig.tar.gz could be transported via the git repo as git tags.
703 Doing this is made more complicated by the possibility of a `3.0
704 (quilt)' package with multiple .orig tarballs.
706 dgit's build functions, and dgit push, should not make any changes to
707 your current HEAD.  Sadly this is necessary for packages in the `3.0
708 (quilt)' source format.  This is ultimately due to what I consider
709 design problems in quilt and dpkg-source.
711 There should be an option which arranges for the `3.0 (quilt)'
712 autocommit(s) to not appear on your HEAD, but instead only in the
713 remote tracking suite branch.
715 The option parser requires values to be cuddled to the option name.
717 --dry-run does not always work properly, as not doing some of the git
718 fetches may result in subsequent actions being different.  Doing a
719 non-dry-run dgit fetch first will help.
721 \fBdgit\fP(7),
722 \fBcurl\fP(1),
723 \fBdput\fP(1),
724 \fBdebsign\fP(1),
725 \fBgit-config\fP(1),
726 \fBgit-buildpackage\fP(1),
727 \fBdpkg-buildpackage\fP(1),
728 .br