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