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