chiark / gitweb /
changelog: start 9.10
[dgit.git] / dgit.1
1 '\" t
2 .TH dgit 1 "" "Debian Project" "dgit"
3 .SH NAME
4 dgit \- git integration with the Debian archive
5 .
6 .SH SYNOPSIS
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 ...
33 .SH DESCRIPTION
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.
41
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.
60 .SH OPERATIONS
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.
74
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.
85
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).
90
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.
120
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.
127
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.
132
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.
146
147 Tagging, signing and actually uploading should be left to dgit push.
148
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.
161
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.
175
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.
208
209 You should ensure that your dgit \-\-build-products-dir setting matches
210 your pbuilder \-\-buildresult.
211
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).
217
218 You should ensure that in your pbuilderrc you do
219 .B not
220 have the setting
221 .B SOURCE_ONLY_CHANGES=yes
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.
235
236 By default this uses \-\-quilt=gbp, so HEAD should be a
237 git-buildpackage style branch, not a patches-applied branch.
238
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.
249
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.
259
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.
263
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."
273
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:
283
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
292
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.
296
297 The remaining arguments are treated just as dgit push would handle
298 them.
299
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).
304
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 user.name and user.email from the
327 distro-specific dgit configuration
328 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
329 or DEBFULLNAME or DEBEMAIL.
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
346 .B GITATTRIBUTES
347 in
348 .BR dgit(7) .
349 Note that only attributes affecting the working tree are suppressed.
350 git-archive may remain exciting.
351
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.
359
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.
377
378 This is normally done automatically by dgit build and dgit push.
379
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.
385
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.
394
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.
405
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.
416
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.
426
427 There is only one sub-option:
428
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.
434
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.
453
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.
487
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) dgit.default.build-products-dir.
493 See ACCESS CONFIGURATION, below.
494
495 This function is primarily provided for the benefit of git-debrebase.
496 .SH OPTIONS
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.
533
534 This will delete all files which are not tracked by git.
535 (Including any files you forgot to git add.)
536
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.
541
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.
567
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.
591
592 Without the extra
593 .BR d ,
594 requires the package's build dependencies.
595
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.
605
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).
612
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.)
646
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.
672
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.
679
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
684 This option is also usually necessary
685 the first time a package is pushed with dgit push
686 to a particular suite.
687 See
688 .BR dgit-maint- \fI*\fR (7) .
689
690 If
691 .I previous-version
692 is not
693 specified, dgit will check that the version in the archive is
694 mentioned in your debian/changelog.
695 (This will avoid losing
696 changes, even with
697 .BR --overwrite ,
698 unless someone committed to git a finalised changelog
699 entry, and then made later changes to that version.)
700 If
701 .IR previous-version
702 is specified, it ought to be the version currently in the archive.
703
704 dgit push --overwrite
705 will, if necessary, make a
706 pseudo-merge (that is, something that looks like the result
707 of git merge -s ours) to stitch the archive's version into your own
708 git history, so that your push is a fast forward from the archive.
709
710 (In quilt mode
711 .BR gbp ", " dpm ", " unpatched " or " baredebian *,
712 implying a split between the dgit view and the
713 maintainer view, the pseudo-merge will appear only in the dgit view.)
714 .TP
715 .BR \-\-delayed =\fIdays\fR
716 Upload to a DELAYED queue.
717
718 .B WARNING:
719 If the maintainer responds by cancelling
720 your upload from the queue,
721 and does not make an upload of their own,
722 this will not rewind the git branch on the dgit git server.
723 Other dgit users will then see your push
724 (with a warning message from dgit)
725 even though the maintainer wanted to abolish it.
726 Such users might unwittingly reintroduce your changes.
727
728 If this situation arises,
729 someone should make a suitable dgit push
730 to update the contents of dgit-repos
731 to a version without the controversial changes.
732 .TP
733 .BR --no-chase-dsc-distro
734 Tells dgit not to look online
735 for additional git repositories
736 containing information about a particular .dsc being imported.
737 Chasing is the default.
738
739 For most operations
740 (such as fetch and pull),
741 disabling chasing
742 means dgit will access only the git server
743 for the distro you are directly working with,
744 even if the .dsc was copied verbatim from another distro.
745 For import-dsc,
746 disabling chasing
747 means dgit will work completely offline.
748
749 Disabling chasing can be hazardous:
750 if the .dsc names a git commit which has been rewritten
751 by those in charge of the distro,
752 this option may prevent that rewrite from being effective.
753 Also,
754 it can mean that
755 dgit fails to find necessary git commits.
756 .TP
757 .BR \-\-save-dgit-view= \fIbranch\fR|\fIref\fR
758 Specifies that when split view is in operation,
759 and dgit calculates
760 (or looks up in its cache)
761 a dgit view corresponding to your HEAD,
762 the dgit view will be left in
763 .IR ref .
764 The specified ref is unconditionally overwritten,
765 so don't specify a branch you want to keep.
766
767 This option is effective only with the following operations:
768 quilt-fixup; push; all builds.
769 And it is only effective when split view is actually in operation.
770
771 If ref does not start with refs/
772 it is taken to be a branch -
773 i.e. refs/heads/ is prepended.
774
775 .B \-\-dgit-view-save
776 is a deprecated alias for
777 \-\-save-dgit-view.
778 .TP
779 .BI \-\-deliberately- something
780 Declare that you are deliberately doing
781 .IR something .
782 This can be used to override safety catches, including safety catches
783 which relate to distro-specific policies.
784 The use of \-\-deliberately is declared and published in the signed tags
785 generated for you by dgit,
786 so that the archive software can give effect to your intent,
787 and
788 for the benefit of humans looking at the history.
789 The meanings of
790 .IR something s
791 understood in the context of Debian are discussed below:
792 .TP
793 .BR --deliberately-not-fast-forward
794 Declare that you are deliberately rewinding history.
795 When pushing to Debian,
796 use this when you are making a renewed upload of an entirely
797 new source package whose previous version was not accepted for release
798 from NEW because of problems with copyright or redistributibility.
799
800 When split view is in operation,
801 this also prevents the construction by dgit of a pseudomerge
802 to make the dgit view fast forwarding.
803 Normally only one of
804 --overwrite (which creates a suitable pseudomerge)
805 and
806 --deliberately-not-fast-forward
807 (which suppresses the pseudomerge and the fast forward checks)
808 should be needed;
809 --overwrite is usually better.
810 .TP
811 .BR --deliberately-include-questionable-history
812 Declare that you are deliberately including, in the git history of
813 your current push, history which contains a previously-submitted
814 version of this package which was not approved (or has not yet been
815 approved) by the ftpmasters.  When pushing to Debian, only use this
816 option after verifying that: none of the rejected-from-NEW (or
817 never-accepted) versions in the git history of your current push, were
818 rejected by ftpmaster for copyright or redistributability reasons.
819 .TP
820 .BR --deliberately-fresh-repo
821 Declare that you are deliberately rewinding history and want to
822 throw away the existing repo.  Not relevant when pushing to Debian,
823 as the Debian server will do this automatically when necessary.
824 .TP
825 .BR --quilt=linear
826 When fixing up source format `3.0 (quilt)' metadata, insist on
827 generating a linear patch stack: one new patch for each relevant
828 commit.
829 If such a stack cannot be generated, fail.
830 This is the default for Debian.
831
832 HEAD should be a series of plain commits
833 (not touching debian/patches/),
834 and pseudomerges,
835 with as ancestor a patches-applied branch.
836 .TP
837 .BR --quilt=auto
838 When fixing up source format `3.0 (quilt)' metadata, prefer to
839 generate a linear patch stack
840 (as with --quilt=linear)
841 but if that doesn't seem possible,
842 try to generate a single squashed patch for all the changes made in git
843 (as with --quilt=smash).
844 This is not a good idea for an NMU in Debian.
845 .TP
846 .BR --quilt=smash
847 When fixing up source format `3.0 (quilt)' metadata,
848 generate a single additional patch for all the changes made in git.
849 This is not a good idea for an NMU in Debian.
850
851 (If HEAD has any in-tree patches already, they must apply cleanly.
852 This will be the case for any trees produced by dgit fetch or clone;
853 if you do not change the upstream version
854 nor make changes in debian/patches,
855 it will remain true.)
856 .TP
857 .BR --quilt=nofix
858 Check whether source format `3.0 (quilt)' metadata would need fixing
859 up, but, if it does, fail.  You must then fix the metadata yourself
860 somehow before pushing.  (NB that dpkg-source --commit will not work
861 because the dgit git tree does not have a
862 .B .pc
863 directory.)
864 .TP
865 .BR --quilt=nocheck " | " --no-quilt-fixup
866 Do not check whether source format `3.0 (quilt)' metadata needs
867 fixing up.  If you use this option and the metadata did in fact need
868 fixing up, dgit push will fail.
869 .TP
870 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied " | " -- [ quilt= ] baredebian [ +git | +tarball ]
871 Tell dgit that you are using a nearly-dgit-compatible git branch,
872 aka a
873 .BR "maintainer view" ,
874 and
875 do not want your branch changed by dgit.
876
877 These quilt modes are known as
878 .BR "splitting quilt modes" .
879 See --split-view, below.
880
881 .B --gbp
882 (short for
883 .BR --quilt=gbp )
884 is for use with git-buildpackage.
885 Your HEAD is expected to be
886 a patches-unapplied git branch, except that it might contain changes
887 to upstream .gitignore files.  This is the default for dgit gbp-build.
888
889 .B --dpm
890 (short for
891 .BR --quilt=dpm )
892 is for use with git-dpm.
893 Your HEAD is expected to be
894 a patches-applied git branch,
895 except that it might contain changes to upstream .gitignore files.
896
897 .B --quilt=unapplied
898 specifies that your HEAD is a patches-unapplied git branch (and
899 that any changes to upstream .gitignore files are represented as
900 patches in debian/patches).
901
902 .B --quilt=baredebian
903 (or its alias
904 .BR --quilt=baredebian+git )
905 specifies that your HEAD contains only a debian/ directory,
906 with any changes to upstream files represented as
907 patches in debian/patches.
908 The upstream source must be available in git,
909 by default, in a suitably named git tag;
910 see --upstream-commitish.
911 In this mode, dgit cannot check that
912 all edited upstream files are properly represented as patches:
913 dgit relies on
914 debian/patches being correct.
915
916 .B --quilt=baredebian+tarball
917 is like --quilt=baredebian,
918 but is used when there is no appropriate upstream git history.
919 To construct the dgit view,
920 dgit will import your orig tarballs' contents into git.
921 In this mode, dgit cannot check that
922 the upstream parts of your upload correspond to what you intend:
923 dgit relies on
924 the right orig tarball(s) existing, and
925 debian/patches being correct.
926
927 With --quilt=gbp|dpm|unapplied|baredebian*,
928 dgit push (or precursors like quilt-fixup and build) will automatically
929 generate a conversion of your git branch into the right form.
930 dgit push will push the
931 dgit-compatible form (the
932 .BR "dgit view" )
933 to the dgit git server.
934 The dgit view will be visible to you
935 in the dgit remote tracking branches, but your own branch will
936 not be modified.
937 dgit push will create a tag
938 .BI debian/ version
939 for the maintainer view, and the dgit tag
940 .BI archive/debian/ version
941 for the dgit view.
942 dgit quilt-fixup will merely do some checks,
943 and cache the maintainer view.
944
945 .B If you have a branch like this it is essential to specify the appropriate \-\-quilt= option!
946 This is because it is not always possible to tell: a patches-unapplied
947 git branch of a package with one patch, for example, looks very like
948 a patches-applied branch where the user has used git revert to
949 undo the patch, expecting to actually revert it.
950 However, if you fail to specify the right \-\-quilt option,
951 and you aren't too lucky, dgit will notice the problem and stop,
952 with a useful hint.
953 .TP
954 .BR \-d "\fIdistro\fR | " \-\-distro= \fIdistro\fR
955 Specifies that the suite to be operated on is part of distro
956 .IR distro .
957 This overrides the default value found from the git config option
958 .BR dgit-suite. \fIsuite\fR .distro .
959 The only effect is that other configuration variables (used
960 for accessing the archive and dgit-repos) used are
961 .BR dgit-distro. \fIdistro\fR .* .
962
963 If your suite is part of a distro that dgit already knows about, you
964 can use this option to make dgit work even if your dgit doesn't know
965 about the suite.  For example, specifying
966 .B \-ddebian
967 will work when the suite is an unknown suite in the Debian archive.
968
969 To define a new distro it is necessary to define methods and URLs
970 for fetching (and, for dgit push, altering) a variety of information both
971 in the archive and in dgit-repos.
972 How to set this up is not yet documented.
973 .TP
974 .BR \-\-split-view=auto | always | never
975 Controls whether dgit operates a split view,
976 separating your own branch (as Debian maintainer)
977 from that shown to users of dgit clone and dgit fetch.
978
979 When split view is in operation
980 dgit will not make or merge any commits onto your own branch.
981 Specifically, only the dgit view will contain
982 dgit's pseudomerges,
983 which bring into the git history previous uploads made with dgit push,
984 and any commits in debian/patches required
985 to make a correct `3.0 (quilt)' source package.
986
987 .B auto
988 is the default, and splits the view only when needed:
989 i.e., when you are working with a `3.0 (quilt)' source package
990 and a splitting quilt mode:
991 \-\-[quilt=]gbp, dpm, unpatched or baredebian*.
992
993 .B always
994 splits the view regardless of the source format and the quilt mode.
995
996 .B never
997 will cause dgit to fail if split view is needed.
998
999 When split view is in operation, the dgit view is visible
1000 in your local git clone,
1001 but only in refs specific to dgit:
1002 notably
1003 .BI remotes/dgit/dgit/ suite
1004 and
1005 .BR archive/ \fIdistro\fR / \fIversion\fR.
1006
1007 Note that split view does not affect dgit fetch,
1008 and is not compatible with dgit pull.
1009 .TP
1010 .BI \-C changesfile
1011 Specifies the .changes file which is to be uploaded.  By default
1012 dgit push looks for a single .changes file in the parent directory whose
1013 filename suggests it is for the right package and version.
1014
1015 If the specified
1016 .I changesfile
1017 pathname contains slashes, the directory part is also used as
1018 the value for
1019 .BR \-\-build-products-dir ;
1020 otherwise, the changes file is expected in that directory (by
1021 default, in
1022 .BR .. ).
1023 .TP
1024 .BI \-\-upstream-commitish= upstream
1025 For use with --quilt=baredebian only.
1026 Specifies the commit containing the upstream source.
1027 This commit must be identical to your .orig tarball.
1028 The default is to look for one of the git tags
1029 .IB U " v" U " upstream/" U
1030 (in that order), where U is the upstream version.
1031 .TP
1032 .B \-\-rm-old-changes
1033 When doing a build, delete any changes files matching
1034 .IB package _ version _*.changes
1035 before starting.  This ensures that
1036 dgit push (and dgit sbuild) will be able to unambiguously
1037 identify the relevant changes files from the most recent build, even
1038 if there have been previous builds with different tools or options.
1039 The default is not to remove, but
1040 .B \-\-no-rm-old-changes
1041 can be used to override a previous \-\-rm-old-changes
1042 or the .rm-old-changes configuration setting.
1043
1044 Note that \fBdgit push-source\fR will always find the right .changes,
1045 regardless of this option.
1046 .TP
1047 .BI \-\-build-products-dir= directory
1048 Specifies where to find and create tarballs, binary packages,
1049 source packages, .changes files, and so on.
1050
1051 By default, dgit uses the parent directory
1052 .RB ( .. ).
1053
1054 Changing this setting may necessitate
1055 moving .orig tarballs to the new directory,
1056 so it is probably best to
1057 use the
1058 .BI dgit.default.build-products-dir
1059 configuration setting
1060 (see CONFIGURATION, below)
1061 which this command line option overrides).
1062 .TP
1063 .BI --no-rm-on-error
1064 Do not delete the destination directory if clone fails.
1065 .TP
1066 .BI --dep14tag
1067 Generates a DEP-14 tag (eg
1068 .BR debian/ \fIversion\fR)
1069 as well as a dgit tag (eg
1070 .BR archive/debian/ \fIversion\fR).
1071 This is the default.
1072 .TP
1073 .BI --no-dep14tag
1074 Do not generate a DEP-14 tag, except when split view is in operation.
1075 .TP
1076 .BI --always-dep14tag
1077 Obsolete alias for --dep14tag, retained for compatibility.
1078 .TP
1079 .BI -D
1080 Prints debugging information to stderr.  Repeating the option produces
1081 more output (currently, up to -DDDD is meaningfully different).
1082 .TP
1083 .BI -c name = value
1084 Specifies a git configuration option, to be used for this run.
1085 dgit itself is also controlled by git configuration options.
1086 .TP
1087 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
1088 Specifies the
1089 .BI -v version
1090 option to pass to dpkg-genchanges, during builds.  Changes (from
1091 debian/changelog) since this version will be included in the built
1092 changes file, and hence in the upload.  If this option is not
1093 specified, dgit will query the archive and use the latest version
1094 uploaded to the intended suite.
1095
1096 Specifying
1097 .B _
1098 inhibits this, so that no -v option will be passed to dpkg-genchanges
1099 (and as a result, only the last stanza from debian/changelog will
1100 be used for the build and upload).
1101 .TP
1102 .RI \fB-m\fR maintaineraddress
1103 Passed to dpkg-genchanges (eventually).
1104 .TP
1105 .RI \fB--ch:\fR option
1106 Specifies a single additional option to pass, eventually, to
1107 dpkg-genchanges.
1108
1109 Options which are safe to pass include
1110 .BR -C
1111 (and also
1112 .BR "-si -sa -sd"
1113 although these should never be necessary with Debian since dgit
1114 automatically calculates whether .origs need to be uploaded.)
1115
1116 For other options the caveat below applies.
1117 .TP
1118 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
1119 Specifies a single additional option to pass to
1120 .BR curl ,
1121 .BR dput ,
1122 .BR debsign ,
1123 .BR dpkg-source ,
1124 .BR dpkg-buildpackage ,
1125 .BR dpkg-genchanges ,
1126 .BR sbuild ,
1127 .BR pbuilder ,
1128 .BR cowbuilder ,
1129 .BR ssh ,
1130 .BR dgit ,
1131 .BR git-debrebase ,
1132 .BR apt-get ,
1133 .BR apt-cache ,
1134 .BR gbp-pq ,
1135 .BR gbp-build ,
1136 or
1137 .BR mergechanges .
1138 Can be repeated as necessary.
1139
1140 Use of this ability should not normally be necessary.
1141 It is provided for working around bugs,
1142 or other unusual situations.
1143 If you use these options,
1144 you may violate dgit's assumptions
1145 about the behaviour of its subprograms
1146 and cause lossage.
1147
1148 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
1149 the option applies only when the program is invoked directly by dgit.
1150 Usually, for passing options to dpkg-genchanges, you should use
1151 .BR \-\-ch: \fIoption\fR.
1152
1153 Specifying \-\-git is not effective for some lower-level read-only git
1154 operations performed by dgit, and also not when git is invoked by
1155 another program run by dgit.
1156
1157 See notes below regarding ssh and dgit.
1158
1159 NB that \-\-gpg:option is not supported (because debsign does not
1160 have that facility).
1161 But see
1162 .B \-k
1163 and the
1164 .B keyid
1165 distro config setting.
1166 .TP
1167 .RI \fB\-\-curl!:\fR option " | \fB\-\-dput!:\fR" option " |..."
1168 Specifies an option to remove from the command line for
1169 a program called by dgit, as for
1170 \fB\-\-\fR\fIprogram\fI\fB:\fR\fIoption\fR
1171 (and the same caveats apply).
1172
1173 Any options or arguments exactly identical to
1174 .I option
1175 are removed.
1176 (It is not an error if there were none.)
1177
1178 This can only be used to delete options
1179 which are always passed by default by dgit,
1180 or to undo a previous
1181 \fB\-\-\fR\fIprogram\fI\fB:\fR\fIoption\fR.
1182 It cannot be used to override option(s) dynamically
1183 decided on by dgit.
1184 .TP
1185 .RI \fB\-\-curl=\fR program " | \fB\-\-dput=\fR" program  " |..."
1186 Specifies alternative programs to use instead of
1187 .BR curl ,
1188 .BR dput ,
1189 .BR debsign ,
1190 .BR dpkg-source ,
1191 .BR dpkg-buildpackage ,
1192 .BR dpkg-genchanges ,
1193 .BR sbuild ,
1194 .BR pbuilder ,
1195 .BR cowbuilder ,
1196 .BR gpg ,
1197 .BR ssh ,
1198 .BR dgit ,
1199 .BR git-debrebase ,
1200 .BR apt-get ,
1201 .BR apt-cache ,
1202 .BR git ,
1203 .BR gbp-pq ,
1204 .BR gbp-build ,
1205 or
1206 .BR mergechanges .
1207
1208 For
1209 .BR dpkg-buildpackage ,
1210 .BR dpkg-genchanges ,
1211 .B mergechanges
1212 and
1213 .BR sbuild ,
1214 this applies only when the program is invoked directly by dgit.
1215
1216 For
1217 .BR dgit ,
1218 specifies the command to run on the remote host when dgit
1219 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
1220 itself as the EDITOR for dpkg-source \-\-commit; this is done using
1221 argv[0], and is not affected by \-\-dgit=).
1222
1223 .BR gbp-build 's
1224 value
1225 is used instead of gbp build or git-buildpackage.  (The default is
1226 the latter unless the former exists on PATH.)
1227 .BR gbp-pq 's
1228 value
1229 is used instead of gbp pq.
1230 In both cases,
1231 unusually, the specified value is split on whitespace
1232 to produce a command and possibly some options and/or arguments.
1233
1234 For pbuilder and cowbuilder, the defaults are
1235 .BR "sudo -E pbuilder"
1236 and
1237 .BR "sudo -E cowbuilder"
1238 respectively.
1239 Like with gbp-build and gbp pq,
1240 the specified value is split on whitespace.
1241
1242 For
1243 .BR ssh ,
1244 the default value is taken from the
1245 .B DGIT_SSH
1246 or
1247 .B GIT_SSH
1248 environment variables, if set (see below).  And, for ssh, when accessing the
1249 archive and dgit-repos, this command line setting is overridden by the
1250 git config variables
1251 .BI dgit-distro. distro .ssh
1252 and
1253 .B .dgit.default.ssh
1254 (which can in turn be overridden with \-c).  Also, when dgit is using
1255 git to access dgit-repos, only git's idea of what ssh to use (eg,
1256 .BR GIT_SSH )
1257 is relevant.
1258 .TP
1259 .BI \-\-existing-package= package
1260 dgit push needs to canonicalise the suite name.  Sometimes, dgit
1261 lacks a way to ask the archive to do this without knowing the
1262 name of an existing package.  Without \-\-new we can just use the
1263 package we are trying to push.  But with \-\-new that will not work, so
1264 we guess
1265 .B dpkg
1266 or use the value of this option.  This option is not needed with the
1267 default mechanisms for accessing the archive.
1268 .TP
1269 .BR \-h | \-\-help
1270 Print a usage summary.
1271 .TP
1272 .BI \-\-initiator-tempdir= directory
1273 dgit rpush uses a temporary directory on the invoking (signing) host.
1274 This option causes dgit to use
1275 .I directory
1276 instead.  Furthermore, the specified directory will be emptied,
1277 removed and recreated before dgit starts, rather than removed
1278 after dgit finishes.  The directory specified must be an absolute
1279 pathname.
1280 .TP
1281 .BI \-\-force- something
1282 Instructs dgit to try to proceed despite detecting
1283 what it thinks is going to be a fatal problem.
1284 .B This is probably not going to work.
1285 These options are provided as an escape hatch,
1286 in case dgit is confused.
1287 (They might also be useful for testing error cases.)
1288 .TP
1289 .B \-\-force-import-dsc-with-dgit-field
1290 Tell dgit import-dsc to treat a .dsc with a Dgit field
1291 like one without it.
1292 The result is a fresh import,
1293 discarding the git history
1294 that the person who pushed that .dsc was working with.
1295 .TP
1296 .B \-\-force-reusing-version
1297 Carry on even though this involves reusing a version number
1298 of a previous push or upload.
1299 It is normally best to give different versions different numbers.
1300 Some servers (including, usually, the Debian server)
1301 will reject attempts to reuse or replace already-pushed versions.
1302 .TP
1303 .B \-\-force-uploading-binaries
1304 Carry on and
1305 upload binaries
1306 even though dgit thinks your distro does not permit that.
1307 .TP
1308 .B \-\-force-uploading-source-only
1309 Carry on and do a source-only upload,
1310 without any binaries,
1311 even though dgit thinks your distro does not permit that,
1312 or does not permit that in this situation.
1313 .TP
1314 .B \-\-force-unrepresentable
1315 Carry on even if
1316 dgit thinks that your git tree contains changes
1317 (relative to your .orig tarballs)
1318 which dpkg-source is not able to represent.
1319 Your build or push will probably fail later.
1320 .TP
1321 .B \-\-force-changes-origs-exactly
1322 Use the set of .origs specified in your .changes, exactly,
1323 without regard to what is in the archive already.
1324 The archive may well reject your upload.
1325 .TP
1326 .B \-\-force-unsupported-source-format
1327 Carry on despite dgit not understanding your source package format.
1328 dgit will probably mishandle it.
1329 .TP
1330 .B \-\-force-dsc-changes-mismatch
1331 Do not check whether .dsc and .changes match.
1332 The archive will probably reject your upload.
1333 .TP
1334 .BR \-\-force-import-gitapply-absurd " | " \-\-force-import-gitapply-no-absurd
1335 Force on or off the use of the absurd git-apply emulation
1336 when running gbp pq import
1337 when importing a package from a .dsc.
1338 See Debian bug #841867.
1339 .TP
1340 .BR \-\-for\-push
1341 Override the dgit-distro.distro.readonly configuration setting,
1342 to specify that we have read/write access
1343 and should use the corresponding git and achieve access approach
1344 even if the operation is a read-only one.
1345 .SH CONFIGURATION
1346 dgit can be configured via the git config system.
1347 You may set keys with git-config (either in system-global or per-tree
1348 configuration), or provide
1349 .BI -c key = value
1350 on the dgit command line.
1351 .LP
1352 Settings likely to be useful for an end user include:
1353 .TP
1354 .BI dgit.default.build-products-dir
1355 Specifies where to find the built files to be uploaded,
1356 when --build-products-dir is not specified.  The default is
1357 the parent directory
1358 .RB ( .. ).
1359 .TP
1360 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
1361 Specifies the distro for a suite.  dgit keys off the suite name (which
1362 appears in changelogs etc.), and uses that to determine the distro
1363 which is involved.  The config used is thereafter that for the distro.
1364
1365 .I suite
1366 may be a glob pattern.
1367 .TP
1368 .BI dgit.default.distro " distro"
1369 The default distro for an unknown suite.
1370
1371 This is only used if no
1372 .BI /usr/share/distro-info/ somedistro .csv
1373 mentions the specified suite.
1374 .TP
1375 .BI dgit.default.default-suite " suite"
1376 The default suite (eg for clone).
1377 .TP
1378 .BR dgit.default. *
1379 for each
1380 .BR dgit-distro. \fIdistro\fR . *,
1381 the default value used if there is no distro-specific setting.
1382 .TP
1383 .BR dgit-distro. \fIdistro\fR .clean-mode
1384 One of the values for the command line \-\-clean= option; used if
1385 \-\-clean is not specified.
1386 .TP
1387 .BR dgit-distro. \fIdistro\fR .clean-mode-newer
1388 Like .clean-mode,
1389 but ignored if the value is unknown to this version of dgit.
1390 Setting both .clean-mode and .clean-mode-newer is useful
1391 to provide a single git config compatible with different dgit versions.
1392 .TP
1393 .BR dgit-distro. \fIdistro\fR .quilt-mode
1394 One of the values for the command line \-\-quilt= option; used if
1395 \-\-quilt is not specified.
1396 .TP
1397 .BR dgit-distro. \fIdistro\fR .split-view
1398 .TP
1399 .BR dgit-distro. \fIdistro\fR .rm-old-changes
1400 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
1401 is specified.  The default is not to remove.
1402 .TP
1403 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
1404 Whether you have push access to the distro.
1405 For Debian, it is OK to use auto, which uses readonly mode if you are
1406 not pushing right now;
1407 but, setting this to false will avoid relying on the mirror of the dgit
1408 git repository server.
1409 .TP
1410 .BI dgit-distro. distro .keyid
1411 See also
1412 .BR \-k .
1413 .TP
1414 .BI dgit-distro. distro .mirror " url"
1415 .TP
1416 .BI dgit-distro. distro .username
1417 Not relevant for Debian.
1418 .TP
1419 .BI dgit-distro. distro .upload-host
1420 Might be useful if you have an intermediate queue server.
1421 .TP
1422 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
1423 Values to configure for user.name and user.email in new git trees.  If
1424 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
1425 used, respectively.  Only used if .setup-usermail is not disabled.
1426 .TP
1427 .BI dgit-distro. distro .setup-useremail
1428 Whether to set user.name and user.email in new git trees.
1429 True by default.  Ignored for dgit setup-useremail, which does it anyway.
1430 .TP
1431 .BI dgit-distro. distro .setup-mergechangelogs
1432 Whether to set up a merge driver which uses dpkg-mergechangelogs for
1433 debian/changelog.  True by default.  Ignored for dgit
1434 setup-mergechangelogs, which does it anyway.
1435 .TP
1436 .BI dgit-distro. distro .setup-gitattributes
1437 Whether to configure .git/info/attributes
1438 to suppress checkin/checkout file content transformations
1439 in new git trees.
1440 True by default.  Ignored for dgit setup-gitattributes, which does it anyway.
1441 .TP
1442 .BI dgit-distro. distro .cmd- cmd
1443 Program to use instead of
1444 .IR cmd .
1445 Works like
1446 .BR \-\- \fIcmd\fR = "... ."
1447 .TP
1448 .BI dgit-distro. distro .opts- cmd
1449 Extra options to pass to
1450 .IR cmd .
1451 Works like
1452 .BR \-\- \fIcmd\fR : "... ."
1453 To pass several options, configure multiple values in git config
1454 (with git config \-\-add).  The options for
1455 .BI dgit.default.opts- cmd
1456 and
1457 .BI dgit-distro. distro /push.opts- cmd
1458 are all used, followed by options from dgit's command line.
1459 .SH ACCESS CONFIGURATION
1460 There are many other settings which specify how a particular distro's
1461 services (archive and git) are provided.  These should not normally be
1462 adjusted, but are documented for the benefit of distros who wish to
1463 adopt dgit.
1464 .TP
1465 .BI dgit-distro. distro .nominal-distro
1466 Shown in git tags, Dgit fields, and so on.
1467 .TP
1468 .BI dgit-distro. distro .alias-canon
1469 Used for all access configuration lookup.
1470 .TP
1471 .BR dgit-distro. \fIdistro\fR /push. *
1472 If set, overrides corresponding non \fB/push\fR config when
1473 .BR readonly=false ,
1474 or when pushing and
1475 .BR readonly=auto .
1476 .TP
1477 .BI dgit-distro. distro .git-url
1478 .TP
1479 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1480 .TP
1481 .BI dgit-distro. distro .git-proto
1482 .TP
1483 .BI dgit-distro. distro .git-path
1484 .TP
1485 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1486 .TP
1487 .BI dgit-distro. distro .git-check-suffix
1488 .TP
1489 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1490 .TP
1491 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1492 .TP
1493 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR " " | " aptget:"
1494 .TP
1495 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1496 .TP
1497 .BI dgit-distro. distro .madison-distro
1498 .TP
1499 .BI dgit-distro. distro .archive-query-default-component
1500 .TP
1501 .BI dgit-distro. distro .dgit-tag-format
1502 .TP
1503 .BR dgit-distro. \fIdistro\fR .dep14tag " " want | no [| always ]
1504 .TP
1505 .BI dgit-distro. distro .ssh
1506 .TP
1507 .BI dgit-distro. distro .sshpsql-dbname
1508 .TP
1509 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1510 .TP
1511 .BI dgit-distro. distro .backports-quirk
1512 .TP
1513 .BI dgit-distro. distro .rewrite-map-enable
1514 .TP
1515 .BR dgit-distro. \fIdistro\fR .source-only-uploads " " ok | always | never | not-wholly-new
1516 .TP
1517 .BI dgit.default.old-dsc-distro
1518 .TP
1519 .BI dgit.dsc-url-proto-ok. protocol
1520 .TP
1521 .BI dgit.dsc-url-proto-ok.bad-syntax
1522 .TP
1523 .BI dgit.default.dsc-url-proto-ok
1524 .TP
1525 .BR dgit.vcs-git.suites " \fIsuite\fR[" ; ...]
1526 .SH ENVIRONMENT VARIABLES
1527 .TP
1528 .BR DGIT_SSH ", " GIT_SSH
1529 specify an alternative default program (and perhaps arguments) to use
1530 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
1531 if it contains any whitespace will be passed to the shell.  GIT_SSH
1532 specifies just the program; no arguments can be specified, so dgit
1533 interprets it the same way as git does.
1534 See
1535 also the \-\-ssh= and \-\-ssh: options.
1536 .TP
1537 .BR DEBEMAIL ", " DEBFULLNAME
1538 Default git user.email and user.name for new trees.  See
1539 .BR "dgit setup-new-tree" .
1540 .TP
1541 .BR gpg ", " dpkg- "..., " debsign ", " git ", [" lib ] curl ", " dput
1542 and other subprograms and modules used by dgit are affected by various
1543 environment variables.  Consult the documentation for those programs
1544 for details.
1545 .SH BUGS
1546 There should be
1547 a `dgit rebase-prep' command or some such to turn a
1548 fast-forwarding branch containing pseudo-merges
1549 back into a rebasing patch stack.
1550 It might have to leave a note
1551 for a future dgit push.
1552
1553 If the dgit push fails halfway through,
1554 it is not necessarily restartable and
1555 idempotent.
1556 It would be good to check that the proposed signing key is
1557 available before starting work.
1558
1559 dgit's build functions, and dgit push, may make changes to
1560 your current HEAD.  Sadly this is necessary for packages in the `3.0
1561 (quilt)' source format.  This is ultimately due to what I consider
1562 design problems in quilt and dpkg-source.
1563
1564 \-\-dry-run does not always work properly, as not doing some of the git
1565 fetches may result in subsequent actions being different.  Doing a
1566 non-dry-run dgit fetch first will help.
1567 \-\-damp-run is likely to work much better.
1568 .SH SEE ALSO
1569 \fBdgit\fP(7),
1570 \fBdgit-*\fP(7),
1571 \fBcurl\fP(1),
1572 \fBdput\fP(1),
1573 \fBdebsign\fP(1),
1574 \fBgit-config\fP(1),
1575 \fBgit-buildpackage\fP(1),
1576 \fBdpkg-buildpackage\fP(1),
1577 .br
1578 https://browse.dgit.debian.org/