chiark / gitweb /
dgit(1): Cover more cases of --overwrite and --deliberately
[dgit.git] / dgit.1
1 '\" t
2 .TH dgit 1 "" "Debian Project" "dgit"
4 dgit \- git integration with the Debian archive
5 .
7 .B dgit
8 [\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
9 \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
10 .br
11 .B dgit
12 [\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]
13 [\fIsuite\fP]
14 .br
15 .B dgit
16 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP
17 [\fIbuild\-opts\fP]
18 .br
19 .B dgit
20 [\fIdgit\-opts\fP] \fBpbuilder\fP|\fBcowbuilder\fP
21 [\fIdebbuildopts\fP]
22 .br
23 .B dgit
24 [\fIdgit\-opts\fP] \fBpush\fP|\fBpush-source\fP [\fIdgit\-opts\fP]
25 [\fIsuite\fP]
26 .br
27 .B dgit
28 [\fIdgit\-opts\fP] \fBrpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR
29 [\fIpush args...\fR]
30 .br
31 .B dgit
32 [\fIdgit\-opts\fP] \fIaction\fR ...
34 .B dgit
35 allows you to treat the Debian archive as if it were a git
36 repository.
37 Conversely,
38 it allows Debian to publish the source of its packages
39 as git branches, in a format which is directly useable
40 by ordinary people.
42 This is the command line reference.
43 Please read the tutorial(s):
44 .TS
45 lb l.
46 dgit-user(7)    for users: edit, build and share packages
47 dgit-nmu-simple(7)      for DDs: do a straightforward NMU
48 dgit-maint-native(7)    for maintainers of Debian-native packages
49 dgit-maint-debrebase(7) for maintainers: a pure-git rebasish workflow
50 dgit-maint-merge(7)     for maintainers: a pure-git merging workflow
51 dgit-maint-gbp(7)       for maintainers already using git-buildpackage
52 dgit-sponsorship(7)     for sponsors and sponsored contributors
53 dgit-downstream-dsc(7)  setting up dgit push for a new distro
54 .TE
55 .LP
56 See \fBdgit(7)\fP for detailed information about the data
57 model,
58 common problems likely to arise with certain kinds of package,
59 etc.
61 .TP
62 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
63 Consults the archive and dgit-repos to construct the git view of
64 history for
65 .I package
66 in
67 .I suite
68 .RB ( sid
69 by default)
70 in a new directory (named
71 .BI ./ package
72 by default);
73 also, downloads any necessary orig tarballs.
75 The suite's git tip is
76 left on the local branch
77 .BI dgit/ suite
78 ready for work, and on the corresponding dgit remote tracking branch.
79 The
80 .B origin
81 remote will be set up to point to the package's dgit-repos tree
82 for the distro to which
83 .I suite
84 belongs.
86 .I suite
87 may be a combination of several underlying suites in the form
88 .IR mainsuite \fB,\fR subsuite ...;
89 see COMBINED SUITES in dgit(7).
91 For your convenience, the
92 .B vcs-git
93 remote will be set up from the package's Vcs-Git field, if there is
94 one - but note that in the general case the history found there may be
95 different to or even disjoint from dgit's view.
96 (See also dgit update-vcs-git.)
97 .TP
98 \fBdgit fetch\fR [\fIsuite\fP]
99 Consults the archive and git-repos to update the git view of
100 history for a specific suite (and downloads any necessary orig
101 tarballs), and updates the remote tracking branch
102 .BR remotes/dgit/dgit/ \fIsuite\fR.
103 If the current branch is
104 .BI dgit/ suite
105 then dgit fetch defaults to
106 .IR suite ;
107 otherwise it parses debian/changelog and uses the suite specified
108 there.
109 suite may be a combined suite, as for clone.
110 .TP
111 \fBdgit pull\fR [\fIsuite\fP]
112 Does dgit fetch, and then merges the new head of the remote tracking
113 branch
114 .BI remotes/dgit/dgit/ suite
115 into the current branch.
116 .TP
117 \fBdgit checkout\fR \fIsuite\fR
118 Checks out the local branch
119 .BR dgit/ \fIsuite\fR.
121 If the branch does not exist,
122 dgit checkout creates it,
123 and sets it up the same way as dgit clone would.
124 In that case, if
125 the archive remote tracking branch does not exist,
126 dgit checkout will do a dgit fetch first.
128 NB: dgit checkout will only do a fetch if it has to.
129 If you already have the suite branch,
130 and want to merge your branch with updates from the archive,
131 use dgit pull.
133 dgit checkout will normally need to access the archive server,
134 to canonicalise the provided suite name.
135 The exception is if you specify the canonical name,
136 and the branch (or tracking branch) already exists.
137 .TP
138 \fBdgit build\fR ...
139 Runs
140 .B dpkg-buildpackage
141 with some suitable options.  Options and arguments after build
142 will be passed on to dpkg-buildpackage.  It is not necessary to use
143 dgit build when using dgit; it is OK to use any approach which ensures
144 that the generated source package corresponds to the relevant git
145 commit.
147 Tagging, signing and actually uploading should be left to dgit push.
149 dgit's build operations access the network,
150 to get the \-v option right.
151 See \-v, below.
152 .TP
153 \fBdgit build-source\fR ...
154 Builds the source package, and a changes file for a prospective
155 source-only upload, using
156 .BR dpkg-source .
157 The output is left in
158 .IR package \fB_\fR version \fB.dsc\fR
159 and
160 .IR package \fB_\fR version \fB_source.changes\fR.
162 Tagging, signing and actually uploading should be left to dgit
163 push-source, or dgit push.
164 .TP
165 .B dgit clean
166 Cleans the current working tree (according to the \-\-clean= option in
167 force).
168 .TP
169 \fBdgit update-vcs-git\fR [\fIsuite\fP|\fB.\fR] [\fB\-\-\fR] [\fIgit fetch options\fR]
170 .TQ
171 \fBdgit update-vcs-git\fR [\fIsuite|\fP\fB.\fR] \fB\-\fR
172 Sets up, or updates the url of, the vcs-git remote, and
173 (unless \fB-\fR was specified)
174 runs git fetch on it.
176 By default, the Vcs-Git field of the .dsc from Debian sid is used,
177 as that is probably most up to date.
178 Another suite may be specified, or
179 .B .
180 to indicate that the Vcs-Git of the cwd's debian/control should
181 be used instead.
182 .TP
183 .B dgit help
184 Print a usage summary.
185 .TP
186 \fBdgit sbuild\fR ...
187 Constructs the source package, uses
188 .B  sbuild
189 to do a binary build, and uses mergechanges to merge the source and
190 binary changes files.  Options and arguments after sbuild will be
191 passed on to sbuild.
192 The output is left in
193 .IR package \fB_\fR version \fB_multi.changes\fR.
194 .IP
195 Note that by default
196 sbuild does not build arch-independent packages.
197 You probably want to pass \-A, to request those.
198 .IP
199 Tagging, signing and actually uploading should be left to dgit push.
200 .TP
201 \fBdgit pbuilder\fR [\fIdebbuildopts\fP]
202 Constructs the source package, uses
203 .B  pbuilder
204 to do a binary build, and uses mergechanges to merge the source and
205 binary changes files.
206 The output is left in
207 .IR package \fB_\fR version \fB_multi.changes\fR.
209 You should ensure that your dgit \-\-build-products-dir setting matches
210 your pbuilder \-\-buildresult.
212 The \fIdebbuildopts\fP are passed to pbuilder using its \-\-debbuildopts
213 option.  If you want to pass other options to pbuilder, use the
214 \fB\-\-pbuilder:\fR dgit option as described below
215 (remember that dgit options should appear between \fBdgit\fR and
216 \fBpbuilder\fR).
218 You should ensure that in your pbuilderrc you do
219 .B not
220 have the setting
222 as this may cause trouble.
223 .TP
224 \fBdgit cowbuilder\fR [\fIdebbuildopts\fP]
225 Like \fBdgit pbuilder\fR, but uses
226 .B cowbuilder
227 instead of
228 .B pbuilder.
229 .TP
230 \fBdgit gbp-build\fR ...
231 Runs
232 .B git-buildpackage
233 with some suitable options.  Options and arguments after gbp-build
234 will be passed on to git-buildpackage.
236 By default this uses \-\-quilt=gbp, so HEAD should be a
237 git-buildpackage style branch, not a patches-applied branch.
239 Tagging, signing and actually uploading should be left to dgit push.
240 .TP
241 \fBdgit push\fR [\fIsuite\fP]
242 Does an `upload', pushing the current HEAD to the archive (as a source
243 package) and to dgit-repos (as git commits).  The package must already
244 have been built ready for upload, with the .dsc and .changes
245 left in the parent directory.  It is normally best to do the build
246 with dgit too (eg with dgit sbuild): some existing build tools pass
247 unhelpful options to dpkg-source et al by default, which can result in
248 the built source package not being identical to the git tree.
250 In more detail: dgit push checks that the current HEAD corresponds to
251 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
252 adjusts the .changes to include any .origs which the archive lacks
253 and exclude .origs which the archive has
254 (so \-sa and \-sd are not needed when building for dgit push),
255 makes a signed git tag, edits the .dsc to contain the dgit metadata
256 field, runs debsign to sign the upload (.dsc and .changes), pushes the
257 signed tag, and finally uses dput to upload the .changes to the
258 archive.
260 dgit push always uses the package, suite and version specified in the
261 debian/changelog and the .dsc, which must agree.  If the command line
262 specifies a suite then that must match too.
264 When used on a git-debrebase branch,
265 dgit calls git-debrebase
266 to prepare the branch
267 for source package upload and push.
268 .TP
269 \fBdgit push-source\fR [\fIsuite\fP]
270 Without \fB\-C\fR, builds a source package and dgit pushes it.  Saying
271 \fBdgit push-source\fR is like saying "update the source code in the
272 archive to match my git HEAD, and let the autobuilders do the rest."
274 With \fB\-C\fR, performs a dgit push, additionally ensuring that no
275 binary packages are uploaded.
276 .TP
277 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
278 Pushes the contents of the specified directory on a remote machine.
279 This is like running dgit push on build-host with build-dir as the
280 current directory; however, signing operations are done on the
281 invoking host.  This allows you to do a push when the system which has
282 the source code and the build outputs has no access to the key:
284 .TS
285 l l.
286 1.      Clone on build host (dgit clone)
287 2.      Edit code on build host (edit, git commit)
288 3.      Build package on build host (dgit build)
289 4.      Test package on build host or elsewhere (dpkg \-i, test)
290 5.      Upload by invoking dgit rpush on host with your GPG key.
291 .TE
293 However, the build-host must be able to ssh to the dgit repos.  If
294 this is not already the case, you must organise it separately, for
295 example by the use of ssh agent forwarding.
297 The remaining arguments are treated just as dgit push would handle
298 them.
300 build-host and build\-dir can be passed as separate
301 arguments; this is assumed to be the case if the first argument
302 contains no : (except perhaps one in [ ], to support IPv6 address
303 literals).
305 You will need similar enough versions of dgit on the build-host and
306 the invocation host.  The build-host needs gnupg installed, with your
307 public key in its keyring (but not your private key, obviously).
308 .TP
309 .B dgit setup-new-tree
310 Configure the current working tree the way that dgit clone would have
311 set it up.  Like running
312 .BR "dgit setup-useremail" ,
313 .B setup-mergechangelogs
314 and
315 .B setup-gitattributes
316 (but only does each thing if dgit is configured to do it automatically).
317 You can use these in any git repository, not just ones used with
318 the other dgit operations.
319 Does
320 .B not
321 run
322 .B update-vcs-git
323 (as that requires Debian packaging information).
324 .TP
325 .B dgit setup-useremail
326 Set the working tree's and from the
327 distro-specific dgit configuration
328 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
330 .TP
331 .B dgit setup-mergechangelogs
332 Configures a git merge helper for the file
333 .B debian/changelog
334 which uses
335 .BR dpkg-mergechangelogs .
336 .TP
337 .B dgit setup-gitattributes
338 Set up the working tree's
339 .B .git/info/attributes
340 to disable all transforming attributes for all files.
341 This is done by defining a macro attribute,
342 .B dgit-defuse-attrs,
343 and applying it to
344 .BR * .
345 For why, see
347 in
348 .BR dgit(7) .
349 Note that only attributes affecting the working tree are suppressed.
350 git-archive may remain exciting.
352 If there is an existing macro attribute line
353 .B [attr]dgit-defuse-attrs
354 in .git/info/attributes,
355 but it is insufficient,
356 because it was made by an earlier version of dgit
357 and git has since introduced new transforming attributes,
358 this modifies the macro to disable the newer transformations.
360 (If there is already a macro attribute line
361 .B [attr]dgit-defuse-attrs
362 in .git/info/attributes
363 which does what dgit requires
364 (whatever files it effects),
365 this operation does nothing further.
366 This fact can be used to defeat or partially defeat
367 dgit setup-gitattributes
368 and hence
369 dgit setup-new-tree.)
370 .TP
371 .B dgit quilt-fixup
372 `3.0 (quilt)' format source packages need changes representing not
373 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
374 checks whether this has been done; if not, dgit will make appropriate
375 patches in debian/patches and also commit the resulting changes to
376 git.
378 This is normally done automatically by dgit build and dgit push.
380 dgit will try to turn each relevant commit in your git history into a
381 new quilt patch.  dgit cannot convert nontrivial merges, or certain
382 other kinds of more exotic history.  If dgit can't find a suitable
383 linearisation of your history, by default it will fail, but you can
384 ask it to generate a single squashed patch instead.
386 When used with a git-debrebase branch,
387 dgit will ask git-debrebase to prepare patches.
388 However,
389 dgit can make patches in some situations where git-debrebase fails,
390 so dgit quilt-fixup can be useful in its own right.
391 To always use dgit's own patch generator
392 instead of git-debrebase make-patches,
393 pass \-\-git-debrebase=true to dgit.
395 See
396 .B FORMAT 3.0 (QUILT)
397 in
398 .BR dgit(7) .
399 .TP
400 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
401 Import a Debian-format source package,
402 specified by its .dsc,
403 into git,
404 the way dgit fetch would do.
406 This does about half the work of dgit fetch:
407 it will convert the .dsc into a new, orphan git branch.
408 Since dgit has no access to a corresponding source package archive
409 or knowledge of the history
410 it does not consider whether this version is newer
411 than any previous import
412 or corresponding git branches;
413 and it therefore does not
414 make a pseudomerge to bind the import
415 into any existing git history.
417 Because a .dsc can contain a Dgit field naming a git commit
418 (which you might not have),
419 and specifying where to find that commit
420 (and any history rewrite table),
421 import-dsc might need online access.
422 If this is a problem
423 (or dgit's efforts to find the commit fail),
424 consider \-\-no-chase-dsc-distro
425 or \-\-force-import-dsc-with-dgit-field.
427 There is only one sub-option:
429 .B \-\-require-valid-signature
430 causes dgit to insist that the signature on the .dsc is valid
431 (using the same criteria as dpkg-source \-x).
432 Otherwise, dgit tries to verify the signature but
433 the outcome is reported only as messages to stderr.
435 If
436 .I branch
437 is prefixed with
438 .B +
439 then if it already exists, it will be simply overwritten,
440 no matter its existing contents.
441 If
442 .I branch
443 is prefixed with
444 .B ..
445 then if it already exists
446 and dgit actually imports the dsc
447 (rather than simply reading the git commit out of the Dgit field),
448 dgit will make a pseudomerge
449 so that the result is necessarily fast forward
450 from the existing branch.
451 Otherwise, if \fIbranch\fR already exists,
452 dgit will stop with an error message.
454 If
455 .I branch
456 does not start with refs/, refs/heads/ is prepended.
457 .TP
458 .B dgit version
459 Prints version information and exits.
460 .TP
461 .BI "dgit clone-dgit-repos-server" " destdir"
462 Tries to fetch a copy of the source code for the dgit-repos-server,
463 as actually being used on the dgit git server, as a git tree.
464 .TP
465 .BI "dgit print-dgit-repos-server-source-url"
466 Prints the url used by dgit clone-dgit-repos-server.
467 This is hopefully suitable for use as a git remote url.
468 It may not be useable in a browser.
469 .TP
470 .BI "dgit print-dpkg-source-ignores"
471 Prints the \-i and \-I arguments which must be passed to dpkg-souce
472 to cause it to exclude exactly the .git directory
473 and nothing else.
474 The separate arguments are unquoted, separated by spaces,
475 and do not contain spaces.
476 .TP
477 .B dgit print-unapplied-treeish
478 Constructs a tree-ish approximating the patches-unapplied state
479 of your 3.0 (quilt) package,
480 and prints the git object name to stdout.
481 This requires appropriate .orig tarballs.
482 This tree object is identical to your .origs
483 as regards upstream files.
484 The contents of the debian subdirectory is not interesting
485 and should not be inspected;
486 except that debian/patches will be identical to your HEAD.
488 To make this operate off-line,
489 the access configuration key
490 which is used to determine the build-products-dir
491 is the uncanonicalised version of the suite name from the changelog,
492 or (of course)
495 This function is primarily provided for the benefit of git-debrebase.
497 .TP
498 .BR \-\-dry-run " | " \-n
499 Go through the motions, fetching all information needed, but do not
500 actually update the output(s).  For push, dgit does
501 the required checks and leaves the new .dsc in a temporary file,
502 but does not sign, tag, push or upload.
503 .TP
504 .BR \-\-damp-run " | " \-L
505 Go through many more of the motions: do everything that doesn't
506 involve either signing things, or making changes on the public
507 servers.
508 .TP
509 .BI \-k keyid
510 Use
511 .I keyid
512 for signing the tag and the upload.  The default comes from the
513 distro's
514 .B keyid
515 config setting (see CONFIGURATION, below), or failing that, the
516 uploader trailer line in debian/changelog.
517 .TP
518 .BR --no-sign
519 does not sign tags or uploads (meaningful only with push).
520 .TP
521 .TP
522 .BI -p package
523 Specifies that we should process source package
524 .I package
525 rather than looking in debian/control or debian/changelog.
526 Valid with dgit fetch and dgit pull, only.
527 .TP
528 .BR --clean=git " | " -wg
529 Use
530 .BR "git clean -xdf"
531 to clean the working tree,
532 rather than running the package's rules clean target.
534 This will delete all files which are not tracked by git.
535 (Including any files you forgot to git add.)
537 .BI --clean= ...
538 options other than dpkg-source
539 are useful when the package's clean target is troublesome, or
540 to avoid needing the build-dependencies.
542 dgit will only actually clean the tree if it needs to
543 (because it needs to build the source package
544 or binaries from your working tree).
545 Otherwise
546 it will just check that there are no untracked unignored files.
547 See --clean=git[-ff],always, below.
548 .TP
549 .BR --clean=git-ff " | " -wgf
550 Use
551 .BR "git clean -xdff"
552 to clean the working tree.
553 Like
554 git clean -xdf
555 but it also removes any subdirectories containing different git
556 trees (which only unusual packages are likely to create).
557 .TP
558 .BR --clean=git "[" -ff "]" ,always " | " -wga " | " -wgfa
559 Like --clean=git, but always does the clean and not just a check,
560 deleting any untracked un-ignored files.
561 .TP
562 .BR --clean=check " | " --clean=check,ignores " | " -wc " | " -wci
563 Merely check that the tree is clean (does not contain uncommitted
564 files).
565 Avoids running rules clean,
566 and can avoid needing the build-dependencies.
568 With
569 .BR ,ignores
570 or
571 .BR \-wci ,
572 untracked files covered by .gitignore are tolerated,
573 so only files which show up as
574 .B ?
575 in git status
576 (ie, ones you maybe forgot to git add)
577 are treated as a problem.
578 .TP
579 .BR \-\-clean=none " | " \-wn
580 Do not clean the tree, nor check that it is clean.
581 Avoids running rules clean,
582 and can avoid needing the build-dependencies.
583 If there are
584 files which are not in git, or if the build creates such files, a
585 subsequent dgit push will fail.
586 .TP
587 .BR --clean=dpkg-source "[" -d "] | " -wd " | " -wdd
588 Use dpkg-buildpackage to do the clean, so that the source package
589 is cleaned by dpkg-source running the package's clean target.
590 --clean=dpkg-source is the default.
592 Without the extra
593 .BR d ,
594 requires the package's build dependencies.
596 With
597 .BR ... -d
598 or
599 .BR -wdd ,
600 the build-dependencies are not checked
601 (due to passing
602 .BR -d
603 to dpkg-buildpackage),
604 which violates policy, but may work in practice.
606 The rules clean target will only be run if it is needed:
607 when dgit is going to build source or binary packages
608 from your working tree,
609 rather than from your git branch
610 (for example because of \-\-include-dirty
611 or because the binary package build uses your working tree).
613 In all cases,
614 dgit will check that there are (after rules clean, if applicable) no
615 untracked un-ignored files,
616 in case these are files you forgot to git add.
617 (Except that this check is not done
618 for a `3.0 (quilt)' package
619 when dgit has to apply patches, dirtily, to the working tree.)
620 If your package does not have a good .gitignore
621 you will probably need --clean=dpkg-source,no-check aka -wdn.
622 .TP
623 .BR --clean=dpkg-source "[" -d "]" ,no-check " | " -wdn " | " -wddn
624 Like --clean=dpkg-source, but
625 does not care about untracked un-ignored files.
626 .TP
627 .BR --clean=dpkg-source "[" -d "]" ,all-check " | " -wda " | " -wdda
628 Like --clean=dpkg-source, but
629 fails even on ignored untracked files.
630 This could perhaps be used to detect bugs in your rules clean target.
631 .TP
632 .BR -N " | " --new
633 The package is or may be new in this suite.  Without this, dgit will
634 refuse to push.
635 It may (for Debian, will) be unable to access the git
636 history for any packages which have been newly pushed and have not yet
637 been published.
638 .TP
639 .BR --include-dirty
640 Do not complain if the working tree does not match your git HEAD,
641 and when building,
642 include the changes from your working tree.
643 This can be useful with build, if you plan to commit later.  (dgit
644 push will still ensure that the .dsc you upload and the git tree
645 you push are identical, so this option won't make broken pushes.)
647 Note that this does
648 .BR not
649 prevent dgit from cleaning your tree, so if the changes in your
650 working tree are in the form of untracked files, those might still be
651 deleted, especially with --clean=git.
652 If you want to include untracked files in the build, you can
653 use --clean=none or --clean=dpkg-source[-d]
654 in addition to --include-dirty.
655 Note that this
656 combination can fail if the untracked files are under
657 \fIdebian/patches/\fR.
658 .TP
659 .BR --ignore-dirty
660 Deprecated alias for --include-dirty.
661 .TP
662 .BR --overwrite [=\fIprevious-version\fR]
663 Declare that your HEAD really does contain
664 all the (wanted) changes
665 from all versions listed in its changelog;
666 or, all (wanted) changes from
667 .IR previous-version .
668 This promise is needed when
669 your git branch is not a descendant
670 of the version in the archive
671 according to the git revision history.
673 It is safer not to specify
674 .IR previous-version ,
675 and usually it's not needed.
676 Just say
677 .BR \-\-overwrite ,
678 unless you know what you are doing.
680 This option is useful if you are the maintainer, and you have
681 incorporated NMU changes into your own git workflow in a way that
682 doesn't make your branch a fast forward from the NMU.
683 It can also be useful when an intermediate upload was not done with dgit.
685 This option is also usually necessary
686 the first time a package is pushed with dgit push
687 to a particular suite.
688 See
689 .BR dgit-maint- \fI*\fR (7) .
691 If
692 .I previous-version
693 is not
694 specified, dgit will check that the version in the archive is
695 mentioned in your debian/changelog.
696 (This will avoid losing
697 changes, even with
698 .BR --overwrite ,
699 unless someone committed to git a finalised changelog
700 entry, and then made later changes to that version.)
701 If
702 .IR previous-version
703 is specified, it ought to be the version currently in the archive.
705 dgit push --overwrite
706 will, if necessary, make a
707 pseudo-merge (that is, something that looks like the result
708 of git merge -s ours) to stitch the archive's version into your own
709 git history, so that your push is a fast forward from the archive.
711 (In quilt mode
712 .BR gbp ", " dpm ", " unpatched " or " baredebian *,
713 implying a split between the dgit view and the
714 maintainer view, the pseudo-merge will appear only in the dgit view.)
715 .TP
716 .BR \-\-delayed =\fIdays\fR
717 Upload to a DELAYED queue.
720 If the maintainer responds by cancelling
721 your upload from the queue,
722 and does not make an upload of their own,
723 this will not rewind the git branch on the dgit git server.
724 Other dgit users will then see your push
725 (with a warning message from dgit)
726 even though the maintainer wanted to abolish it.
727 Such users might unwittingly reintroduce your changes.
729 If this situation arises,
730 someone should make a suitable dgit push
731 to update the contents of dgit-repos
732 to a version without the controversial changes.
733 .TP
734 .BR --no-chase-dsc-distro
735 Tells dgit not to look online
736 for additional git repositories
737 containing information about a particular .dsc being imported.
738 Chasing is the default.
740 For most operations
741 (such as fetch and pull),
742 disabling chasing
743 means dgit will access only the git server
744 for the distro you are directly working with,
745 even if the .dsc was copied verbatim from another distro.
746 For import-dsc,
747 disabling chasing
748 means dgit will work completely offline.
750 Disabling chasing can be hazardous:
751 if the .dsc names a git commit which has been rewritten
752 by those in charge of the distro,
753 this option may prevent that rewrite from being effective.
754 Also,
755 it can mean that
756 dgit fails to find necessary git commits.
757 .TP
758 .BR \-\-save-dgit-view= \fIbranch\fR|\fIref\fR
759 Specifies that when split view is in operation,
760 and dgit calculates
761 (or looks up in its cache)
762 a dgit view corresponding to your HEAD,
763 the dgit view will be left in
764 .IR ref .
765 The specified ref is unconditionally overwritten,
766 so don't specify a branch you want to keep.
768 This option is effective only with the following operations:
769 quilt-fixup; push; all builds.
770 And it is only effective when split view is actually in operation.
772 If ref does not start with refs/
773 it is taken to be a branch -
774 i.e. refs/heads/ is prepended.
776 .B \-\-dgit-view-save
777 is a deprecated alias for
778 \-\-save-dgit-view.
779 .TP
780 .BI \-\-deliberately- something
781 Declare that you are deliberately doing
782 .IR something .
783 This can be used to override safety catches, including safety catches
784 which relate to distro-specific policies.
785 The use of \-\-deliberately is declared and published in the signed tags
786 generated for you by dgit,
787 so that the archive software can give effect to your intent,
788 and
789 for the benefit of humans looking at the history.
790 The meanings of
791 .IR something s
792 understood in the context of Debian are discussed below:
793 .TP
794 .BR --deliberately-not-fast-forward
795 Declare that you are deliberately rewinding history.
796 This could be because your branch is not fast forward from the
797 dgit server history,
798 or not fast forward from a locally-synthesised dsc import.
800 When pushing to Debian,
801 use this only when you are making a renewed upload of an entirely
802 new source package whose previous version was not accepted for release
803 from NEW because of problems with copyright or redistributibility;
804 or, exceptionally, for the very first upload with dgit.
806 When split view is in operation,
807 this also prevents the construction by dgit of a pseudomerge
808 to make the dgit view fast forwarding.
809 Normally only one of
810 --overwrite (which creates a suitable pseudomerge)
811 and
812 --deliberately-not-fast-forward
813 (which suppresses the pseudomerge and the fast forward checks)
814 should be needed;
815 --overwrite is usually better.
816 .TP
817 .BR --deliberately-include-questionable-history
818 Declare that you are deliberately including, in the git history of
819 your current push, history which contains a previously-submitted
820 version of this package which was not approved (or has not yet been
821 approved) by the ftpmasters.  When pushing to Debian, only use this
822 option after verifying that: none of the rejected-from-NEW (or
823 never-accepted) versions in the git history of your current push, were
824 rejected by ftpmaster for copyright or redistributability reasons.
825 .TP
826 .BR --deliberately-fresh-repo
827 Declare that you are deliberately rewinding history and want to
828 throw away the existing repo.  Not relevant when pushing to Debian,
829 as the Debian server will do this automatically when necessary.
830 .TP
831 .BR --quilt=linear
832 When fixing up source format `3.0 (quilt)' metadata, insist on
833 generating a linear patch stack: one new patch for each relevant
834 commit.
835 If such a stack cannot be generated, fail.
836 This is the default for Debian.
838 HEAD should be a series of plain commits
839 (not touching debian/patches/),
840 and pseudomerges,
841 with as ancestor a patches-applied branch.
842 .TP
843 .BR --quilt=auto
844 When fixing up source format `3.0 (quilt)' metadata, prefer to
845 generate a linear patch stack
846 (as with --quilt=linear)
847 but if that doesn't seem possible,
848 try to generate a single squashed patch for all the changes made in git
849 (as with --quilt=smash).
850 This is not a good idea for an NMU in Debian.
851 .TP
852 .BR --quilt=smash
853 When fixing up source format `3.0 (quilt)' metadata,
854 generate a single additional patch for all the changes made in git.
855 This is not a good idea for an NMU in Debian.
857 (If HEAD has any in-tree patches already, they must apply cleanly.
858 This will be the case for any trees produced by dgit fetch or clone;
859 if you do not change the upstream version
860 nor make changes in debian/patches,
861 it will remain true.)
862 .TP
863 .BR --quilt=nofix
864 Check whether source format `3.0 (quilt)' metadata would need fixing
865 up, but, if it does, fail.  You must then fix the metadata yourself
866 somehow before pushing.  (NB that dpkg-source --commit will not work
867 because the dgit git tree does not have a
868 .B .pc
869 directory.)
870 .TP
871 .BR --quilt=nocheck " | " --no-quilt-fixup
872 Do not check whether source format `3.0 (quilt)' metadata needs
873 fixing up.  If you use this option and the metadata did in fact need
874 fixing up, dgit push will fail.
875 .TP
876 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied " | " -- [ quilt= ] baredebian [ +git | +tarball ]
877 Tell dgit that you are using a nearly-dgit-compatible git branch,
878 aka a
879 .BR "maintainer view" ,
880 and
881 do not want your branch changed by dgit.
883 These quilt modes are known as
884 .BR "splitting quilt modes" .
885 See --split-view, below.
887 .B --gbp
888 (short for
889 .BR --quilt=gbp )
890 is for use with git-buildpackage.
891 Your HEAD is expected to be
892 a patches-unapplied git branch, except that it might contain changes
893 to upstream .gitignore files.  This is the default for dgit gbp-build.
895 .B --dpm
896 (short for
897 .BR --quilt=dpm )
898 is for use with git-dpm.
899 Your HEAD is expected to be
900 a patches-applied git branch,
901 except that it might contain changes to upstream .gitignore files.
903 .B --quilt=unapplied
904 specifies that your HEAD is a patches-unapplied git branch (and
905 that any changes to upstream .gitignore files are represented as
906 patches in debian/patches).
908 .B --quilt=baredebian
909 (or its alias
910 .BR --quilt=baredebian+git )
911 specifies that your HEAD contains only a debian/ directory,
912 with any changes to upstream files represented as
913 patches in debian/patches.
914 The upstream source must be available in git,
915 by default, in a suitably named git tag;
916 see --upstream-commitish.
917 In this mode, dgit cannot check that
918 all edited upstream files are properly represented as patches:
919 dgit relies on
920 debian/patches being correct.
922 .B --quilt=baredebian+tarball
923 is like --quilt=baredebian,
924 but is used when there is no appropriate upstream git history.
925 To construct the dgit view,
926 dgit will import your orig tarballs' contents into git.
927 In this mode, dgit cannot check that
928 the upstream parts of your upload correspond to what you intend:
929 dgit relies on
930 the right orig tarball(s) existing, and
931 debian/patches being correct.
933 With --quilt=gbp|dpm|unapplied|baredebian*,
934 dgit push (or precursors like quilt-fixup and build) will automatically
935 generate a conversion of your git branch into the right form.
936 dgit push will push the
937 dgit-compatible form (the
938 .BR "dgit view" )
939 to the dgit git server.
940 The dgit view will be visible to you
941 in the dgit remote tracking branches, but your own branch will
942 not be modified.
943 dgit push will create a tag
944 .BI debian/ version
945 for the maintainer view, and the dgit tag
946 .BI archive/debian/ version
947 for the dgit view.
948 dgit quilt-fixup will merely do some checks,
949 and cache the maintainer view.
951 .B If you have a branch like this it is essential to specify the appropriate \-\-quilt= option!
952 This is because it is not always possible to tell: a patches-unapplied
953 git branch of a package with one patch, for example, looks very like
954 a patches-applied branch where the user has used git revert to
955 undo the patch, expecting to actually revert it.
956 However, if you fail to specify the right \-\-quilt option,
957 and you aren't too lucky, dgit will notice the problem and stop,
958 with a useful hint.
959 .TP
960 .BR \-d "\fIdistro\fR | " \-\-distro= \fIdistro\fR
961 Specifies that the suite to be operated on is part of distro
962 .IR distro .
963 This overrides the default value found from the git config option
964 .BR dgit-suite. \fIsuite\fR .distro .
965 The only effect is that other configuration variables (used
966 for accessing the archive and dgit-repos) used are
967 .BR dgit-distro. \fIdistro\fR .* .
969 If your suite is part of a distro that dgit already knows about, you
970 can use this option to make dgit work even if your dgit doesn't know
971 about the suite.  For example, specifying
972 .B \-ddebian
973 will work when the suite is an unknown suite in the Debian archive.
975 To define a new distro it is necessary to define methods and URLs
976 for fetching (and, for dgit push, altering) a variety of information both
977 in the archive and in dgit-repos.
978 How to set this up is not yet documented.
979 .TP
980 .BR \-\-split-view=auto | always | never
981 Controls whether dgit operates a split view,
982 separating your own branch (as Debian maintainer)
983 from that shown to users of dgit clone and dgit fetch.
985 When split view is in operation
986 dgit will not make or merge any commits onto your own branch.
987 Specifically, only the dgit view will contain
988 dgit's pseudomerges,
989 which bring into the git history previous uploads made with dgit push,
990 and any commits in debian/patches required
991 to make a correct `3.0 (quilt)' source package.
993 .B auto
994 is the default, and splits the view only when needed:
995 i.e., when you are working with a `3.0 (quilt)' source package
996 and a splitting quilt mode:
997 \-\-[quilt=]gbp, dpm, unpatched or baredebian*.
999 .B always
1000 splits the view regardless of the source format and the quilt mode.
1002 .B never
1003 will cause dgit to fail if split view is needed.
1005 When split view is in operation, the dgit view is visible
1006 in your local git clone,
1007 but only in refs specific to dgit:
1008 notably
1009 .BI remotes/dgit/dgit/ suite
1010 and
1011 .BR archive/ \fIdistro\fR / \fIversion\fR.
1013 Note that split view does not affect dgit fetch,
1014 and is not compatible with dgit pull.
1015 .TP
1016 .BI \-C changesfile
1017 Specifies the .changes file which is to be uploaded.  By default
1018 dgit push looks for a single .changes file in the parent directory whose
1019 filename suggests it is for the right package and version.
1021 If the specified
1022 .I changesfile
1023 pathname contains slashes, the directory part is also used as
1024 the value for
1025 .BR \-\-build-products-dir ;
1026 otherwise, the changes file is expected in that directory (by
1027 default, in
1028 .BR .. ).
1029 .TP
1030 .BI \-\-upstream-commitish= upstream
1031 For use with --quilt=baredebian only.
1032 Specifies the commit containing the upstream source.
1033 This commit must be identical to your .orig tarball.
1034 The default is to look for one of the git tags
1035 .IB U " v" U " upstream/" U
1036 (in that order), where U is the upstream version.
1037 .TP
1038 .B \-\-rm-old-changes
1039 When doing a build, delete any changes files matching
1040 .IB package _ version _*.changes
1041 before starting.  This ensures that
1042 dgit push (and dgit sbuild) will be able to unambiguously
1043 identify the relevant changes files from the most recent build, even
1044 if there have been previous builds with different tools or options.
1045 The default is not to remove, but
1046 .B \-\-no-rm-old-changes
1047 can be used to override a previous \-\-rm-old-changes
1048 or the .rm-old-changes configuration setting.
1050 Note that \fBdgit push-source\fR will always find the right .changes,
1051 regardless of this option.
1052 .TP
1053 .BI \-\-build-products-dir= directory
1054 Specifies where to find and create tarballs, binary packages,
1055 source packages, .changes files, and so on.
1057 By default, dgit uses the parent directory
1058 .RB ( .. ).
1060 Changing this setting may necessitate
1061 moving .orig tarballs to the new directory,
1062 so it is probably best to
1063 use the
1064 .BI
1065 configuration setting
1066 (see CONFIGURATION, below)
1067 which this command line option overrides).
1068 .TP
1069 .BI --no-rm-on-error
1070 Do not delete the destination directory if clone fails.
1071 .TP
1072 .BI --dep14tag
1073 Generates a DEP-14 tag (eg
1074 .BR debian/ \fIversion\fR)
1075 as well as a dgit tag (eg
1076 .BR archive/debian/ \fIversion\fR).
1077 This is the default.
1078 .TP
1079 .BI --no-dep14tag
1080 Do not generate a DEP-14 tag, except when split view is in operation.
1081 .TP
1082 .BI --always-dep14tag
1083 Obsolete alias for --dep14tag, retained for compatibility.
1084 .TP
1085 .BI -D
1086 Prints debugging information to stderr.  Repeating the option produces
1087 more output (currently, up to -DDDD is meaningfully different).
1088 .TP
1089 .BI -c name = value
1090 Specifies a git configuration option, to be used for this run.
1091 dgit itself is also controlled by git configuration options.
1092 .TP
1093 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
1094 Specifies the
1095 .BI -v version
1096 option to pass to dpkg-genchanges, during builds.  Changes (from
1097 debian/changelog) since this version will be included in the built
1098 changes file, and hence in the upload.  If this option is not
1099 specified, dgit will query the archive and use the latest version
1100 uploaded to the intended suite.
1102 Specifying
1103 .B _
1104 inhibits this, so that no -v option will be passed to dpkg-genchanges
1105 (and as a result, only the last stanza from debian/changelog will
1106 be used for the build and upload).
1107 .TP
1108 .RI \fB-m\fR maintaineraddress
1109 Passed to dpkg-genchanges (eventually).
1110 .TP
1111 .RI \fB--ch:\fR option
1112 Specifies a single additional option to pass, eventually, to
1113 dpkg-genchanges.
1115 Options which are safe to pass include
1116 .BR -C
1117 (and also
1118 .BR "-si -sa -sd"
1119 although these should never be necessary with Debian since dgit
1120 automatically calculates whether .origs need to be uploaded.)
1122 For other options the caveat below applies.
1123 .TP
1124 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
1125 Specifies a single additional option to pass to
1126 .BR curl ,
1127 .BR dput ,
1128 .BR debsign ,
1129 .BR dpkg-source ,
1130 .BR dpkg-buildpackage ,
1131 .BR dpkg-genchanges ,
1132 .BR sbuild ,
1133 .BR pbuilder ,
1134 .BR cowbuilder ,
1135 .BR ssh ,
1136 .BR dgit ,
1137 .BR git-debrebase ,
1138 .BR apt-get ,
1139 .BR apt-cache ,
1140 .BR gbp-pq ,
1141 .BR gbp-build ,
1142 or
1143 .BR mergechanges .
1144 Can be repeated as necessary.
1146 Use of this ability should not normally be necessary.
1147 It is provided for working around bugs,
1148 or other unusual situations.
1149 If you use these options,
1150 you may violate dgit's assumptions
1151 about the behaviour of its subprograms
1152 and cause lossage.
1154 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
1155 the option applies only when the program is invoked directly by dgit.
1156 Usually, for passing options to dpkg-genchanges, you should use
1157 .BR \-\-ch: \fIoption\fR.
1159 Specifying \-\-git is not effective for some lower-level read-only git
1160 operations performed by dgit, and also not when git is invoked by
1161 another program run by dgit.
1163 See notes below regarding ssh and dgit.
1165 NB that \-\-gpg:option is not supported (because debsign does not
1166 have that facility).
1167 But see
1168 .B \-k
1169 and the
1170 .B keyid
1171 distro config setting.
1172 .TP
1173 .RI \fB\-\-curl!:\fR option " | \fB\-\-dput!:\fR" option " |..."
1174 Specifies an option to remove from the command line for
1175 a program called by dgit, as for
1176 \fB\-\-\fR\fIprogram\fI\fB:\fR\fIoption\fR
1177 (and the same caveats apply).
1179 Any options or arguments exactly identical to
1180 .I option
1181 are removed.
1182 (It is not an error if there were none.)
1184 This can only be used to delete options
1185 which are always passed by default by dgit,
1186 or to undo a previous
1187 \fB\-\-\fR\fIprogram\fI\fB:\fR\fIoption\fR.
1188 It cannot be used to override option(s) dynamically
1189 decided on by dgit.
1190 .TP
1191 .RI \fB\-\-curl=\fR program " | \fB\-\-dput=\fR" program  " |..."
1192 Specifies alternative programs to use instead of
1193 .BR curl ,
1194 .BR dput ,
1195 .BR debsign ,
1196 .BR dpkg-source ,
1197 .BR dpkg-buildpackage ,
1198 .BR dpkg-genchanges ,
1199 .BR sbuild ,
1200 .BR pbuilder ,
1201 .BR cowbuilder ,
1202 .BR gpg ,
1203 .BR ssh ,
1204 .BR dgit ,
1205 .BR git-debrebase ,
1206 .BR apt-get ,
1207 .BR apt-cache ,
1208 .BR git ,
1209 .BR gbp-pq ,
1210 .BR gbp-build ,
1211 or
1212 .BR mergechanges .
1214 For
1215 .BR dpkg-buildpackage ,
1216 .BR dpkg-genchanges ,
1217 .B mergechanges
1218 and
1219 .BR sbuild ,
1220 this applies only when the program is invoked directly by dgit.
1222 For
1223 .BR dgit ,
1224 specifies the command to run on the remote host when dgit
1225 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
1226 itself as the EDITOR for dpkg-source \-\-commit; this is done using
1227 argv[0], and is not affected by \-\-dgit=).
1229 .BR gbp-build 's
1230 value
1231 is used instead of gbp build or git-buildpackage.  (The default is
1232 the latter unless the former exists on PATH.)
1233 .BR gbp-pq 's
1234 value
1235 is used instead of gbp pq.
1236 In both cases,
1237 unusually, the specified value is split on whitespace
1238 to produce a command and possibly some options and/or arguments.
1240 For pbuilder and cowbuilder, the defaults are
1241 .BR "sudo -E pbuilder"
1242 and
1243 .BR "sudo -E cowbuilder"
1244 respectively.
1245 Like with gbp-build and gbp pq,
1246 the specified value is split on whitespace.
1248 For
1249 .BR ssh ,
1250 the default value is taken from the
1251 .B DGIT_SSH
1252 or
1253 .B GIT_SSH
1254 environment variables, if set (see below).  And, for ssh, when accessing the
1255 archive and dgit-repos, this command line setting is overridden by the
1256 git config variables
1257 .BI dgit-distro. distro .ssh
1258 and
1259 .B .dgit.default.ssh
1260 (which can in turn be overridden with \-c).  Also, when dgit is using
1261 git to access dgit-repos, only git's idea of what ssh to use (eg,
1262 .BR GIT_SSH )
1263 is relevant.
1264 .TP
1265 .BI \-\-existing-package= package
1266 dgit push needs to canonicalise the suite name.  Sometimes, dgit
1267 lacks a way to ask the archive to do this without knowing the
1268 name of an existing package.  Without \-\-new we can just use the
1269 package we are trying to push.  But with \-\-new that will not work, so
1270 we guess
1271 .B dpkg
1272 or use the value of this option.  This option is not needed with the
1273 default mechanisms for accessing the archive.
1274 .TP
1275 .BR \-h | \-\-help
1276 Print a usage summary.
1277 .TP
1278 .BI \-\-initiator-tempdir= directory
1279 dgit rpush uses a temporary directory on the invoking (signing) host.
1280 This option causes dgit to use
1281 .I directory
1282 instead.  Furthermore, the specified directory will be emptied,
1283 removed and recreated before dgit starts, rather than removed
1284 after dgit finishes.  The directory specified must be an absolute
1285 pathname.
1286 .TP
1287 .BI \-\-force- something
1288 Instructs dgit to try to proceed despite detecting
1289 what it thinks is going to be a fatal problem.
1290 .B This is probably not going to work.
1291 These options are provided as an escape hatch,
1292 in case dgit is confused.
1293 (They might also be useful for testing error cases.)
1294 .TP
1295 .B \-\-force-import-dsc-with-dgit-field
1296 Tell dgit import-dsc to treat a .dsc with a Dgit field
1297 like one without it.
1298 The result is a fresh import,
1299 discarding the git history
1300 that the person who pushed that .dsc was working with.
1301 .TP
1302 .B \-\-force-reusing-version
1303 Carry on even though this involves reusing a version number
1304 of a previous push or upload.
1305 It is normally best to give different versions different numbers.
1306 Some servers (including, usually, the Debian server)
1307 will reject attempts to reuse or replace already-pushed versions.
1308 .TP
1309 .B \-\-force-uploading-binaries
1310 Carry on and
1311 upload binaries
1312 even though dgit thinks your distro does not permit that.
1313 .TP
1314 .B \-\-force-uploading-source-only
1315 Carry on and do a source-only upload,
1316 without any binaries,
1317 even though dgit thinks your distro does not permit that,
1318 or does not permit that in this situation.
1319 .TP
1320 .B \-\-force-unrepresentable
1321 Carry on even if
1322 dgit thinks that your git tree contains changes
1323 (relative to your .orig tarballs)
1324 which dpkg-source is not able to represent.
1325 Your build or push will probably fail later.
1326 .TP
1327 .B \-\-force-changes-origs-exactly
1328 Use the set of .origs specified in your .changes, exactly,
1329 without regard to what is in the archive already.
1330 The archive may well reject your upload.
1331 .TP
1332 .B \-\-force-unsupported-source-format
1333 Carry on despite dgit not understanding your source package format.
1334 dgit will probably mishandle it.
1335 .TP
1336 .B \-\-force-dsc-changes-mismatch
1337 Do not check whether .dsc and .changes match.
1338 The archive will probably reject your upload.
1339 .TP
1340 .BR \-\-force-import-gitapply-absurd " | " \-\-force-import-gitapply-no-absurd
1341 Force on or off the use of the absurd git-apply emulation
1342 when running gbp pq import
1343 when importing a package from a .dsc.
1344 See Debian bug #841867.
1345 .TP
1346 .BR \-\-for\-push
1347 Override the dgit-distro.distro.readonly configuration setting,
1348 to specify that we have read/write access
1349 and should use the corresponding git and achieve access approach
1350 even if the operation is a read-only one.
1352 dgit can be configured via the git config system.
1353 You may set keys with git-config (either in system-global or per-tree
1354 configuration), or provide
1355 .BI -c key = value
1356 on the dgit command line.
1357 .LP
1358 Settings likely to be useful for an end user include:
1359 .TP
1360 .BI
1361 Specifies where to find the built files to be uploaded,
1362 when --build-products-dir is not specified.  The default is
1363 the parent directory
1364 .RB ( .. ).
1365 .TP
1366 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
1367 Specifies the distro for a suite.  dgit keys off the suite name (which
1368 appears in changelogs etc.), and uses that to determine the distro
1369 which is involved.  The config used is thereafter that for the distro.
1371 .I suite
1372 may be a glob pattern.
1373 .TP
1374 .BI dgit.default.distro " distro"
1375 The default distro for an unknown suite.
1377 This is only used if no
1378 .BI /usr/share/distro-info/ somedistro .csv
1379 mentions the specified suite.
1380 .TP
1381 .BI dgit.default.default-suite " suite"
1382 The default suite (eg for clone).
1383 .TP
1384 .BR dgit.default. *
1385 for each
1386 .BR dgit-distro. \fIdistro\fR . *,
1387 the default value used if there is no distro-specific setting.
1388 .TP
1389 .BR dgit-distro. \fIdistro\fR .clean-mode
1390 One of the values for the command line \-\-clean= option; used if
1391 \-\-clean is not specified.
1392 .TP
1393 .BR dgit-distro. \fIdistro\fR .clean-mode-newer
1394 Like .clean-mode,
1395 but ignored if the value is unknown to this version of dgit.
1396 Setting both .clean-mode and .clean-mode-newer is useful
1397 to provide a single git config compatible with different dgit versions.
1398 .TP
1399 .BR dgit-distro. \fIdistro\fR .quilt-mode
1400 One of the values for the command line \-\-quilt= option; used if
1401 \-\-quilt is not specified.
1402 .TP
1403 .BR dgit-distro. \fIdistro\fR .split-view
1404 .TP
1405 .BR dgit-distro. \fIdistro\fR .rm-old-changes
1406 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
1407 is specified.  The default is not to remove.
1408 .TP
1409 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
1410 Whether you have push access to the distro.
1411 For Debian, it is OK to use auto, which uses readonly mode if you are
1412 not pushing right now;
1413 but, setting this to false will avoid relying on the mirror of the dgit
1414 git repository server.
1415 .TP
1416 .BI dgit-distro. distro .keyid
1417 See also
1418 .BR \-k .
1419 .TP
1420 .BI dgit-distro. distro .mirror " url"
1421 .TP
1422 .BI dgit-distro. distro .username
1423 Not relevant for Debian.
1424 .TP
1425 .BI dgit-distro. distro .upload-host
1426 Might be useful if you have an intermediate queue server.
1427 .TP
1428 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
1429 Values to configure for and in new git trees.  If
1430 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
1431 used, respectively.  Only used if .setup-usermail is not disabled.
1432 .TP
1433 .BI dgit-distro. distro .setup-useremail
1434 Whether to set and in new git trees.
1435 True by default.  Ignored for dgit setup-useremail, which does it anyway.
1436 .TP
1437 .BI dgit-distro. distro .setup-mergechangelogs
1438 Whether to set up a merge driver which uses dpkg-mergechangelogs for
1439 debian/changelog.  True by default.  Ignored for dgit
1440 setup-mergechangelogs, which does it anyway.
1441 .TP
1442 .BI dgit-distro. distro .setup-gitattributes
1443 Whether to configure .git/info/attributes
1444 to suppress checkin/checkout file content transformations
1445 in new git trees.
1446 True by default.  Ignored for dgit setup-gitattributes, which does it anyway.
1447 .TP
1448 .BI dgit-distro. distro .cmd- cmd
1449 Program to use instead of
1450 .IR cmd .
1451 Works like
1452 .BR \-\- \fIcmd\fR = "... ."
1453 .TP
1454 .BI dgit-distro. distro .opts- cmd
1455 Extra options to pass to
1456 .IR cmd .
1457 Works like
1458 .BR \-\- \fIcmd\fR : "... ."
1459 To pass several options, configure multiple values in git config
1460 (with git config \-\-add).  The options for
1461 .BI dgit.default.opts- cmd
1462 and
1463 .BI dgit-distro. distro /push.opts- cmd
1464 are all used, followed by options from dgit's command line.
1466 There are many other settings which specify how a particular distro's
1467 services (archive and git) are provided.  These should not normally be
1468 adjusted, but are documented for the benefit of distros who wish to
1469 adopt dgit.
1470 .TP
1471 .BI dgit-distro. distro .nominal-distro
1472 Shown in git tags, Dgit fields, and so on.
1473 .TP
1474 .BI dgit-distro. distro .alias-canon
1475 Used for all access configuration lookup.
1476 .TP
1477 .BR dgit-distro. \fIdistro\fR /push. *
1478 If set, overrides corresponding non \fB/push\fR config when
1479 .BR readonly=false ,
1480 or when pushing and
1481 .BR readonly=auto .
1482 .TP
1483 .BI dgit-distro. distro .git-url
1484 .TP
1485 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1486 .TP
1487 .BI dgit-distro. distro .git-proto
1488 .TP
1489 .BI dgit-distro. distro .git-path
1490 .TP
1491 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1492 .TP
1493 .BI dgit-distro. distro .git-check-suffix
1494 .TP
1495 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1496 .TP
1497 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1498 .TP
1499 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR " " | " aptget:"
1500 .TP
1501 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1502 .TP
1503 .BI dgit-distro. distro .madison-distro
1504 .TP
1505 .BI dgit-distro. distro .archive-query-default-component
1506 .TP
1507 .BI dgit-distro. distro .dgit-tag-format
1508 .TP
1509 .BR dgit-distro. \fIdistro\fR .dep14tag " " want | no [| always ]
1510 .TP
1511 .BI dgit-distro. distro .ssh
1512 .TP
1513 .BI dgit-distro. distro .sshpsql-dbname
1514 .TP
1515 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1516 .TP
1517 .BI dgit-distro. distro .backports-quirk
1518 .TP
1519 .BI dgit-distro. distro .rewrite-map-enable
1520 .TP
1521 .BR dgit-distro. \fIdistro\fR .source-only-uploads " " ok | always | never | not-wholly-new
1522 .TP
1523 .BI dgit.default.old-dsc-distro
1524 .TP
1525 .BI dgit.dsc-url-proto-ok. protocol
1526 .TP
1527 .BI dgit.dsc-url-proto-ok.bad-syntax
1528 .TP
1529 .BI dgit.default.dsc-url-proto-ok
1530 .TP
1531 .BR dgit.vcs-git.suites " \fIsuite\fR[" ; ...]
1533 .TP
1534 .BR DGIT_SSH ", " GIT_SSH
1535 specify an alternative default program (and perhaps arguments) to use
1536 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
1537 if it contains any whitespace will be passed to the shell.  GIT_SSH
1538 specifies just the program; no arguments can be specified, so dgit
1539 interprets it the same way as git does.
1540 See
1541 also the \-\-ssh= and \-\-ssh: options.
1542 .TP
1544 Default git and for new trees.  See
1545 .BR "dgit setup-new-tree" .
1546 .TP
1547 .BR gpg ", " dpkg- "..., " debsign ", " git ", [" lib ] curl ", " dput
1548 and other subprograms and modules used by dgit are affected by various
1549 environment variables.  Consult the documentation for those programs
1550 for details.
1551 .SH BUGS
1552 There should be
1553 a `dgit rebase-prep' command or some such to turn a
1554 fast-forwarding branch containing pseudo-merges
1555 back into a rebasing patch stack.
1556 It might have to leave a note
1557 for a future dgit push.
1559 If the dgit push fails halfway through,
1560 it is not necessarily restartable and
1561 idempotent.
1562 It would be good to check that the proposed signing key is
1563 available before starting work.
1565 dgit's build functions, and dgit push, may make changes to
1566 your current HEAD.  Sadly this is necessary for packages in the `3.0
1567 (quilt)' source format.  This is ultimately due to what I consider
1568 design problems in quilt and dpkg-source.
1570 \-\-dry-run does not always work properly, as not doing some of the git
1571 fetches may result in subsequent actions being different.  Doing a
1572 non-dry-run dgit fetch first will help.
1573 \-\-damp-run is likely to work much better.
1575 \fBdgit\fP(7),
1576 \fBdgit-*\fP(7),
1577 \fBcurl\fP(1),
1578 \fBdput\fP(1),
1579 \fBdebsign\fP(1),
1580 \fBgit-config\fP(1),
1581 \fBgit-buildpackage\fP(1),
1582 \fBdpkg-buildpackage\fP(1),
1583 .br