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