chiark / gitweb /
dgit.1: Discourage use of the --PROGRAM:OPTION escape hatch.
[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 makes a signed git tag, edits the .dsc to contain the dgit metadata
159 field, runs debsign to sign the upload (.dsc and .changes), pushes the
160 signed tag, and finally uses dput to upload the .changes to the
161 archive.
163 dgit push always uses the package, suite and version specified in the
164 debian/changelog and the .dsc, which must agree.  If the command line
165 specifies a suite then that must match too.
167 If dgit push fails while uploading, it is fine to simply retry the
168 dput on the .changes file at your leisure.
169 .TP
170 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
171 Pushes the contents of the specified directory on a remote machine.
172 This is like running dgit push on build-host with build-dir as the
173 current directory; however, signing operations are done on the
174 invoking host.  This allows you to do a push when the system which has
175 the source code and the build outputs has no access to the key:
177 1.      Clone on build host (dgit clone)
178 .br
179 2.      Edit code on build host (edit, git commit)
180 .br
181 3.      Build package on build host (dgit build)
182 .br
183 4.      Test package on build host or elsewhere (dpkg -i, test)
184 .br
185 5.      Upload by invoking dgit rpush on host with your GPG key.
187 However, the build-host must be able to ssh to the dgit repos.  If
188 this is not already the case, you must organise it separately, for
189 example by the use of ssh agent forwarding.
191 The remaining arguments are treated just as dgit push would handle
192 them.
194 build-host and build\-dir can be passed as separate
195 arguments; this is assumed to be the case if the first argument
196 contains no : (except perhaps one in [ ], to support IPv6 address
197 literals).
199 You will need similar enough versions of dgit on the build-host and
200 the invocation host.  The build-host needs gnupg installed, with your
201 public key in its keyring (but not your private key, obviously).
202 .TP
203 .B dgit setup-new-tree
204 Configure the current working tree the way that dgit clone would have
205 set it up.  Like running
206 .B dgit setup-useremail
207 and
208 .B setup-mergechangelogs
209 (but only does each thing if dgit is configured to do it automatically).
210 You can use these in any git repository, not just ones used with
211 the other dgit operations.
212 .TP
213 .B dgit setup-useremail
214 Set the working tree's and from the
215 distro-specific dgit configuration
216 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
218 .TP
219 .B dgit setup-mergechangelogs
220 Configures a git merge helper for the file
221 .B debian/changelog
222 which uses
223 .BR dpkg-mergechangelogs .
224 .TP
225 .B dgit quilt-fixup
226 `3.0 (quilt)' format source packages need changes representing not
227 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
228 checks whether this has been done; if not, dgit will make appropriate
229 patches in debian/patches and also commit the resulting changes to
230 git.
232 This is normally done automatically by dgit build and dgit push.
234 dgit will try to turn each relevant commit in your git history into a
235 new quilt patch.  dgit cannot convert nontrivial merges, or certain
236 other kinds of more exotic history.  If dgit can't find a suitable
237 linearisation of your history, by default it will fail, but you can
238 ask it to generate a single squashed patch instead.
239 .TP
240 .B dgit version
241 Prints version information and exits.
242 .TP
243 .BI "dgit clone-dgit-repos-server" " destdir"
244 Tries to fetch a copy of the source code for the dgit-repos-server,
245 as actually being used on the dgit git server, as a git tree.
247 .TP
248 .BR --dry-run " | " -n
249 Go through the motions, fetching all information needed, but do not
250 actually update the output(s).  For push, dgit does
251 the required checks and leaves the new .dsc in a temporary file,
252 but does not sign, tag, push or upload.
253 .TP
254 .BR --damp-run " | " -L
255 Go through many more of the motions: do everything that doesn't
256 involve either signing things, or making changes on the public
257 servers.
258 .TP
259 .BI -k keyid
260 Use
261 .I keyid
262 for signing the tag and the upload.  The default comes from the
263 distro's
264 .B keyid
265 config setting (see CONFIGURATION, below), or failing that, the
266 uploader trailer line in debian/changelog.
267 .TP
268 .BR --no-sign
269 does not sign tags or uploads (meaningful only with push).
270 .TP
271 .TP
272 .BI -p package
273 Specifies that we should process source package
274 .I package
275 rather than looking in debian/control or debian/changelog.
276 Valid with dgit fetch and dgit pull, only.
277 .TP
278 .BR --clean=git " | " -wg
279 Use
280 .BR "git clean -xdf"
281 to clean the working tree,
282 rather than running the package's rules clean target.
284 This will delete all files which are not tracked by git.
285 (Including any files you forgot to git add.)
287 .BI --clean= ...
288 options other than dpkg-source
289 are useful when the package's clean target is troublesome, or
290 to avoid needing the build-dependencies.
291 .TP
292 .BR --clean=git-ff " | " -wgf
293 Use
294 .BR "git clean -xdff"
295 to clean the working tree.
296 Like
297 git clean -xdf
298 but it also removes any subdirectories containing different git
299 trees (which only unusual packages are likely to create).
300 .TP
301 .BR --clean=check " | " -wc
302 Merely check that the tree is clean (does not contain uncommitted
303 files).
304 Avoids running rules clean,
305 and can avoid needing the build-dependencies.
306 .TP
307 .BR --clean=none " | " -wn
308 Do not clean the tree, nor check that it is clean.
309 Avoids running rules clean,
310 and can avoid needing the build-dependencies.
311 If there are
312 files which are not in git, or if the build creates such files, a
313 subsequent dgit push will fail.
314 .TP
315 .BR --clean=dpkg-source " | " -wd
316 Use dpkg-buildpackage to do the clean, so that the source package
317 is cleaned by dpkg-source running the package's clean target.
318 This is the default.
319 Requires the package's build dependencies.
320 .TP
321 .BR --clean=dpkg-source-d " | " -wdd
322 Use
323 .B dpkg-buildpackage -d
324 to do the clean,
325 so that the source package
326 is cleaned by dpkg-source running the package's clean target.
327 The build-dependencies are not checked (due to
328 .BR -d ),
329 which violates policy, but may work in practice.
330 .TP
331 .BR -N " | " --new
332 The package is or may be new in this suite.  Without this, dgit will
333 refuse to push.  It may (for Debian, will) be unable to access the git
334 history for any packages which have been newly pushed and have not yet
335 been published.
336 .TP
337 .BR --ignore-dirty
338 Do not complain if the working tree does not match your git HEAD.
339 This can be useful with build, if you plan to commit later.  (dgit
340 push will still ensure that the .dsc you upload and the git tree
341 you push are identical, so this option won't make broken pushes.)
342 .TP
343 .BR --overwrite =\fIprevious-version\fR
344 Declare that even though your git branch is not a descendant
345 of the version in the archive
346 according to the revision history,
347 it really does contain
348 all the (wanted) changes from that version.
350 This option is useful if you are the maintainer, and you have
351 incorporated NMU changes into your own git workflow in a way that
352 doesn't make your branch a fast forward from the NMU.
354 .I previous-version
355 ought to be the version currently in the archive.  If
356 .I previous-version
357 is not
358 specified, dgit will check that the version in the archive is
359 mentioned in your debian/changelog.
360 (This will avoid losing
361 changes unless someone committed to git a finalised changelog
362 entry, and then made later changes to that version.)
364 dgit push --overwrite
365 will make a
366 pseudo-merge (that is, something that looks like the result
367 of git merge -s ours) to stitch the archive's version into your own
368 git history, so that your push is a fast forward from the archive.
370 (In quilt mode
371 .BR gbp ", " dpm " or " unpatched ,
372 implying a split between the dgit view and the
373 maintainer view, the pseudo-merge will appear only in the dgit view.)
374 .TP
375 .BI --deliberately- something
376 Declare that you are deliberately doing
377 .IR something .
378 This can be used to override safety catches, including safety catches
379 which relate to distro-specific policies.  The meanings of
380 .IR something s
381 understood in the context of Debian are discussed below:
382 .TP
383 .BR --deliberately-not-fast-forward
384 Declare that you are deliberately rewinding history.  When pushing to
385 Debian, use this when you are making a renewed upload of an entirely
386 new source package whose previous version was not accepted for release
387 from NEW because of problems with copyright or redistributibility.
388 .TP
389 .BR --deliberately-include-questionable-history
390 Declare that you are deliberately including, in the git history of
391 your current push, history which contains a previously-submitted
392 version of this package which was not approved (or has not yet been
393 approved) by the ftpmasters.  When pushing to Debian, only use this
394 option after verifying that: none of the rejected-from-NEW (or
395 never-accepted) versions in the git history of your current push, were
396 rejected by ftpmaster for copyright or redistributability reasons.
397 .TP
398 .BR --deliberately-fresh-repo
399 Declare that you are deliberately rewinding history and want to
400 throw away the existing repo.  Not relevant when pushing to Debian,
401 as the Debian server will do this automatically when necessary.
402 .TP
403 .BR --quilt=linear
404 When fixing up source format `3.0 (quilt)' metadata, insist on
405 generating a linear patch stack.  If such a stack cannot be generated,
406 fail.  This is the default for Debian.
407 .TP
408 .BR --quilt=auto
409 When fixing up source format `3.0 (quilt)' metadata, prefer to
410 generate a linear patch stack, but if that doesn't seem possible,
411 generate a single squashed patch for all the changes made in git.
412 This is not a good idea for an NMU in Debian.
413 .TP
414 .BR --quilt=smash
415 When fixing up source format `3.0 (quilt)' metadata,
416 generate a single squashed patch for all the changes made in git.
417 This is not a good idea for an NMU in Debian.
418 .TP
419 .BR --quilt=nofix
420 Check whether source format `3.0 (quilt)' metadata would need fixing
421 up, but, if it does, fail.  You must then fix the metadata yourself
422 somehow before pushing.  (NB that dpkg-source --commit will not work
423 because the dgit git tree does not have a
424 .B .pc
425 directory.)
426 .TP
427 .BR --quilt=nocheck " | " --no-quilt-fixup
428 Do not check whether up source format `3.0 (quilt)' metadata needs
429 fixing up.  If you use this option and the metadata did in fact need
430 fixing up, dgit push will fail.
431 .TP
432 .BR --quilt=gbp " | " --quilt=dpm " | " --quilt=unapplied
433 Tell dgit that you are using a nearly-dgit-compatible git branch,
434 aka a
435 .BR "maintainer view" ,
436 and
437 do not want your branch changed by dgit.
439 .B --quilt=gbp
440 is for use with git-buildpackage.
441 Your HEAD is expected to be
442 a patches-unapplied git branch, except that it might contain changes
443 to upstream .gitignore files.  This is the default for dgit gbp-build.
445 .B --quilt=dpm
446 is for use with git-dpm.
447 Your HEAD is expected to be
448 a patches-applied git branch,
449 except that it might contain changes to upstream .gitignore files.
451 .B --quilt=unapplied
452 specifies that your HEAD is a patches-unapplied git branch (and
453 that any changes to upstream .gitignore files are represented as
454 patches in debian/patches).
456 Instead, dgit quilt-fixup and dgit-push will automatically
457 convert your git branch into the right form,
458 and dgit push will push the
459 dgit-compatible form (the
460 .BR "dgit view" )
461 to the dgit git server.
462 The dgit view will be visible to you
463 in the dgit remote tracking branches, but your own branch will
464 not be modified.
465 dgit will create a tag
466 .BI debian/ version
467 for the maintainer view, and the dgit tag
468 .BI archive/debian/ version
469 for the dgit view.
471 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
472 This is because it is not always possible to tell: a patches-unapplied
473 git branch of a package with one patch, for example, looks just the
474 same as a patches-applied branch where the user has used git revert to
475 undo the patch, expecting to actually revert it.
476 If you fail to specify the right \-\-quilt option,
477 and you aren't too lucky, dgit will notice the problem and stop,
478 with a useful hint. 
479 .TP
480 .BI -D
481 Prints debugging information to stderr.  Repeating the option produces
482 more output (currently, up to -DDDD is meaningfully different).
483 .TP
484 .BI -c name = value
485 Specifies a git configuration option, to be used for this run.
486 dgit itself is also controlled by git configuration options.
487 .TP
488 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
489 Specifies the
490 .BI -v version
491 option to pass to dpkg-genchanges, during builds.  Changes (from
492 debian/changelog) since this version will be included in the built
493 changes file, and hence in the upload.  If this option is not
494 specified, dgit will query the archive and use the latest version
495 uploaded to the intended suite.
497 Specifying
498 .B _
499 inhibits this, so that no -v option will be passed to dpkg-genchanges
500 (and as a result, only the last stanza from debian/changelog will
501 be used for the build and upload).
502 .TP
503 .RI \fB-m\fR maintaineraddress
504 Passed to dpkg-genchanges (eventually).
505 .TP
506 .RI \fB--ch:\fR option
507 Specifies a single additional option to pass, eventually, to
508 dpkg-genchanges.
509 .TP
510 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
511 Specifies a single additional option to pass to
512 .BR curl ,
513 .BR dput ,
514 .BR debsign ,
515 .BR dpkg-source ,
516 .BR dpkg-buildpackage ,
517 .BR dpkg-genchanges ,
518 .BR sbuild ,
519 .BR ssh ,
520 .BR dgit ,
521 .BR gbp-pq ,
522 .BR gbp-build ,
523 or
524 .BR mergechanges .
525 Can be repeated as necessary.
527 Use of this ability should not normally be necessary.
528 It is provided for working around bugs,
529 or other unusual situations.
530 If you use these options,
531 you may violate dgit's assumptions
532 about the behaviour of its subprograms
533 and cause lossage.
535 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
536 the option applies only when the program is invoked directly by dgit.
537 Usually, for passing options to dpkg-genchanges, you should use
538 .BR --ch: \fIoption\fR.
540 Specifying --git is not effective for some lower-level read-only git
541 operations performed by dgit, and also not when git is invoked by
542 another program run by dgit.
544 See notes above regarding ssh and dgit.
546 NB that --gpg:option is not supported (because debsign does not
547 have that facility).
548 But see
549 .B -k
550 and the
551 .B keyid
552 distro config setting.
553 .TP
554 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
555 Specifies alternative programs to use instead of
556 .BR curl ,
557 .BR dput ,
558 .BR debsign ,
559 .BR dpkg-source ,
560 .BR dpkg-buildpackage ,
561 .BR dpkg-genchanges ,
562 .BR sbuild ,
563 .BR gpg ,
564 .BR ssh ,
565 .BR dgit ,
566 .BR git ,
567 .BR gbp-pq ,
568 .BR gbp-build ,
569 or
570 .BR mergechanges .
572 For
573 .BR dpkg-buildpackage ,
574 .BR dpkg-genchanges ,
575 .B mergechanges
576 and
577 .BR sbuild ,
578 this applies only when the program is invoked directly by dgit.
580 For
581 .BR dgit ,
582 specifies the command to run on the remote host when dgit
583 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
584 itself as the EDITOR for dpkg-source --commit; this is done using
585 argv[0], and is not affected by --dgit=).
587 .BR gbp-build 's
588 value
589 is used instead of gbp build or git-buildpackage.  (The default is
590 the latter unless the former exists on PATH.)
591 .BR gbp-pq 's
592 value
593 is used instead of gbp pq.
594 In both cases,
595 unusually, the specified value is split on whitespace
596 to produce a command and possibly some options and/or arguments.
598 For
599 .BR ssh ,
600 the default value is taken from the
602 or
603 .B GIT_SSH
604 environment variables, if set (see below).  And, for ssh, when accessing the
605 archive and dgit-repos, this command line setting is overridden by the
606 git config variables
607 .BI dgit-distro. distro .ssh
608 and
609 .B .dgit.default.ssh
610 (which can in turn be overridden with -c).  Also, when dgit is using
611 git to access dgit-repos, only git's idea of what ssh to use (eg,
612 .BR GIT_SSH )
613 is relevant.
614 .TP
615 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
616 Specifies that the suite to be operated on is part of distro
617 .IR distro .
618 This overrides the default value found from the git config option
619 .BR dgit-suite. \fIsuite\fR .distro .
620 The only effect is that other configuration variables (used
621 for accessing the archive and dgit-repos) used are
622 .BR dgit-distro. \fIdistro\fR .* .
624 If your suite is part of a distro that dgit already knows about, you
625 can use this option to make dgit work even if your dgit doesn't know
626 about the suite.  For example, specifying
627 .B -ddebian
628 will work when the suite is an unknown suite in the Debian archive.
630 To define a new distro it is necessary to define methods and URLs
631 for fetching (and, for dgit push, altering) a variety of information both
632 in the archive and in dgit-repos.
633 How to set this up is not yet documented.
634 .TP
635 .BI -C changesfile
636 Specifies the .changes file which is to be uploaded.  By default
637 dgit push looks for single .changes file in the parent directory whose
638 filename suggests it is for the right package and version.
640 If the specified
641 .I changesfile
642 pathname contains slashes, the directory part is also used as
643 the value for
644 .BR --build-products-dir ;
645 otherwise, the changes file is expected in that directory (by
646 default, in
647 .BR .. ).
648 .TP
649 .B --rm-old-changes
650 When doing a build, delete any changes files matching
651 .IB package _ version _*.changes
652 before starting.  This ensures that
653 dgit push (and dgit sbuild) will be able to unambigously
654 identify the relevant changes files from the most recent build, even
655 if there have been previous builds with different tools or options.
656 The default is not to remove, but
657 .B \-\-no-rm-old-changes
658 can be used to override a previous \-\-rm-old-changes
659 or the .rm-old-changes configuration setting.
660 .TP
661 .BI --build-products-dir= directory
662 Specifies where to find the built files to be uploaded.
663 By default, dgit looks in the parent directory
664 .RB ( .. ).
665 .TP
666 .BI --existing-package= package
667 dgit push needs to canonicalise the suite name.  Sometimes, dgit
668 lacks a way to ask the archive to do this without knowing the
669 name of an existing package.  Without --new we can just use the
670 package we are trying to push.  But with --new that will not work, so
671 we guess
672 .B dpkg
673 or use the value of this option.  This option is not needed with the
674 default mechanisms for accessing the archive.
675 .TP
676 .BR -h | --help
677 Print a usage summary.
678 .TP
679 .BI --initiator-tempdir= directory
680 dgit rpush uses a temporary directory on the invoking (signing) host.
681 This option causes dgit to use
682 .I directory
683 instead.  Furthermore, the specified directory will be emptied,
684 removed and recreated before dgit starts, rather than removed
685 after dgit finishes.  The directory specified must be an absolute
686 pathname.
687 .TP
688 .BI --no-rm-on-error
689 Do not delete the destination directory if clone fails.
691 It is always possible with dgit to clone or fetch a package, make
692 changes in git (using git-commit) on the suite branch
693 .RB ( "git checkout dgit/" \fIsuite\fR)
694 and then dgit push.  You can use whatever gitish techniques you like
695 to construct the commits to push;
696 the only requirement is that what you push is a
697 descendant of the state of the archive, as provided by dgit in the
698 remote tracking branch
699 .BR remotes/dgit/dgit/ \fIsuite\fR.
701 If you are using dgit to do an NMU (in Debian),
702 and don't know about the
703 maintainers' preferred packaging workflows, you should make your
704 changes as a linear series of (logicially separated) commits on top of
705 what's already in the archive.
707 If you are lucky the other uploaders have also used dgit and
708 integrated the other relevant git history; if not you can fetch it
709 into your tree and cherry-pick etc. as you wish.
711 If you are the maintainer of a package dealing with uploads made
712 without dgit, you will probably want to merge the synthetic commits
713 (made by dgit to represent the uploads) into your git history.
714 Normally you can just merge the dgit branch into your own master, or
715 indeed if you do your work on the dgit local suite branch
716 .BI dgit/ suite
717 you can just use dgit pull.
719 However the first time dgit is used it will generate a new origin
720 commit from the archive which won't be linked into the rest of your
721 git history.  You will need to merge this.
723 If last upload was in fact made with git, you should usually proceed
724 as follows: identify the commit which was actually used to build the
725 package.  (Hopefully you have a tag for this.)  Check out the dgit
726 branch
727 .RB ( "git checkout dgit/" \fIsuite\fR)
728 and merge that other commit
729 .RB ( "git merge debian/" \fIversion\fR).
730 Hopefully this merge will be trivial because the two trees should
731 be very similar.  The resulting branch head can be merged into your
732 working branches
733 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
735 If last upload was not made with git, a different approach is required
736 to start using dgit.  First, do
737 .B dgit fetch
738 (or clone) to obtain a git history representation of what's in the
739 archive and record it in the
740 .BI remotes/dgit/dgit/ suite
741 tracking branch.  Then somehow, using your other git history
742 plus appropriate diffs and cherry picks from the dgit remote tracking
743 branch, construct a git commit whose tree corresponds to the tree to use for the
744 next upload. 
746 between what's in the archive and what you intend to upload.
747 Then run
748 .BR "dgit push"
749 to actually upload the result.
751 If the commit-to-be-uploaded is not a descendant of the
752 dgit remote tracking branch, you will need to pass
753 .B --overwrite
754 to dgit.
756 dgit can be configured via the git config system.
757 You may set keys with git-config (either in system-global or per-tree
758 configuration), or provide
759 .BI -c key = value
760 on the dgit command line.
761 .LP
762 Settings likely to be useful for an end user include:
763 .TP
764 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
765 Specifies the distro for a suite.  dgit keys off the suite name (which
766 appears in changelogs etc.), and uses that to determine the distro
767 which is involved.  The config used is thereafter that for the distro.
768 .TP
769 .BI dgit.default.distro " distro"
770 The default distro for an unknown suite.
771 .TP
772 .BR dgit.default. *
773 for each
774 .BR dgit-distro. \fIdistro\fR . *,
775 the default value used if there is no distro-specific setting.
776 .TP
777 .BR dgit-distro. \fIdistro\fR .clean-mode
778 One of the values for the command line --clean= option; used if
779 --clean is not specified.
780 .TP
781 .BR dgit-distro. \fIdistro\fR .quilt-mode
782 One of the values for the command line --quilt= option; used if
783 --quilt is not specified.
784 .TP
785 .BR dgit-distro. \fIdistro\fR .rm-old-changes
786 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
787 is specified.  The default is not to remove.
788 .TP
789 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
790 Whether you have push access to the distro.
791 For Debian, it is OK to use auto, which uses readonly mode if you are
792 not pushing right now;
793 but, setting this to false will avoid relying on the mirror of the dgit
794 git repository server.
795 .TP
796 .BI dgit-distro. distro .keyid
797 See also
798 .BR -k .
799 .TP
800 .BI dgit-distro. distro .mirror " url"
801 .TP
802 .BI dgit-distro. distro .username
803 Not relevant for Debian.
804 .TP
805 .BI dgit-distro. distro .upload-host
806 Might be useful if you have an intermediate queue server.
807 .TP
808 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
809 Values to configure for and in new git trees.  If
810 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
811 used, respectively.  Only used if .setup-usermail is not disabled.
812 .TP
813 .BI dgit-distro. distro .setup-useremail
814 Whether to set and in new git trees.
815 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
816 .TP
817 .BI dgit-distro. distro .setup-mergechangelogs
818 Whether to setup a merge driver which uses dpkg-mergechangelogs for
819 debian/changelog.  True by default.  Ignored for dgit
820 setup-mergechangelogs, which does it anyway.
821 .TP
822 .BI dgit-distro. distro .cmd- cmd
823 Program to use instead of
824 .IR cmd .
825 Works like
826 .BR -- \fIcmd\fR = "... ."
827 .TP
828 .BI dgit-distro. distro .opts- cmd
829 Extra options to pass to
830 .IR cmd .
831 Works like
832 .BR -- \fIcmd\fR : "... ."
833 To pass several options, configure multiple values in git config
834 (with git config --add).  The options for
835 .BI dgit.default.opts- cmd
836 .BI dgit-distro. distro /push.opts- cmd
837 and are all used, followed by options from dgit's command line.
839 There are many other settings which specify how a particular distro's
840 services (archive and git) are provided.  These should not normally be
841 adjusted, but are documented for the benefit of distros who wish to
842 adopt dgit.
843 .TP
844 .BR dgit-distro. \fIdistro\fR /push. *
845 If set, overrides corresponding non \fB/push\fR config when
846 .BR readonly=false ,
847 or when pushing and
848 .BR readonly=auto .
849 .TP
850 .BI dgit-distro. distro .git-url
851 .TP
852 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
853 .TP
854 .BI dgit-distro. distro .git-proto
855 .TP
856 .BI dgit-distro. distro .git-path
857 .TP
858 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
859 .TP
860 .BI dgit-distro. distro .git-check-suffix
861 .TP
862 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
863 .TP
864 .BI dgit-distro. distro .git-create " " ssh-cmd | true
865 .TP
866 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
867 .TP
868 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
869 .TP
870 .BI dgit-distro. distro .madison-distro
871 .TP
872 .BI dgit-distro. distro .archive-query-default-component
873 .TP
874 .BI dgit-distro. distro .dgit-tag-format
875 .TP
876 .BI dgit-distro. distro .ssh
877 .TP
878 .BI dgit-distro. distro .sshpsql-dbname
879 .TP
880 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
881 .TP
882 .BI dgit-distro. distro .backports-quirk
884 .TP
886 specify an alternative default program (and perhaps arguments) to use
887 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
888 if it contains any whitespace will be passed to the shell.  GIT_SSH
889 specifies just the program; no arguments can be specified, so dgit
890 interprets it the same way as git does.
891 See
892 also the --ssh= and --ssh: options.
893 .TP
895 Default git and for new trees.  See
896 .BR "dgit setup-new-tree" .
897 .TP
898 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
899 and other subprograms and modules used by dgit are affected by various
900 environment variables.  Consult the documentaton for those programs
901 for details.
902 .SH BUGS
903 dgit's git representation of format `3.0 (quilt)' source packages does
904 not represent the patch stack as git commits.  Currently the patch
905 series representation cannot round trip between git and the archive.
906 Ideally dgit would represent a quilty package with an origin commit of
907 some kind followed by the patch stack as a series of commits followed
908 by a pseudo-merge (to make the branch fast-forwarding).  This would
909 also mean a new `dgit rebase-prep' command or some such to turn such a
910 fast-forwarding branch back into a rebasing patch stack, and a `force'
911 option to dgit push (perhaps enabled automatically by a note left by
912 rebase-prep) which will make the required pseudo-merge.
914 If the dgit push fails halfway through, it should be restartable and
915 idempotent.  However this is not true for the git tag operation.
916 Also, it would be good to check that the proposed signing key is
917 available before starting work.
919 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
920 the .orig.tar.gz could be transported via the git repo as git tags.
921 Doing this is made more complicated by the possibility of a `3.0
922 (quilt)' package with multiple .orig tarballs.
924 dgit's build functions, and dgit push, should not make any changes to
925 your current HEAD.  Sadly this is necessary for packages in the `3.0
926 (quilt)' source format.  This is ultimately due to what I consider
927 design problems in quilt and dpkg-source.
929 There should be an option which arranges for the `3.0 (quilt)'
930 autocommit(s) to not appear on your HEAD, but instead only in the
931 remote tracking suite branch.
933 --dry-run does not always work properly, as not doing some of the git
934 fetches may result in subsequent actions being different.  Doing a
935 non-dry-run dgit fetch first will help.
937 \fBdgit\fP(7),
938 \fBcurl\fP(1),
939 \fBdput\fP(1),
940 \fBdebsign\fP(1),
941 \fBgit-config\fP(1),
942 \fBgit-buildpackage\fP(1),
943 \fBdpkg-buildpackage\fP(1),
944 .br