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