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