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