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