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