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