chiark / gitweb /
Split tags: Preparation: Reorganise tagwants and mktags
[dgit.git] / dgit.1
1 .TH dgit 1 "" "Debian Project" "dgit"
2 .SH NAME
3 dgit \- git integration with the Debian archive
4 .
5 .SH SYNOPSIS
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 ...
28 .SH DESCRIPTION
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.
34
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.
46 .SH OPERATIONS
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.
60
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.
71
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.
104
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.
115
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.
131 The output is left in
132 .IR package \fB_\fR version \fB_multi.changes\fR.
133
134 Tagging, signing and actually uploading should be left to dgit push.
135 .TP
136 \fBdgit gbp-build\fR ...
137 Runs
138 .B git-buildpackage
139 with some suitable options.  Options and arguments after gbp-build
140 will be passed on to git-buildpackage.
141
142 Tagging, signing and actually uploading should be left to dgit push.
143 .TP
144 \fBdgit push\fR [\fIsuite\fP]
145 Does an `upload', pushing the current HEAD to the archive (as a source
146 package) and to dgit-repos (as git commits).  The package must already
147 have been built ready for upload, with the .dsc and .changes
148 left in the parent directory.  It is normally best to do the build
149 with dgit too (eg with dgit sbuild): some existing build tools pass
150 unhelpful options to dpkg-source et al by default, which can result in
151 the built source package not being identical to the git tree.
152
153 In more detail: dgit push checks that the current HEAD corresponds to
154 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
155 makes a signed git tag, edits the .dsc to contain the dgit metadata
156 field, runs debsign to sign the upload (.dsc and .changes), pushes the
157 signed tag, and finally uses dput to upload the .changes to the
158 archive.
159
160 dgit push always uses the package, suite and version specified in the
161 debian/changelog and the .dsc, which must agree.  If the command line
162 specifies a suite then that must match too.
163
164 If dgit push fails while uploading, it is fine to simply retry the
165 dput on the .changes file at your leisure.
166 .TP
167 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
168 Pushes the contents of the specified directory on a remote machine.
169 This is like running dgit push on build-host with build-dir as the
170 current directory; however, signing operations are done on the
171 invoking host.  This allows you to do a push when the system which has
172 the source code and the build outputs has no access to the key:
173
174 1.      Clone on build host (dgit clone)
175 .br
176 2.      Edit code on build host (edit, git commit)
177 .br
178 3.      Build package on build host (dgit build)
179 .br
180 4.      Test package on build host or elsewhere (dpkg -i, test)
181 .br
182 5.      Upload by invoking dgit rpush on host with your GPG key.
183
184 However, the build-host must be able to ssh to the dgit repos.  If
185 this is not already the case, you must organise it separately, for
186 example by the use of ssh agent forwarding.
187
188 The remaining arguments are treated just as dgit push would handle
189 them.
190
191 build-host and build\-dir can be passed as separate
192 arguments; this is assumed to be the case if the first argument
193 contains no : (except perhaps one in [ ], to support IPv6 address
194 literals).
195
196 You will need similar enough versions of dgit on the build-host and
197 the invocation host.  The build-host needs gnupg installed, with your
198 public key in its keyring (but not your private key, obviously).
199 .TP
200 .B dgit setup-new-tree
201 Configure the current working tree the way that dgit clone would have
202 set it up.  Like running
203 .B dgit setup-useremail
204 and
205 .B setup-mergechangelogs
206 (but only does each thing if dgit is configured to do it automatically).
207 You can use these in any git repository, not just ones used with
208 the other dgit operations.
209 .TP
210 .B dgit setup-useremail
211 Set the working tree's user.name and user.email from the
212 distro-specific dgit configuration
213 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
214 or DEBFULLNAME or DEBEMAIL.
215 .TP
216 .B dgit setup-mergechangelogs
217 Configures a git merge helper for the file
218 .B debian/changelog
219 which uses
220 .BR dpkg-mergechangelogs .
221 .TP
222 .B dgit quilt-fixup
223 `3.0 (quilt)' format source packages need changes representing not
224 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
225 checks whether this has been done; if not, dgit will make appropriate
226 patches in debian/patches and also commit the resulting changes to
227 git.
228
229 This is normally done automatically by dgit build and dgit push.
230
231 dgit will try to turn each relevant commit in your git history into a
232 new quilt patch.  dgit cannot convert nontrivial merges, or certain
233 other kinds of more exotic history.  If dgit can't find a suitable
234 linearisation of your history, by default it will fail, but you can
235 ask it to generate a single squashed patch instead.
236 .TP
237 .B dgit version
238 Prints version information and exits.
239 .TP
240 .BI "dgit clone-dgit-repos-server" " destdir"
241 Tries to fetch a copy of the source code for the dgit-repos-server,
242 as actually being used on the dgit git server, as a git tree.
243 .SH OPTIONS
244 .TP
245 .BR --dry-run " | " -n
246 Go through the motions, fetching all information needed, but do not
247 actually update the output(s).  For push, dgit does
248 the required checks and leaves the new .dsc in a temporary file,
249 but does not sign, tag, push or upload.
250 .TP
251 .BR --damp-run " | " -L
252 Go through many more of the motions: do everything that doesn't
253 involve either signing things, or making changes on the public
254 servers.
255 .TP
256 .BI -k keyid
257 Use
258 .I keyid
259 for signing the tag and the upload.  The default comes from the
260 distro's
261 .B keyid
262 config setting (see CONFIGURATION, below), or failing that, the
263 uploader trailer line in debian/changelog.
264 .TP
265 .BR --no-sign
266 does not sign tags or uploads (meaningful only with push).
267 .TP
268 .TP
269 .BI -p package
270 Specifies that we should process source package
271 .I package
272 rather than looking in debian/control or debian/changelog.
273 Valid with dgit fetch and dgit pull, only.
274 .TP
275 .BR --clean=git " | " -wg
276 The source tree should be cleaned, before building a source package
277 with one of the build options, using
278 .BR "git clean -xdf" .
279 This will delete all files which are not tracked by git.  Also, -wg
280 causes dgit to pass
281 .B -nc
282 to dpkg-buildpackage, which prevents the package's own clean target
283 from being run.
284
285 --clean=git is useful when the package's clean target is troublesome;
286 the downside is simply that git clean may delete files you forgot to
287 git add.  --clean=git can also avoid needing the build-dependencies.
288 .TP
289 .BR --clean=git-ff " | " -wgf
290 The source tree should be cleaned, before building a source package
291 with one of the build options, using
292 .BR "git clean -xdff" .
293 This is like
294 "git clean -xdf"
295 but it also removes any subdirectories containing different git
296 trees (which only unusual packages are likely to create).
297 .TP
298 .BR --clean=check " | " -wc
299 Merely check that the tree is clean (does not contain uncommitted
300 files), before building a source package.
301 .TP
302 .BR --clean=none " | " -wn
303 Do not clean the tree before building a source package.  If there are
304 files which are not in git, or if the build creates such files, a
305 subsequent dgit push will fail.
306 .TP
307 .BR --clean=dpkg-source " | " -wd
308 Use dpkg-buildpackage to do the clean, so that the source package
309 is cleaned by dpkg-source running the package's clean target.
310 This is the default.  It requires the package's build dependencies.
311 .TP
312 .BR --clean=dpkg-source-d " | " -wdd
313 Use
314 .B dpkg-buildpackage -d
315 to do the clean, so that the source package
316 is cleaned by dpkg-source running the package's clean target.
317 The build-dependencies are not checked (due to
318 .BR -d ),
319 which violates policy, but may work in practice.
320 .TP
321 .BR -N " | " --new
322 The package is or may be new in this suite.  Without this, dgit will
323 refuse to push.  It may (for Debian, will) be unable to access the git
324 history for any packages which have been newly pushed and have not yet
325 been published.
326 .TP
327 .BR --ignore-dirty
328 Do not complain if the working tree does not match your git HEAD.
329 This can be useful with build, if you plan to commit later.  (dgit
330 push will still ensure that the .dsc you upload and the git tree
331 you push are identical, so this option won't make broken pushes.)
332 .TP
333 .BI --deliberately- something
334 Declare that you are deliberately doing
335 .IR something .
336 This can be used to override safety catches, including safety catches
337 which relate to distro-specific policies.  The meanings of
338 .IR something s
339 understood in the context of Debian are discussed below:
340 .TP
341 .BR --deliberately-not-fast-forward
342 Declare that you are deliberately rewinding history.  When pushing to
343 Debian, use this when you are making a renewed upload of an entirely
344 new source package whose previous version was not accepted for release
345 from NEW because of problems with copyright or redistributibility.
346 .TP
347 .BR --deliberately-include-questionable-history
348 Declare that you are deliberately including, in the git history of
349 your current push, history which contains a previously-submitted
350 version of this package which was not approved (or has not yet been
351 approved) by the ftpmasters.  When pushing to Debian, only use this
352 option after verifying that: none of the rejected-from-NEW (or
353 never-accepted) versions in the git history of your current push, were
354 rejected by ftpmaster for copyright or redistributability reasons.
355 .TP
356 .BR --deliberately-fresh-repo
357 Declare that you are deliberately rewinding history and want to
358 throw away the existing repo.  Not relevant when pushing to Debian,
359 as the Debian server will do this automatically when necessary.
360 .TP
361 .BR --quilt=linear
362 When fixing up source format `3.0 (quilt)' metadata, insist on
363 generating a linear patch stack.  If such a stack cannot be generated,
364 fail.  This is the default for Debian.
365 .TP
366 .BR --quilt=auto
367 When fixing up source format `3.0 (quilt)' metadata, prefer to
368 generate a linear patch stack, but if that doesn't seem possible,
369 generate a single squashed patch for all the changes made in git.
370 This is not a good idea for an NMU in Debian.
371 .TP
372 .BR --quilt=smash
373 When fixing up source format `3.0 (quilt)' metadata,
374 generate a single squashed patch for all the changes made in git.
375 This is not a good idea for an NMU in Debian.
376 .TP
377 .BR --quilt=nofix
378 Check whether source format `3.0 (quilt)' metadata would need fixing
379 up, but, if it does, fail.  You must then fix the metadata yourself
380 somehow before pushing.  (NB that dpkg-source --commit will not work
381 because the dgit git tree does not have a
382 .B .pc
383 directory.)
384 .TP
385 .BR --quilt=nocheck " | " --no-quilt-fixup
386 Do not check whether up source format `3.0 (quilt)' metadata needs
387 fixing up.  If you use this option and the metadata did in fact need
388 fixing up, dgit push will fail.
389 .TP
390 .BI -D
391 Prints debugging information to stderr.  Repeating the option produces
392 more output (currently, up to -DDDD is meaningfully different).
393 .TP
394 .BI -c name = value
395 Specifies a git configuration option, to be used for this run.
396 dgit itself is also controlled by git configuration options.
397 .TP
398 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
399 Specifies the
400 .BI -v version
401 option to pass to dpkg-genchanges, during builds.  Changes (from
402 debian/changelog) since this version will be included in the built
403 changes file, and hence in the upload.  If this option is not
404 specified, dgit will query the archive and use the latest version
405 uploaded to the intended suite.
406
407 Specifying
408 .B _
409 inhibits this, so that no -v option will be passed to dpkg-genchanges
410 (and as a result, only the last stanza from debian/changelog will
411 be used for the build and upload).
412 .TP
413 .RI \fB-m\fR maintaineraddress
414 Passed to dpkg-genchanges (eventually).
415 .TP
416 .RI \fB--ch:\fR option
417 Specifies a single additional option to pass, eventually, to
418 dpkg-genchanges.
419 .TP
420 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
421 Specifies alternative programs to use instead of
422 .BR curl ,
423 .BR dput ,
424 .BR debsign ,
425 .BR dpkg-source ,
426 .BR dpkg-buildpackage ,
427 .BR dpkg-genchanges ,
428 .BR sbuild ,
429 .BR gpg ,
430 .BR ssh ,
431 .BR dgit ,
432 .BR git ,
433 or
434 .BR mergechanges .
435
436 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
437 this applies only when the program is invoked directly by dgit.
438
439 For dgit, specifies the command to run on the remote host when dgit
440 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
441 itself as the EDITOR for dpkg-source --commit; this is done using
442 argv[0], and is not affected by --dgit=).
443
444 For ssh, the default value is taken from the
445 .B DGIT_SSH
446 or
447 .B GIT_SSH
448 environment variables, if set (see below).  And, for ssh, when accessing the
449 archive and dgit-repos, this command line setting is overridden by the
450 git config variables
451 .BI dgit-distro. distro .ssh
452 and
453 .B .dgit.default.ssh
454 (which can in turn be overridden with -c).  Also, when dgit is using
455 git to access dgit-repos, only git's idea of what ssh to use (eg,
456 .BR GIT_SSH )
457 is relevant.
458 .TP
459 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
460 Specifies a single additional option to pass to
461 .BR curl ,
462 .BR dput ,
463 .BR debsign ,
464 .BR dpkg-source ,
465 .BR dpkg-buildpackage ,
466 .BR dpkg-genchanges ,
467 .BR sbuild ,
468 .BR ssh ,
469 .BR dgit ,
470 or
471 .BR mergechanges .
472 Can be repeated as necessary.
473
474 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
475 this applies only when the program is invoked directly by dgit.
476 Usually, for passing options to dpkg-genchanges, you should use
477 .BR --ch: \fIoption\fR.
478
479 Specifying --git not effective for some lower-level read-only git
480 operations performed by dgit, and also not when git is invoked by
481 another program run by dgit.
482
483 See notes above regarding ssh and dgit.
484
485 NB that --gpg:option is not supported (because debsign does not
486 have that facility).
487 But see
488 .B -k
489 and the
490 .B keyid
491 distro config setting.
492 .TP
493 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
494 Specifies that the suite to be operated on is part of distro
495 .IR distro .
496 This overrides the default value found from the git config option
497 .BR dgit-suite. \fIsuite\fR .distro .
498 The only effect is that other configuration variables (used
499 for accessing the archive and dgit-repos) used are
500 .BR dgit-distro. \fIdistro\fR .* .
501
502 If your suite is part of a distro that dgit already knows about, you
503 can use this option to make dgit work even if your dgit doesn't know
504 about the suite.  For example, specifying
505 .B -ddebian
506 will work when the suite is an unknown suite in the Debian archive.
507
508 To define a new distro it is necessary to define methods and URLs
509 for fetching (and, for dgit push, altering) a variety of information both
510 in the archive and in dgit-repos.
511 How to set this up is not yet documented.
512 .TP
513 .BI -C changesfile
514 Specifies the .changes file which is to be uploaded.  By default
515 dgit push looks for single .changes file in the parent directory whose
516 filename suggests it is for the right package and version.
517
518 If the specified
519 .I changesfile
520 pathname contains slashes, the directory part is also used as
521 the value for
522 .BR --build-products-dir ;
523 otherwise, the changes file is expected in that directory (by
524 default, in
525 .BR .. ).
526 .TP
527 .B --rm-old-changes
528 When doing a build, delete any changes files matching
529 .IB package _ version _*.changes
530 before starting.  This ensures that
531 dgit push (and dgit sbuild) will be able to unambigously
532 identify the relevant changes files from the most recent build, even
533 if there have been previous builds with different tools or options.
534 The default is not to remove, but
535 .B \-\-no-rm-old-changes
536 can be used to override a previous \-\-rm-old-changes
537 or the .rm-old-changes configuration setting.
538 .TP
539 .BI --build-products-dir= directory
540 Specifies where to find the built files to be uploaded.
541 By default, dgit looks in the parent directory
542 .RB ( .. ).
543 .TP
544 .BI --existing-package= package
545 dgit push needs to canonicalise the suite name.  Sometimes, dgit
546 lacks a way to ask the archive to do this without knowing the
547 name of an existing package.  Without --new we can just use the
548 package we are trying to push.  But with --new that will not work, so
549 we guess
550 .B dpkg
551 or use the value of this option.  This option is not needed with the
552 default mechanisms for accessing the archive.
553 .TP
554 .BR -h | --help
555 Print a usage summary.
556 .TP
557 .BI --initiator-tempdir= directory
558 dgit rpush uses a temporary directory on the invoking (signing) host.
559 This option causes dgit to use
560 .I directory
561 instead.  Furthermore, the specified directory will be emptied,
562 removed and recreated before dgit starts, rather than removed
563 after dgit finishes.  The directory specified must be an absolute
564 pathname.
565 .TP
566 .BI --no-rm-on-error
567 Do not delete the destination directory if clone fails.
568 .SH WORKFLOW - SIMPLE
569 It is always possible with dgit to clone or fetch a package, make
570 changes in git (using git-commit) on the suite branch
571 .RB ( "git checkout dgit/" \fIsuite\fR)
572 and then dgit push.  You can use whatever gitish techniques you like
573 to construct the commits to push;
574 the only requirement is that what you push is a
575 descendant of the state of the archive, as provided by dgit in the
576 remote tracking branch
577 .BR remotes/dgit/dgit/ \fIsuite\fR.
578
579 If you are using dgit to do an NMU (in Debian),
580 and don't know about the
581 maintainers' preferred packaging workflows, you should make your
582 changes as a linear series of (logicially separated) commits on top of
583 what's already in the archive.
584
585 If you are lucky the other uploaders have also used dgit and
586 integrated the other relevant git history; if not you can fetch it
587 into your tree and cherry-pick etc. as you wish.
588 .SH WORKFLOW - INTEGRATING BETWEEN DGIT AND OTHER GIT HISTORY
589 If you are the maintainer of a package dealing with uploads made
590 without dgit, you will probably want to merge the synthetic commits
591 (made by dgit to represent the uploads) into your git history.
592 Normally you can just merge the dgit branch into your own master, or
593 indeed if you do your work on the dgit local suite branch
594 .BI dgit/ suite
595 you can just use dgit pull.
596
597 However the first time dgit is used it will generate a new origin
598 commit from the archive which won't be linked into the rest of your
599 git history.  You will need to merge this.
600
601 If last upload was in fact made with git, you should usually proceed
602 as follows: identify the commit which was actually used to build the
603 package.  (Hopefully you have a tag for this.)  Check out the dgit
604 branch
605 .RB ( "git checkout dgit/" \fIsuite\fR)
606 and merge that other commit
607 .RB ( "git merge debian/" \fIversion\fR).
608 Hopefully this merge will be trivial because the two trees should
609 be very similar.  The resulting branch head can be merged into your
610 working branches
611 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
612
613 If last upload was not made with git, a different approach is required
614 to start using dgit.  First, do
615 .B dgit fetch
616 (or clone) to obtain a git history representation of what's in the
617 archive and record it in the
618 .BI remotes/dgit/dgit/ suite
619 tracking branch.  Then somehow, using your other git history
620 plus appropriate diffs and cherry picks from the dgit remote tracking
621 branch, construct a git commit whose tree corresponds to the tree to use for the
622 next upload.  If that commit-to-be-uploaded is not a descendant of the
623 dgit remote tracking branch, check it out and say
624 .BR "git merge -s ours remotes/dgit/dgit/" \fIsuite\fR;
625 that tells git that we are deliberately throwing away any differences
626 between what's in the archive and what you intend to upload.
627 Then run
628 .BR "dgit push"
629 to actually upload the result.
630 .SH CONFIGURATION
631 dgit can be configured via the git config system.
632 You may set keys with git-config (either in system-global or per-tree
633 configuration), or provide
634 .BI -c key = value
635 on the dgit command line.
636 .LP
637 Settings likely to be useful for an end user include:
638 .TP
639 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
640 Specifies the distro for a suite.  dgit keys off the suite name (which
641 appears in changelogs etc.), and uses that to determine the distro
642 which is involved.  The config used is thereafter that for the distro.
643 .TP
644 .BI dgit.default.distro " distro"
645 The default distro for an unknown suite.
646 .TP
647 .BR dgit.default. *
648 for each
649 .BR dgit-distro. \fIdistro\fR . *,
650 the default value used if there is no distro-specific setting.
651 .TP
652 .BR dgit-distro. \fIdistro\fR .clean-mode
653 One of the values for the command line --clean= option; used if
654 --clean is not specified.
655 .TP
656 .BR dgit-distro. \fIdistro\fR .quilt-mode
657 One of the values for the command line --quilt= option; used if
658 --quilt is not specified.
659 .TP
660 .BR dgit-distro. \fIdistro\fR .rm-old-changes
661 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
662 is specified.  The default is not to remove.
663 .TP
664 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
665 Whether you have push access to the distro.
666 For Debian, it is OK to use auto, which uses readonly mode if you are
667 not pushing right now;
668 but, setting this to false will avoid relying on the mirror of the dgit
669 git repository server.
670 .TP
671 .BI dgit-distro. distro .keyid
672 See also
673 .BR -k .
674 .TP
675 .BI dgit-distro. distro .mirror " url"
676 .TP
677 .BI dgit-distro. distro .username
678 Not relevant for Debian.
679 .TP
680 .BI dgit-distro. distro .upload-host
681 Might be useful if you have an intermediate queue server.
682 .TP
683 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
684 Values to configure for user.name and user.email in new git trees.  If
685 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
686 used, respectively.  Only used if .setup-usermail is not disabled.
687 .TP
688 .BI dgit-distro. distro .setup-useremail
689 Whether to set user.name and user.email in new git trees.
690 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
691 .TP
692 .BI dgit-distro. distro .setup-mergechangelogs
693 Whether to setup a merge driver which uses dpkg-mergechangelogs for
694 debian/changelog.  True by default.  Ignored for dgit
695 setup-mergechangelogs, which does it anyway.
696 .TP
697 .BI dgit-distro. distro .cmd- cmd
698 Program to use instead of
699 .IR cmd .
700 Works like
701 .BR -- \fIcmd\fR = "... ."
702 .TP
703 .BI dgit-distro. distro .opts- cmd
704 Extra options to pass to
705 .IR cmd .
706 Works like
707 .BR -- \fIcmd\fR : "... ."
708 To pass several options, configure multiple values in git config
709 (with git config --add).  The options for
710 .BI dgit.default.opts- cmd
711 .BI dgit-distro. distro /push.opts- cmd
712 and are all used, followed by options from dgit's command line.
713 .SH ACCESS CONFIGURATION
714 There are many other settings which specify how a particular distro's
715 services (archive and git) are provided.  These should not normally be
716 adjusted, but are documented for the benefit of distros who wish to
717 adopt dgit.
718 .TP
719 .BR dgit-distro. \fIdistro\fR /push. *
720 If set, overrides corresponding non \fB/push\fR config when
721 .BR readonly=false ,
722 or when pushing and
723 .BR readonly=auto .
724 .TP
725 .BI dgit-distro. distro .git-url
726 .TP
727 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
728 .TP
729 .BI dgit-distro. distro .git-proto
730 .TP
731 .BI dgit-distro. distro .git-path
732 .TP
733 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
734 .TP
735 .BI dgit-distro. distro .git-check-suffix
736 .TP
737 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
738 .TP
739 .BI dgit-distro. distro .git-create " " ssh-cmd | true
740 .TP
741 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
742 .TP
743 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
744 .TP
745 .BI dgit-distro. distro .madison-distro
746 .TP
747 .BI dgit-distro. distro .archive-query-default-component
748 .TP
749 .BI dgit-distro. distro .dgit-tag-format
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
758 .SH ENVIRONMENT VARIABLES
759 .TP
760 .BR DGIT_SSH ", " GIT_SSH
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
769 .BR DEBEMAIL ", " DEBFULLNAME
770 Default git user.email and user.name 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.
788
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.
793
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.
798
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.
803
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.
807
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.
811 .SH SEE ALSO
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
820 https://browse.dgit.debian.org/