chiark / gitweb /
Document multisuite
[dgit.git] / dgit.1
1 '\" t
2 .TH dgit 1 "" "Debian Project" "dgit"
4 dgit \- git integration with the Debian archive
5 .
7 .B dgit
8 [\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
9 \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
10 .br
11 .B dgit
12 [\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]
13 [\fIsuite\fP]
14 .br
15 .B dgit
16 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP
17 [\fIbuild\-opts\fp]
18 .br
19 .B dgit
20 [\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]
21 [\fIsuite\fP]
22 .br
23 .B dgit
24 [\fIdgit\-opts\fP] \fBrpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR
25 [\fIpush args...\fR]
26 .br
27 .B dgit
28 [\fIdgit\-opts\fP] \fIaction\fR ...
30 .B dgit
31 allows you to treat the Debian archive as if it were a git
32 repository.
34 This is the command line reference.
35 Please read the tutorial(s):
36 .TS
37 lb l.
38 dgit-user(7)    for users: editing, building and sharing packages
39 dgit-nmu-simple(7)      for DDs: doing a straightforward NMU
40 dgit-maint-native(7)    for maintainers of Debian-native packages
41 dgit-maint-merge(7)     for maintainers who want a pure git workflow
42 dgit-maint-gbp(7)       for maintainers already using git-buildpackage
43 dgit-sponsorship(7)     for sponsors and sponsored contributors
44 .TE
45 .LP
46 See \fBdgit(7)\fP for detailed information about the data
47 model,
48 common problems likely to arise with certain kinds of package,
49 etc.
51 .TP
52 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
53 Consults the archive and dgit-repos to construct the git view of
54 history for
55 .I package
56 in
57 .I suite
58 .RB ( sid
59 by default)
60 in a new directory (named
61 .BI ./ package
62 by default);
63 also, downloads any necessary orig tarballs.
65 The suite's git tip is
66 left on the local branch
67 .BI dgit/ suite
68 ready for work, and on the corresponding dgit remote tracking branch.
69 The
70 .B origin
71 remote will be set up to point to the package's dgit-repos tree
72 for the distro to which
73 .I suite
74 belongs.
76 .I suite
77 may be
78 .IR mainsuite \fB,\fR subsuite ...
79 in which case dgit will synthesize a view giving the most
80 recent version in any of the specified suites.
81 (The subsuites do not need to have the package.)
82 If a subsuite starts with
83 .B -
84 then mainsuite is prepended.
85 Each of the suite names will be individually canonicalised
86 to calculate the canonical branch names to use.
87 When using this facility, it is important to always specify the
88 same suites in the same order:
89 dgit will not be make a coherent fast-forwarding history
90 view otherwise.
92 For your convenience, the
93 .B vcs-git
94 remote will be set up from the package's Vcs-Git field, if there is
95 one - but note that in the general case the history found there may be
96 different to or even disjoint from dgit's view.
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.
110 suite may be
111 .IR mainsuite \fB,\fR subsuite ...
112 as for clone.
113 .TP
114 \fBdgit pull\fR [\fIsuite\fP]
115 Does dgit fetch, and then merges the new head of the remote tracking
116 branch
117 .BI remotes/dgit/dgit/ suite
118 into the current branch.
119 .TP
120 \fBdgit build\fR ...
121 Runs
122 .B dpkg-buildpackage
123 with some suitable options.  Options and arguments after build
124 will be passed on to dpkg-buildpackage.  It is not necessary to use
125 dgit build when using dgit; it is OK to use any approach which ensures
126 that the generated source package corresponds to the relevant git
127 commit.
129 Tagging, signing and actually uploading should be left to dgit push.
130 .TP
131 \fBdgit build-source\fR ...
132 Builds the source package, and a changes file for a prospective
133 source-only upload, using
134 .BR dpkg-source .
135 The output is left in
136 .IR package \fB_\fR version \fB.dsc\fR
137 and
138 .IR package \fB_\fR version \fB_source.changes\fR.
140 Tagging, signing and actually uploading should be left to dgit push.
141 .TP
142 .B dgit clean
143 Cleans the current working tree (according to the --clean= option in
144 force).
145 .TP
146 .B dgit help
147 Print a usage summary.
148 .TP
149 \fBdgit sbuild\fR ...
150 Constructs the source package, uses
151 .B  sbuild
152 to do a binary build, and uses mergechanges to merge the source and
153 binary changes files.  Options and arguments after sbuild will be
154 passed on to sbuild.
155 The output is left in
156 .IR package \fB_\fR version \fB_multi.changes\fR.
158 Tagging, signing and actually uploading should be left to dgit push.
159 .TP
160 \fBdgit gbp-build\fR ...
161 Runs
162 .B git-buildpackage
163 with some suitable options.  Options and arguments after gbp-build
164 will be passed on to git-buildpackage.
166 By default this uses \-\-quilt=gbp, so HEAD should be a
167 git-buildpackage style branch, not a patches-applied branch.
169 Tagging, signing and actually uploading should be left to dgit push.
170 .TP
171 \fBdgit push\fR [\fIsuite\fP]
172 Does an `upload', pushing the current HEAD to the archive (as a source
173 package) and to dgit-repos (as git commits).  The package must already
174 have been built ready for upload, with the .dsc and .changes
175 left in the parent directory.  It is normally best to do the build
176 with dgit too (eg with dgit sbuild): some existing build tools pass
177 unhelpful options to dpkg-source et al by default, which can result in
178 the built source package not being identical to the git tree.
180 In more detail: dgit push checks that the current HEAD corresponds to
181 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
182 adjusts the .changes to include any .origs which the archive lacks
183 and exclude .origs which the archive has
184 (so -sa and -sd are not needed when building for dgit push),
185 makes a signed git tag, edits the .dsc to contain the dgit metadata
186 field, runs debsign to sign the upload (.dsc and .changes), pushes the
187 signed tag, and finally uses dput to upload the .changes to the
188 archive.
190 dgit push always uses the package, suite and version specified in the
191 debian/changelog and the .dsc, which must agree.  If the command line
192 specifies a suite then that must match too.
194 If dgit push fails while uploading, it is fine to simply retry the
195 dput on the .changes file at your leisure.
196 .TP
197 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
198 Pushes the contents of the specified directory on a remote machine.
199 This is like running dgit push on build-host with build-dir as the
200 current directory; however, signing operations are done on the
201 invoking host.  This allows you to do a push when the system which has
202 the source code and the build outputs has no access to the key:
204 1.      Clone on build host (dgit clone)
205 .br
206 2.      Edit code on build host (edit, git commit)
207 .br
208 3.      Build package on build host (dgit build)
209 .br
210 4.      Test package on build host or elsewhere (dpkg -i, test)
211 .br
212 5.      Upload by invoking dgit rpush on host with your GPG key.
214 However, the build-host must be able to ssh to the dgit repos.  If
215 this is not already the case, you must organise it separately, for
216 example by the use of ssh agent forwarding.
218 The remaining arguments are treated just as dgit push would handle
219 them.
221 build-host and build\-dir can be passed as separate
222 arguments; this is assumed to be the case if the first argument
223 contains no : (except perhaps one in [ ], to support IPv6 address
224 literals).
226 You will need similar enough versions of dgit on the build-host and
227 the invocation host.  The build-host needs gnupg installed, with your
228 public key in its keyring (but not your private key, obviously).
229 .TP
230 .B dgit setup-new-tree
231 Configure the current working tree the way that dgit clone would have
232 set it up.  Like running
233 .B dgit setup-useremail
234 and
235 .B setup-mergechangelogs
236 (but only does each thing if dgit is configured to do it automatically).
237 You can use these in any git repository, not just ones used with
238 the other dgit operations.
239 .TP
240 .B dgit setup-useremail
241 Set the working tree's and from the
242 distro-specific dgit configuration
243 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
245 .TP
246 .B dgit setup-mergechangelogs
247 Configures a git merge helper for the file
248 .B debian/changelog
249 which uses
250 .BR dpkg-mergechangelogs .
251 .TP
252 .B dgit quilt-fixup
253 `3.0 (quilt)' format source packages need changes representing not
254 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
255 checks whether this has been done; if not, dgit will make appropriate
256 patches in debian/patches and also commit the resulting changes to
257 git.
259 This is normally done automatically by dgit build and dgit push.
261 dgit will try to turn each relevant commit in your git history into a
262 new quilt patch.  dgit cannot convert nontrivial merges, or certain
263 other kinds of more exotic history.  If dgit can't find a suitable
264 linearisation of your history, by default it will fail, but you can
265 ask it to generate a single squashed patch instead.
266 .TP
267 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
268 Import a Debian-format source package,
269 specified by its .dsc,
270 into git,
271 the way dgit fetch would do.
273 This does about half the work of dgit fetch:
274 it will convert the .dsc into a new, orphan git branch.
275 Since dgit has no access to a corresponding source package archive
276 or knowledge of the history
277 it does not consider whether this version is newer
278 than any previous import
279 or corresponding git branches;
280 and it therefore does not
281 make a pseudomerge to bind the import
282 into any existing git history.
284 There is only only sub-option:
286 .B --require-valid-signature
287 causes dgit to insist that the signature on the .dsc is valid
288 (using the same criteria as dpkg-source -x).
289 Otherwise, dgit tries to verify the signature but
290 the outcome is reported only as messages to stderr.
292 If
293 .I branch
294 is prefixed with
295 .B +
296 then if it already exists, it will be simply ovewritten,
297 no matter its existing contents.
298 If
299 .I branch
300 is prefixed with
301 .B ..
302 then if it already exists
303 and dgit actually imports the dsc
304 (rather than simply reading the git commit out of the Dgit field),
305 dgit will make a pseudomerge
306 so that the result is necessarily fast forward
307 from the existing branch.
308 Otherwise, if branch already exists,
309 dgit will stop with an error message.
311 If
312 .I branch
313 does not start with refs/, refs/heads/ is prepended.
314 The specified branch is unconditionally updated.
316 If the specified .dsc contains a Dgit field,
317 dgit will simply make a branch of that commit.
318 If you cannot manage to find that commit anywhere,
319 consider --force-import-dsc-with-dgit-field.
320 .TP
321 .B dgit version
322 Prints version information and exits.
323 .TP
324 .BI "dgit clone-dgit-repos-server" " destdir"
325 Tries to fetch a copy of the source code for the dgit-repos-server,
326 as actually being used on the dgit git server, as a git tree.
328 .TP
329 .BR --dry-run " | " -n
330 Go through the motions, fetching all information needed, but do not
331 actually update the output(s).  For push, dgit does
332 the required checks and leaves the new .dsc in a temporary file,
333 but does not sign, tag, push or upload.
334 .TP
335 .BR --damp-run " | " -L
336 Go through many more of the motions: do everything that doesn't
337 involve either signing things, or making changes on the public
338 servers.
339 .TP
340 .BI -k keyid
341 Use
342 .I keyid
343 for signing the tag and the upload.  The default comes from the
344 distro's
345 .B keyid
346 config setting (see CONFIGURATION, below), or failing that, the
347 uploader trailer line in debian/changelog.
348 .TP
349 .BR --no-sign
350 does not sign tags or uploads (meaningful only with push).
351 .TP
352 .TP
353 .BI -p package
354 Specifies that we should process source package
355 .I package
356 rather than looking in debian/control or debian/changelog.
357 Valid with dgit fetch and dgit pull, only.
358 .TP
359 .BR --clean=git " | " -wg
360 Use
361 .BR "git clean -xdf"
362 to clean the working tree,
363 rather than running the package's rules clean target.
365 This will delete all files which are not tracked by git.
366 (Including any files you forgot to git add.)
368 .BI --clean= ...
369 options other than dpkg-source
370 are useful when the package's clean target is troublesome, or
371 to avoid needing the build-dependencies.
372 .TP
373 .BR --clean=git-ff " | " -wgf
374 Use
375 .BR "git clean -xdff"
376 to clean the working tree.
377 Like
378 git clean -xdf
379 but it also removes any subdirectories containing different git
380 trees (which only unusual packages are likely to create).
381 .TP
382 .BR --clean=check " | " -wc
383 Merely check that the tree is clean (does not contain uncommitted
384 files).
385 Avoids running rules clean,
386 and can avoid needing the build-dependencies.
387 .TP
388 .BR --clean=none " | " -wn
389 Do not clean the tree, nor check that it is clean.
390 Avoids running rules clean,
391 and can avoid needing the build-dependencies.
392 If there are
393 files which are not in git, or if the build creates such files, a
394 subsequent dgit push will fail.
395 .TP
396 .BR --clean=dpkg-source " | " -wd
397 Use dpkg-buildpackage to do the clean, so that the source package
398 is cleaned by dpkg-source running the package's clean target.
399 This is the default.
400 Requires the package's build dependencies.
401 .TP
402 .BR --clean=dpkg-source-d " | " -wdd
403 Use
404 .B dpkg-buildpackage -d
405 to do the clean,
406 so that the source package
407 is cleaned by dpkg-source running the package's clean target.
408 The build-dependencies are not checked (due to
409 .BR -d ),
410 which violates policy, but may work in practice.
411 .TP
412 .BR -N " | " --new
413 The package is or may be new in this suite.  Without this, dgit will
414 refuse to push.  It may (for Debian, will) be unable to access the git
415 history for any packages which have been newly pushed and have not yet
416 been published.
417 .TP
418 .BR --ignore-dirty
419 Do not complain if the working tree does not match your git HEAD.
420 This can be useful with build, if you plan to commit later.  (dgit
421 push will still ensure that the .dsc you upload and the git tree
422 you push are identical, so this option won't make broken pushes.)
423 .TP
424 .BR --overwrite =\fIprevious-version\fR
425 Declare that even though your git branch is not a descendant
426 of the version in the archive
427 according to the revision history,
428 it really does contain
429 all the (wanted) changes from that version.
431 This option is useful if you are the maintainer, and you have
432 incorporated NMU changes into your own git workflow in a way that
433 doesn't make your branch a fast forward from the NMU.
435 .I previous-version
436 ought to be the version currently in the archive.  If
437 .I previous-version
438 is not
439 specified, dgit will check that the version in the archive is
440 mentioned in your debian/changelog.
441 (This will avoid losing
442 changes unless someone committed to git a finalised changelog
443 entry, and then made later changes to that version.)
445 dgit push --overwrite
446 will make a
447 pseudo-merge (that is, something that looks like the result
448 of git merge -s ours) to stitch the archive's version into your own
449 git history, so that your push is a fast forward from the archive.
451 (In quilt mode
452 .BR gbp ", " dpm " or " unpatched ,
453 implying a split between the dgit view and the
454 maintainer view, the pseudo-merge will appear only in the dgit view.)
455 .TP
456 .BR --delayed =\fIdays\fR
457 Upload to a DELAYED queue.
460 If the maintainer responds by cancelling
461 your upload from the queue,
462 and does not make an upload of their own,
463 this will not rewind the git branch on the dgit git server.
464 Other dgit users will then see your push
465 (with a warning message from dgit)
466 even though the maintainer wanted to abolish it.
467 Such users might unwittingly reintroduce your changes.
469 If this situation arises,
470 someone should make a suitable dgit push
471 to update the contents of dgit-repos
472 to a version without the controversial changes.
473 .TP
474 .BR --dgit-view-save= \fIbranch\fR|\fIref\fR
475 Specifies that when a split view quilt mode is in operation,
476 and dgit calculates
477 (or looks up in its cache)
478 a dgit view corresponding to your HEAD,
479 the dgit view will be left in
480 .IR ref .
481 The specified ref is unconditionally overwritten,
482 so don't specify a branch you want to keep.
484 This option is effective only with the following operations:
485 quilt-fixup; push; all builds.
486 And it is only effective with
487 --[quilt=]gbp,
488 --[quilt=]dpm,
489 --quilt=unpatched.
491 If ref does not start with refs/
492 it is taken to to be a branch -
493 i.e. refs/heads/ is prepended.
494 .TP
495 .BI --deliberately- something
496 Declare that you are deliberately doing
497 .IR something .
498 This can be used to override safety catches, including safety catches
499 which relate to distro-specific policies.
500 The use of --deliberately is declared and published in the signed tags
501 generated for you by dgit,
502 so that the archive software can give effect to your intent,
503 and
504 for the benefit humans looking at the history.
505 The meanings of
506 .IR something s
507 understood in the context of Debian are discussed below:
508 .TP
509 .BR --deliberately-not-fast-forward
510 Declare that you are deliberately rewinding history.  When pushing to
511 Debian, use this when you are making a renewed upload of an entirely
512 new source package whose previous version was not accepted for release
513 from NEW because of problems with copyright or redistributibility.
514 .TP
515 .BR --deliberately-include-questionable-history
516 Declare that you are deliberately including, in the git history of
517 your current push, history which contains a previously-submitted
518 version of this package which was not approved (or has not yet been
519 approved) by the ftpmasters.  When pushing to Debian, only use this
520 option after verifying that: none of the rejected-from-NEW (or
521 never-accepted) versions in the git history of your current push, were
522 rejected by ftpmaster for copyright or redistributability reasons.
523 .TP
524 .BR --deliberately-fresh-repo
525 Declare that you are deliberately rewinding history and want to
526 throw away the existing repo.  Not relevant when pushing to Debian,
527 as the Debian server will do this automatically when necessary.
528 .TP
529 .BR --quilt=linear
530 When fixing up source format `3.0 (quilt)' metadata, insist on
531 generating a linear patch stack: one new patch for each relevant
532 commit.
533 If such a stack cannot be generated, fail.
534 This is the default for Debian.
536 HEAD should be a series of plain commits
537 (not touching debian/patches/),
538 and pseudomerges,
539 with as ancestor a patches-applied branch.
540 .TP
541 .BR --quilt=auto
542 When fixing up source format `3.0 (quilt)' metadata, prefer to
543 generate a linear patch stack
544 (as with --quilt=auto)
545 but if that doesn't seem possible,
546 try to generate a single squashed patch for all the changes made in git
547 (as with --quilt=smash).
548 This is not a good idea for an NMU in Debian.
549 .TP
550 .BR --quilt=smash
551 When fixing up source format `3.0 (quilt)' metadata,
552 generate a single additional patch for all the changes made in git.
553 This is not a good idea for an NMU in Debian.
555 (If HEAD has any in-tree patches already, they must apply cleanly.
556 This will be the case for any trees produced by dgit fetch or clone;
557 if you do not change the upstream version
558 nor make changes in debian/patches,
559 it will remain true.)
560 .TP
561 .BR --quilt=nofix
562 Check whether source format `3.0 (quilt)' metadata would need fixing
563 up, but, if it does, fail.  You must then fix the metadata yourself
564 somehow before pushing.  (NB that dpkg-source --commit will not work
565 because the dgit git tree does not have a
566 .B .pc
567 directory.)
568 .TP
569 .BR --quilt=nocheck " | " --no-quilt-fixup
570 Do not check whether up source format `3.0 (quilt)' metadata needs
571 fixing up.  If you use this option and the metadata did in fact need
572 fixing up, dgit push will fail.
573 .TP
574 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
575 Tell dgit that you are using a nearly-dgit-compatible git branch,
576 aka a
577 .BR "maintainer view" ,
578 and
579 do not want your branch changed by dgit.
581 .B --gbp
582 (short for
583 .BR --quilt=gbp )
584 is for use with git-buildpackage.
585 Your HEAD is expected to be
586 a patches-unapplied git branch, except that it might contain changes
587 to upstream .gitignore files.  This is the default for dgit gbp-build.
589 .B --dpm
590 (short for
591 .BR --quilt=dpm )
592 is for use with git-dpm.
593 Your HEAD is expected to be
594 a patches-applied git branch,
595 except that it might contain changes to upstream .gitignore files.
597 .B --quilt=unapplied
598 specifies that your HEAD is a patches-unapplied git branch (and
599 that any changes to upstream .gitignore files are represented as
600 patches in debian/patches).
602 With --quilt=gbp|dpm|unapplied,
603 dgit push (or precursors like quilt-fixup and build) will automatically
604 generate a conversion of your git branch into the right form.
605 dgit push will push the
606 dgit-compatible form (the
607 .BR "dgit view" )
608 to the dgit git server.
609 The dgit view will be visible to you
610 in the dgit remote tracking branches, but your own branch will
611 not be modified.
612 dgit push will create a tag
613 .BI debian/ version
614 for the maintainer view, and the dgit tag
615 .BI archive/debian/ version
616 for the dgit view.
617 dgit quilt-fixup will merely do some checks,
618 and cache the maintainer view.
620 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
621 This is because it is not always possible to tell: a patches-unapplied
622 git branch of a package with one patch, for example, looks very like
623 a patches-applied branch where the user has used git revert to
624 undo the patch, expecting to actually revert it.
625 However, if you fail to specify the right \-\-quilt option,
626 and you aren't too lucky, dgit will notice the problem and stop,
627 with a useful hint. 
628 .TP
629 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
630 Specifies that the suite to be operated on is part of distro
631 .IR distro .
632 This overrides the default value found from the git config option
633 .BR dgit-suite. \fIsuite\fR .distro .
634 The only effect is that other configuration variables (used
635 for accessing the archive and dgit-repos) used are
636 .BR dgit-distro. \fIdistro\fR .* .
638 If your suite is part of a distro that dgit already knows about, you
639 can use this option to make dgit work even if your dgit doesn't know
640 about the suite.  For example, specifying
641 .B -ddebian
642 will work when the suite is an unknown suite in the Debian archive.
644 To define a new distro it is necessary to define methods and URLs
645 for fetching (and, for dgit push, altering) a variety of information both
646 in the archive and in dgit-repos.
647 How to set this up is not yet documented.
648 .TP
649 .BI -C changesfile
650 Specifies the .changes file which is to be uploaded.  By default
651 dgit push looks for single .changes file in the parent directory whose
652 filename suggests it is for the right package and version.
654 If the specified
655 .I changesfile
656 pathname contains slashes, the directory part is also used as
657 the value for
658 .BR --build-products-dir ;
659 otherwise, the changes file is expected in that directory (by
660 default, in
661 .BR .. ).
662 .TP
663 .B --rm-old-changes
664 When doing a build, delete any changes files matching
665 .IB package _ version _*.changes
666 before starting.  This ensures that
667 dgit push (and dgit sbuild) will be able to unambigously
668 identify the relevant changes files from the most recent build, even
669 if there have been previous builds with different tools or options.
670 The default is not to remove, but
671 .B \-\-no-rm-old-changes
672 can be used to override a previous \-\-rm-old-changes
673 or the .rm-old-changes configuration setting.
674 .TP
675 .BI --build-products-dir= directory
676 Specifies where to find the built files to be uploaded.
677 By default, dgit looks in the parent directory
678 .RB ( .. ).
679 .TP
680 .BI --no-rm-on-error
681 Do not delete the destination directory if clone fails.
682 .TP
683 .BI -D
684 Prints debugging information to stderr.  Repeating the option produces
685 more output (currently, up to -DDDD is meaningfully different).
686 .TP
687 .BI -c name = value
688 Specifies a git configuration option, to be used for this run.
689 dgit itself is also controlled by git configuration options.
690 .TP
691 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
692 Specifies the
693 .BI -v version
694 option to pass to dpkg-genchanges, during builds.  Changes (from
695 debian/changelog) since this version will be included in the built
696 changes file, and hence in the upload.  If this option is not
697 specified, dgit will query the archive and use the latest version
698 uploaded to the intended suite.
700 Specifying
701 .B _
702 inhibits this, so that no -v option will be passed to dpkg-genchanges
703 (and as a result, only the last stanza from debian/changelog will
704 be used for the build and upload).
705 .TP
706 .RI \fB-m\fR maintaineraddress
707 Passed to dpkg-genchanges (eventually).
708 .TP
709 .RI \fB--ch:\fR option
710 Specifies a single additional option to pass, eventually, to
711 dpkg-genchanges.
713 Options which are safe to pass include
714 .BR -C
715 (and also
716 .BR "-si -sa -sd"
717 although these should never be necessary with Debian since dgit
718 automatically calculates whether .origs need to be uploaded.)
720 For other options the caveat below applies.
721 .TP
722 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
723 Specifies a single additional option to pass to
724 .BR curl ,
725 .BR dput ,
726 .BR debsign ,
727 .BR dpkg-source ,
728 .BR dpkg-buildpackage ,
729 .BR dpkg-genchanges ,
730 .BR sbuild ,
731 .BR ssh ,
732 .BR dgit ,
733 .BR apt-get ,
734 .BR apt-cache ,
735 .BR gbp-pq ,
736 .BR gbp-build ,
737 or
738 .BR mergechanges .
739 Can be repeated as necessary.
741 Use of this ability should not normally be necessary.
742 It is provided for working around bugs,
743 or other unusual situations.
744 If you use these options,
745 you may violate dgit's assumptions
746 about the behaviour of its subprograms
747 and cause lossage.
749 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
750 the option applies only when the program is invoked directly by dgit.
751 Usually, for passing options to dpkg-genchanges, you should use
752 .BR --ch: \fIoption\fR.
754 Specifying --git is not effective for some lower-level read-only git
755 operations performed by dgit, and also not when git is invoked by
756 another program run by dgit.
758 See notes below regarding ssh and dgit.
760 NB that --gpg:option is not supported (because debsign does not
761 have that facility).
762 But see
763 .B -k
764 and the
765 .B keyid
766 distro config setting.
767 .TP
768 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
769 Specifies alternative programs to use instead of
770 .BR curl ,
771 .BR dput ,
772 .BR debsign ,
773 .BR dpkg-source ,
774 .BR dpkg-buildpackage ,
775 .BR dpkg-genchanges ,
776 .BR sbuild ,
777 .BR gpg ,
778 .BR ssh ,
779 .BR dgit ,
780 .BR apt-get ,
781 .BR apt-cache ,
782 .BR git ,
783 .BR gbp-pq ,
784 .BR gbp-build ,
785 or
786 .BR mergechanges .
788 For
789 .BR dpkg-buildpackage ,
790 .BR dpkg-genchanges ,
791 .B mergechanges
792 and
793 .BR sbuild ,
794 this applies only when the program is invoked directly by dgit.
796 For
797 .BR dgit ,
798 specifies the command to run on the remote host when dgit
799 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
800 itself as the EDITOR for dpkg-source --commit; this is done using
801 argv[0], and is not affected by --dgit=).
803 .BR gbp-build 's
804 value
805 is used instead of gbp build or git-buildpackage.  (The default is
806 the latter unless the former exists on PATH.)
807 .BR gbp-pq 's
808 value
809 is used instead of gbp pq.
810 In both cases,
811 unusually, the specified value is split on whitespace
812 to produce a command and possibly some options and/or arguments.
814 For
815 .BR ssh ,
816 the default value is taken from the
818 or
819 .B GIT_SSH
820 environment variables, if set (see below).  And, for ssh, when accessing the
821 archive and dgit-repos, this command line setting is overridden by the
822 git config variables
823 .BI dgit-distro. distro .ssh
824 and
825 .B .dgit.default.ssh
826 (which can in turn be overridden with -c).  Also, when dgit is using
827 git to access dgit-repos, only git's idea of what ssh to use (eg,
828 .BR GIT_SSH )
829 is relevant.
830 .TP
831 .BI --existing-package= package
832 dgit push needs to canonicalise the suite name.  Sometimes, dgit
833 lacks a way to ask the archive to do this without knowing the
834 name of an existing package.  Without --new we can just use the
835 package we are trying to push.  But with --new that will not work, so
836 we guess
837 .B dpkg
838 or use the value of this option.  This option is not needed with the
839 default mechanisms for accessing the archive.
840 .TP
841 .BR -h | --help
842 Print a usage summary.
843 .TP
844 .BI --initiator-tempdir= directory
845 dgit rpush uses a temporary directory on the invoking (signing) host.
846 This option causes dgit to use
847 .I directory
848 instead.  Furthermore, the specified directory will be emptied,
849 removed and recreated before dgit starts, rather than removed
850 after dgit finishes.  The directory specified must be an absolute
851 pathname.
852 .TP
853 .BI --force- something
854 Instructs dgit to try to proceed despite detecting
855 what it thinks is going to be a fatal problem.
856 .B This is probably not going to work.
857 These options are provided as an escape hatch,
858 in case dgit is confused.
859 (They might also be useful for testing error cases.)
860 .TP
861 .B --import-dsc-with-dgit-field
862 Tell dgit import-dsc to treat a .dsc with a Dgit field
863 like one without it.
864 The result is a fresh import,
865 discarding the git history
866 that the person who pushed that .dsc was working with.
867 .TP
868 .B --force-unrepresentable
869 Carry on even if
870 dgit thinks that your git tree contains changes
871 (relative to your .orig tarballs)
872 which dpkg-source is not able to represent.
873 Your build or push will probably fail later.
874 .TP
875 .B --force-changes-origs-exactly
876 Use the set of .origs specified in your .changes, exactly,
877 without regard to what is in the archive already.
878 The archive may well reject your upload.
879 .TP
880 .B --force-unsupported-source-format
881 Carry on despite dgit not understanding your source package format.
882 dgit will probably mishandle it.
883 .TP
884 .B --force-dsc-changes-mismatch
885 Do not check whether .dsc and .changes match.
886 The archive will probably reject your upload.
887 .TP
888 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
889 Force on or off the use of the absurd git-apply emulation
890 when running gbp pq import
891 when importing a package from a .dsc.
892 See Debian bug #841867.
894 dgit can be configured via the git config system.
895 You may set keys with git-config (either in system-global or per-tree
896 configuration), or provide
897 .BI -c key = value
898 on the dgit command line.
899 .LP
900 Settings likely to be useful for an end user include:
901 .TP
902 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
903 Specifies the distro for a suite.  dgit keys off the suite name (which
904 appears in changelogs etc.), and uses that to determine the distro
905 which is involved.  The config used is thereafter that for the distro.
907 .I suite
908 may be a glob pattern.
909 .TP
910 .BI dgit.default.distro " distro"
911 The default distro for an unknown suite.
912 .TP
913 .BR dgit.default. *
914 for each
915 .BR dgit-distro. \fIdistro\fR . *,
916 the default value used if there is no distro-specific setting.
917 .TP
918 .BR dgit-distro. \fIdistro\fR .clean-mode
919 One of the values for the command line --clean= option; used if
920 --clean is not specified.
921 .TP
922 .BR dgit-distro. \fIdistro\fR .quilt-mode
923 One of the values for the command line --quilt= option; used if
924 --quilt is not specified.
925 .TP
926 .BR dgit-distro. \fIdistro\fR .rm-old-changes
927 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
928 is specified.  The default is not to remove.
929 .TP
930 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
931 Whether you have push access to the distro.
932 For Debian, it is OK to use auto, which uses readonly mode if you are
933 not pushing right now;
934 but, setting this to false will avoid relying on the mirror of the dgit
935 git repository server.
936 .TP
937 .BI dgit-distro. distro .keyid
938 See also
939 .BR -k .
940 .TP
941 .BI dgit-distro. distro .mirror " url"
942 .TP
943 .BI dgit-distro. distro .username
944 Not relevant for Debian.
945 .TP
946 .BI dgit-distro. distro .upload-host
947 Might be useful if you have an intermediate queue server.
948 .TP
949 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
950 Values to configure for and in new git trees.  If
951 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
952 used, respectively.  Only used if .setup-usermail is not disabled.
953 .TP
954 .BI dgit-distro. distro .setup-useremail
955 Whether to set and in new git trees.
956 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
957 .TP
958 .BI dgit-distro. distro .setup-mergechangelogs
959 Whether to setup a merge driver which uses dpkg-mergechangelogs for
960 debian/changelog.  True by default.  Ignored for dgit
961 setup-mergechangelogs, which does it anyway.
962 .TP
963 .BI dgit-distro. distro .cmd- cmd
964 Program to use instead of
965 .IR cmd .
966 Works like
967 .BR -- \fIcmd\fR = "... ."
968 .TP
969 .BI dgit-distro. distro .opts- cmd
970 Extra options to pass to
971 .IR cmd .
972 Works like
973 .BR -- \fIcmd\fR : "... ."
974 To pass several options, configure multiple values in git config
975 (with git config --add).  The options for
976 .BI dgit.default.opts- cmd
977 .BI dgit-distro. distro /push.opts- cmd
978 and are all used, followed by options from dgit's command line.
980 There are many other settings which specify how a particular distro's
981 services (archive and git) are provided.  These should not normally be
982 adjusted, but are documented for the benefit of distros who wish to
983 adopt dgit.
984 .TP
985 .BR dgit-distro. \fIdistro\fR /push. *
986 If set, overrides corresponding non \fB/push\fR config when
987 .BR readonly=false ,
988 or when pushing and
989 .BR readonly=auto .
990 .TP
991 .BI dgit-distro. distro .git-url
992 .TP
993 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
994 .TP
995 .BI dgit-distro. distro .git-proto
996 .TP
997 .BI dgit-distro. distro .git-path
998 .TP
999 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1000 .TP
1001 .BI dgit-distro. distro .git-check-suffix
1002 .TP
1003 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1004 .TP
1005 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1006 .TP
1007 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
1008 .TP
1009 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1010 .TP
1011 .BI dgit-distro. distro .madison-distro
1012 .TP
1013 .BI dgit-distro. distro .archive-query-default-component
1014 .TP
1015 .BI dgit-distro. distro .dgit-tag-format
1016 .TP
1017 .BI dgit-distro. distro .ssh
1018 .TP
1019 .BI dgit-distro. distro .sshpsql-dbname
1020 .TP
1021 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1022 .TP
1023 .BI dgit-distro. distro .backports-quirk
1025 .TP
1026 .BR DGIT_SSH ", " GIT_SSH
1027 specify an alternative default program (and perhaps arguments) to use
1028 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
1029 if it contains any whitespace will be passed to the shell.  GIT_SSH
1030 specifies just the program; no arguments can be specified, so dgit
1031 interprets it the same way as git does.
1032 See
1033 also the --ssh= and --ssh: options.
1034 .TP
1036 Default git and for new trees.  See
1037 .BR "dgit setup-new-tree" .
1038 .TP
1039 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1040 and other subprograms and modules used by dgit are affected by various
1041 environment variables.  Consult the documentaton for those programs
1042 for details.
1043 .SH BUGS
1044 There should be
1045 a `dgit rebase-prep' command or some such to turn a
1046 fast-forwarding branch containing pseudo-merges
1047 back into a rebasing patch stack.
1048 It might have to leave a note
1049 for a future dgit push.
1051 If the dgit push fails halfway through,
1052 it is not necessarily restartable and
1053 idempotent.
1054 It would be good to check that the proposed signing key is
1055 available before starting work.
1057 dgit's build functions, and dgit push, may make changes to
1058 your current HEAD.  Sadly this is necessary for packages in the `3.0
1059 (quilt)' source format.  This is ultimately due to what I consider
1060 design problems in quilt and dpkg-source.
1062 --dry-run does not always work properly, as not doing some of the git
1063 fetches may result in subsequent actions being different.  Doing a
1064 non-dry-run dgit fetch first will help.
1065 --damp-run is likely to work much better.
1067 \fBdgit\fP(7),
1068 \fBdgit-*\fP(7),
1069 \fBcurl\fP(1),
1070 \fBdput\fP(1),
1071 \fBdebsign\fP(1),
1072 \fBgit-config\fP(1),
1073 \fBgit-buildpackage\fP(1),
1074 \fBdpkg-buildpackage\fP(1),
1075 .br