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