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