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