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