chiark / gitweb /
--new is needed for read access to packages in NEW, too. Document this, and make...
[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 arguments 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 arguments 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.  The default comes from the
247 distro's
248 .B keyid
249 config setting (see CONFIGURATION, below), or failing that, gnupg's
250 default.
251 .TP
252 .BR --no-sign
253 does not sign tags or uploads (meaningful only with push).
254 .TP
255 .TP
256 .BI -p package
257 Specifies that we should process source package
258 .I package
259 rather than looking in debian/control or debian/changelog.
260 Valid with dgit fetch and dgit pull, only.
261 .TP
262 .BR --clean=git " | " -wg
263 The source tree should be cleaned, before building a source package
264 with one of the build options, using
265 .BR "git clean -xdf" .
266 This will delete all files which are not tracked by git.  Also, -wg
267 causes dgit to pass
268 .B -nc
269 to dpkg-buildpackage, which prevents the package's own clean target
270 from being run.
272 --clean=git is useful when the package's clean target is troublesome;
273 the downside is simply that git clean may delete files you forgot to
274 git add.  --clean=git can also avoid needing the build-dependencies.
275 .TP
276 .BR --clean=git-ff " | " -wgf
277 The source tree should be cleaned, before building a source package
278 with one of the build options, using
279 .BR "git clean -xdff" .
280 This is like
281 "git clean -xdf"
282 but it also removes any subdirectories containing different git
283 trees (which only unusual packages are likely to create).
284 .TP
285 .BR --clean=check " | " -wc
286 Merely check that the tree is clean (does not contain uncommitted
287 files), before building a source package.
288 .TP
289 .BR --clean=none " | " -wn
290 Do not clean the tree before building a source package.  If there are
291 files which are not in git, or if the build creates such files, a
292 subsequent dgit push will fail.
293 .TP
294 .BR --clean=dpkg-source " | " -wd
295 Use dpkg-buildpackage to do the clean, so that the source package
296 is cleaned by dpkg-source running the package's clean target.
297 This is the default.  It requires the package's build dependencies.
298 .TP
299 .BR --clean=dpkg-source-d " | " -wdd
300 Use
301 .B dpkg-buildpackage -d
302 to do the clean, so that the source package
303 is cleaned by dpkg-source running the package's clean target.
304 The build-dependencies are not checked (due to
305 .BR -d ),
306 which violates policy, but may work in practice.
307 .TP
308 .BR -N " | " --new
309 The package is or may be new in this suite.  Without this, dgit will
310 refuse to push.  It may (for Debian, will) be unable to access the git
311 history for any packages which have been newly pushed and have not yet
312 been published.
313 .TP
314 .BR --ignore-dirty
315 Do not complain if the working tree does not match your git HEAD.
316 This can be useful with build, if you plan to commit later.  (dgit
317 push will still ensure that the .dsc you upload and the git tree
318 you push are identical, so this option won't make broken pushes.)
319 .TP
320 .BI --deliberately- something
321 Declare that you are deliberately doing
322 .IR something .
323 This can be used to override safety catches, including safety catches
324 which relate to distro-specific policies.  The meanings of
325 .IR something s
326 understood in the context of Debian are discussed below:
327 .TP
328 .BR --deliberately-not-fast-forward
329 Declare that you are deliberately rewinding history.  When pushing to
330 Debian, use this when you are making a renewed upload of an entirely
331 new source package whose previous version was not accepted for release
332 from NEW because of problems with copyright or redistributibility.
333 .TP
334 .BR --deliberately-include-questionable-history
335 Declare that you are deliberately including, in the git history of
336 your current push, history which contains a previously-submitted
337 version of this package which was not approved (or has not yet been
338 approved) by the ftpmasters.  When pushing to Debian, only use this
339 option after verifying that: none of the rejected-from-NEW (or
340 never-accepted) versions in the git history of your current push, were
341 rejected by ftpmaster for copyright or redistributability reasons.
342 .TP
343 .BR --deliberately-fresh-repo
344 Declare that you are deliberately rewinding history and want to
345 throw away the existing repo.  Not relevant when pushing to Debian,
346 as the Debian server will do this automatically when necessary.
347 .TP
348 .BR --quilt=linear
349 When fixing up source format `3.0 (quilt)' metadata, insist on
350 generating a linear patch stack.  If such a stack cannot be generated,
351 fail.  This is the default for Debian.
352 .TP
353 .BR --quilt=auto
354 When fixing up source format `3.0 (quilt)' metadata, prefer to
355 generate a linear patch stack, but if that doesn't seem possible,
356 generate a single squashed patch for all the changes made in git.
357 This is not a good idea for an NMU in Debian.
358 .TP
359 .BR --quilt=smash
360 When fixing up source format `3.0 (quilt)' metadata,
361 generate a single squashed patch for all the changes made in git.
362 This is not a good idea for an NMU in Debian.
363 .TP
364 .BR --quilt=nofix
365 Check whether source format `3.0 (quilt)' metadata would need fixing
366 up, but, if it does, fail.  You must then fix the metadata yourself
367 somehow before pushing.  (NB that dpkg-source --commit will not work
368 because the dgit git tree does not have a
369 .B .pc
370 directory.)
371 .TP
372 .BR --quilt=nocheck " | " --no-quilt-fixup
373 Do not check whether up source format `3.0 (quilt)' metadata needs
374 fixing up.  If you use this option and the metadata did in fact need
375 fixing up, dgit push will fail.
376 .TP
377 .BI -D
378 Prints debugging information to stderr.  Repeating the option produces
379 more output (currently, up to -DDD is meaningfully different).
380 .TP
381 .BI -c name = value
382 Specifies a git configuration option, to be used for this run.
383 dgit itself is also controlled by git configuration options.
384 .TP
385 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
386 Specifies the
387 .BI -v version
388 option to pass to dpkg-genchanges, during builds.  Changes (from
389 debian/changelog) since this version will be included in the built
390 changes file, and hence in the upload.  If this option is not
391 specified, dgit will query the archive and use the latest version
392 uploaded to the intended suite.
394 Specifying
395 .B _
396 inhibits this, so that no -v option will be passed to dpkg-genchanges
397 (and as a result, only the last stanza from debian/changelog will
398 be used for the build and upload).
399 .TP
400 .RI \fB-m\fR maintaineraddress
401 Passed to dpkg-genchanges (eventually).
402 .TP
403 .RI \fB--ch:\fR option
404 Specifies a single additional option to pass, eventually, to
405 dpkg-genchanges.
406 .TP
407 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
408 Specifies alternative programs to use instead of
409 .BR curl ,
410 .BR dput ,
411 .BR debsign ,
412 .BR dpkg-source ,
413 .BR dpkg-buildpackage ,
414 .BR dpkg-genchanges ,
415 .BR sbuild ,
416 .BR gpg ,
417 .BR ssh ,
418 .BR dgit ,
419 or
420 .BR mergechanges .
422 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
423 this applies only when the program is invoked directly by dgit.
425 For dgit, specifies the command to run on the remote host when dgit
426 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
427 itself as the EDITOR for dpkg-source --commit; this is done using
428 argv[0], and is not affected by --dgit=).
430 For ssh, the default value is taken from the
432 or
433 .B GIT_SSH
434 environment variables, if set (see below).  And, for ssh, when accessing the
435 archive and dgit-repos, this command line setting is overridden by the
436 git config variables
437 .BI dgit-distro. distro .ssh
438 and
439 .B .dgit.default.ssh
440 (which can in turn be overridden with -c).  Also, when dgit is using
441 git to access dgit-repos, only git's idea of what ssh to use (eg,
442 .BR GIT_SSH )
443 is relevant.
444 .TP
445 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
446 Specifies a single additional option to pass to
447 .BR curl ,
448 .BR dput ,
449 .BR debsign ,
450 .BR dpkg-source ,
451 .BR dpkg-buildpackage ,
452 .BR dpkg-genchanges ,
453 .BR sbuild ,
454 .BR ssh ,
455 .BR dgit ,
456 or
457 .BR mergechanges .
458 Can be repeated as necessary.
460 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
461 this applies only when the program is invoked directly by dgit.
462 Usually, for passing options to dpkg-genchanges, you should use
463 .BR --ch: \fIoption\fR.
465 See notes above regarding ssh and dgit.
467 NB that --gpg:option is not supported (because debsign does not
468 have that facility).
469 But see
470 .B -k
471 and the
472 .B keyid
473 distro config setting.
474 .TP
475 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
476 Specifies that the suite to be operated on is part of distro
477 .IR distro .
478 This overrides the default value found from the git config option
479 .BR dgit-suite. \fIsuite\fR .distro .
480 The only effect is that other configuration variables (used
481 for accessing the archive and dgit-repos) used are
482 .BR dgit-distro. \fIdistro\fR .* .
484 If your suite is part of a distro that dgit already knows about, you
485 can use this option to make dgit work even if your dgit doesn't know
486 about the suite.  For example, specifying
487 .B -ddebian
488 will work when the suite is an unknown suite in the Debian archive.
490 To define a new distro it is necessary to define methods and URLs
491 for fetching (and, for dgit push, altering) a variety of information both
492 in the archive and in dgit-repos.
493 How to set this up is not yet documented.
494 .TP
495 .BI -C changesfile
496 Specifies the .changes file which is to be uploaded.  By default
497 dgit push looks for single .changes file in the parent directory whose
498 filename suggests it is for the right package and version - or,
499 if there is a _multi.changes file, dgit uses that.
501 If the specified
502 .I changesfile
503 pathname contains slashes, the directory part is also used as
504 the value for
505 .BR --build-products-dir ;
506 otherwise, the changes file is expected in that directory (by
507 default, in
508 .BR .. ).
509 .TP
510 .BI --build-products-dir= directory
511 Specifies where to find the built files to be uploaded.
512 By default, dgit looks in the parent directory
513 .RB ( .. ).
514 .TP
515 .BI --existing-package= package
516 dgit push needs to canonicalise the suite name.  Sometimes, dgit
517 lacks a way to ask the archive to do this without knowing the
518 name of an existing package.  Without --new we can just use the
519 package we are trying to push.  But with --new that will not work, so
520 we guess
521 .B dpkg
522 or use the value of this option.  This option is not needed with the
523 default mechanisms for accessing the archive.
524 .TP
525 .BR -h | --help
526 Print a usage summary.
527 .TP
528 .BI --initiator-tempdir= directory
529 dgit rpush uses a temporary directory on the invoking (signing) host.
530 This option causes dgit to use
531 .I directory
532 instead.  Furthermore, the specified directory will be emptied,
533 removed and recreated before dgit starts, rather than removed
534 after dgit finishes.  The directory specified must be an absolute
535 pathname.
536 .TP
537 .BI --no-rm-on-error
538 Do not delete the destination directory if clone fails.
540 It is always possible with dgit to clone or fetch a package, make
541 changes in git (using git-commit) on the suite branch
542 .RB ( "git checkout dgit/" \fIsuite\fR)
543 and then dgit push.  You can use whatever gitish techniques you like
544 to construct the commits to push;
545 the only requirement is that what you push is a
546 descendant of the state of the archive, as provided by dgit in the
547 remote tracking branch
548 .BR remotes/dgit/dgit/ \fIsuite\fR.
550 If you are using dgit to do an NMU (in Debian),
551 and don't know about the
552 maintainers' preferred packaging workflows, you should make your
553 changes as a linear series of (logicially separated) commits on top of
554 what's already in the archive.
556 If you are lucky the other uploaders have also used dgit and
557 integrated the other relevant git history; if not you can fetch it
558 into your tree and cherry-pick etc. as you wish.
560 If you are the maintainer of a package dealing with uploads made
561 without dgit, you will probably want to merge the synthetic commits
562 (made by dgit to represent the uploads) into your git history.
563 Normally you can just merge the dgit branch into your own master, or
564 indeed if you do your work on the dgit local suite branch
565 .BI dgit/ suite
566 you can just use dgit pull.
568 However the first time dgit is used it will generate a new origin
569 commit from the archive which won't be linked into the rest of your
570 git history.  You will need to merge this.
572 If last upload was in fact made with git, you should usually proceed
573 as follows: identify the commit which was actually used to build the
574 package.  (Hopefully you have a tag for this.)  Check out the dgit
575 branch
576 .RB ( "git checkout dgit/" \fIsuite\fR)
577 and merge that other commit
578 .RB ( "git merge debian/" \fIversion\fR).
579 Hopefully this merge will be trivial because the two trees should
580 be very similar.  The resulting branch head can be merged into your
581 working branches
582 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
584 If last upload was not made with git, a different approach is required
585 to start using dgit.  First, do
586 .B dgit fetch
587 (or clone) to obtain a git history representation of what's in the
588 archive and record it in the
589 .BI remotes/dgit/dgit/ suite
590 tracking branch.  Then somehow, using your other git history
591 plus appropriate diffs and cherry picks from the dgit remote tracking
592 branch, construct a git commit whose tree corresponds to the tree to use for the
593 next upload.  If that commit-to-be-uploaded is not a descendant of the
594 dig remote tracking branch, check it out and say
595 .BR "git merge -s ours remotes/dgit/dgit/" \fIsuite\fR;
596 that tells git that we are deliberately throwing away any differences
597 between what's in the archive and what you intend to upload.
598 Then run
599 .BR "dgit push"
600 to actually upload the result.
602 dgit can be configured via the git config system.
603 You may set keys with git-config (either in system-global or per-tree
604 configuration), or provide
605 .BI -c key = value
606 on the dgit command line.
607 .LP
608 Settings likely to be useful for an end user include:
609 .TP
610 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
611 Specifies the distro for a suite.  dgit keys off the suite name (which
612 appears in changelogs etc.), and uses that to determine the distro
613 which is involved.  The config used is thereafter that for the distro.
614 .TP
615 .BI dgit.default.distro " distro"
616 The default distro for an unknown suite.
617 .TP
618 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
619 Whether you have push access to the distro.
620 For Debian, it is OK to use auto, which uses readonly mode if you are
621 not pushing right now;
622 but, setting this to false will avoid relying on the mirror of the dgit
623 git repository server.
624 .TP
625 .BI dgit-distro. distro .keyid
626 See also
627 .BR -k .
628 .TP
629 .BI dgit-distro. distro .mirror " url"
630 .TP
631 .BI dgit-distro. distro .username
632 Not relevant for Debian.
633 .TP
634 .BI dgit-distro. distro .upload-host
635 Might be useful if you have an intermediate queue server.
637 There are many other settings which specify how a particular distro's
638 services (archive and git) are provided.  These should not normally be
639 adjusted, but are documented for the benefit of distros who wish to
640 adopt dgit.
641 .TP
642 .BR dgit-distro. \fIdistro\fR /push. *
643 If set, overrides corresponding non \fB/push\fR config when
644 .BR readonly=false ,
645 or when pushing and
646 .BR readonly=auto .
647 .TP
648 .BI dgit-distro. distro .git-url
649 .TP
650 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
651 .TP
652 .BI dgit-distro. distro .git-proto
653 .TP
654 .BI dgit-distro. distro .git-path
655 .TP
656 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
657 .TP
658 .BI dgit-distro. distro .git-check-suffix
659 .TP
660 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
661 .TP
662 .BI dgit-distro. distro .git-create " " ssh-cmd | true
663 .TP
664 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
665 .TP
666 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
667 .TP
668 .BI dgit-distro. distro .madison-distro
669 .TP
670 .BI dgit-distro. distro .archive-query-default-component
671 .TP
672 .BI dgit-distro. distro .ssh
673 .TP
674 .BI dgit-distro. distro .sshpsql-dbname
675 .TP
676 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
677 .TP
678 .BI dgit-distro. distro .backports-quirk
679 .TP
680 .BR dgit.default. *
681 for each
682 .BR dgit-distro. \fIdistro\fR . *
684 .TP
686 specify an alternative default program (and perhaps arguments) to use
687 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
688 if it contains any whitespace will be passed to the shell.  GIT_SSH
689 specifies just the program; no arguments can be specified, so dgit
690 interprets it the same way as git does.
691 See
692 also the --ssh= and --ssh: options.
693 .TP
694 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
695 and other subprograms and modules used by dgit are affected by various
696 environment variables.  Consult the documentaton for those programs
697 for details.
698 .SH BUGS
699 dgit's git representation of format `3.0 (quilt)' source packages does
700 not represent the patch stack as git commits.  Currently the patch
701 series representation cannot round trip between git and the archive.
702 Ideally dgit would represent a quilty package with an origin commit of
703 some kind followed by the patch stack as a series of commits followed
704 by a pseudo-merge (to make the branch fast-forwarding).  This would
705 also mean a new `dgit rebase-prep' command or some such to turn such a
706 fast-forwarding branch back into a rebasing patch stack, and a `force'
707 option to dgit push (perhaps enabled automatically by a note left by
708 rebase-prep) which will make the required pseudo-merge.
710 If the dgit push fails halfway through, it should be restartable and
711 idempotent.  However this is not true for the git tag operation.
712 Also, it would be good to check that the proposed signing key is
713 available before starting work.
715 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
716 the .orig.tar.gz could be transported via the git repo as git tags.
717 Doing this is made more complicated by the possibility of a `3.0
718 (quilt)' package with multiple .orig tarballs.
720 dgit's build functions, and dgit push, should not make any changes to
721 your current HEAD.  Sadly this is necessary for packages in the `3.0
722 (quilt)' source format.  This is ultimately due to what I consider
723 design problems in quilt and dpkg-source.
725 There should be an option which arranges for the `3.0 (quilt)'
726 autocommit(s) to not appear on your HEAD, but instead only in the
727 remote tracking suite branch.
729 The option parser requires values to be cuddled to the option name.
731 --dry-run does not always work properly, as not doing some of the git
732 fetches may result in subsequent actions being different.  Doing a
733 non-dry-run dgit fetch first will help.
735 \fBdgit\fP(7),
736 \fBcurl\fP(1),
737 \fBdput\fP(1),
738 \fBdebsign\fP(1),
739 \fBgit-config\fP(1),
740 \fBgit-buildpackage\fP(1),
741 \fBdpkg-buildpackage\fP(1),
742 .br