chiark / gitweb /
dgit.1: Clarify the --clean= options' documentation. Closes:#800054.
[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 program " | \fB--dput=\fR" program  " |..."
511 Specifies alternative programs to use instead of
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 gpg ,
520 .BR ssh ,
521 .BR dgit ,
522 .BR git ,
523 .BR gbp-pq ,
524 .BR gbp-build ,
525 or
526 .BR mergechanges .
528 For
529 .BR dpkg-buildpackage ,
530 .BR dpkg-genchanges ,
531 .B mergechanges
532 and
533 .BR sbuild ,
534 this applies only when the program is invoked directly by dgit.
536 For
537 .BR dgit ,
538 specifies the command to run on the remote host when dgit
539 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
540 itself as the EDITOR for dpkg-source --commit; this is done using
541 argv[0], and is not affected by --dgit=).
543 .BR gbp-build 's
544 value
545 is used instead of gbp build or git-buildpackage.  (The default is
546 the latter unless the former exists on PATH.)
547 .BR gbp-pq 's
548 value
549 is used instead of gbp pq.
550 In both cases,
551 unusually, the specified value is split on whitespace
552 to produce a command and possibly some options and/or arguments.
554 For
555 .BR ssh ,
556 the default value is taken from the
558 or
559 .B GIT_SSH
560 environment variables, if set (see below).  And, for ssh, when accessing the
561 archive and dgit-repos, this command line setting is overridden by the
562 git config variables
563 .BI dgit-distro. distro .ssh
564 and
565 .B .dgit.default.ssh
566 (which can in turn be overridden with -c).  Also, when dgit is using
567 git to access dgit-repos, only git's idea of what ssh to use (eg,
568 .BR GIT_SSH )
569 is relevant.
570 .TP
571 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
572 Specifies a single additional option to pass to
573 .BR curl ,
574 .BR dput ,
575 .BR debsign ,
576 .BR dpkg-source ,
577 .BR dpkg-buildpackage ,
578 .BR dpkg-genchanges ,
579 .BR sbuild ,
580 .BR ssh ,
581 .BR dgit ,
582 .BR gbp-pq ,
583 .BR gbp-build ,
584 or
585 .BR mergechanges .
586 Can be repeated as necessary.
588 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
589 this applies only when the program is invoked directly by dgit.
590 Usually, for passing options to dpkg-genchanges, you should use
591 .BR --ch: \fIoption\fR.
593 Specifying --git not effective for some lower-level read-only git
594 operations performed by dgit, and also not when git is invoked by
595 another program run by dgit.
597 See notes above regarding ssh and dgit.
599 NB that --gpg:option is not supported (because debsign does not
600 have that facility).
601 But see
602 .B -k
603 and the
604 .B keyid
605 distro config setting.
606 .TP
607 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
608 Specifies that the suite to be operated on is part of distro
609 .IR distro .
610 This overrides the default value found from the git config option
611 .BR dgit-suite. \fIsuite\fR .distro .
612 The only effect is that other configuration variables (used
613 for accessing the archive and dgit-repos) used are
614 .BR dgit-distro. \fIdistro\fR .* .
616 If your suite is part of a distro that dgit already knows about, you
617 can use this option to make dgit work even if your dgit doesn't know
618 about the suite.  For example, specifying
619 .B -ddebian
620 will work when the suite is an unknown suite in the Debian archive.
622 To define a new distro it is necessary to define methods and URLs
623 for fetching (and, for dgit push, altering) a variety of information both
624 in the archive and in dgit-repos.
625 How to set this up is not yet documented.
626 .TP
627 .BI -C changesfile
628 Specifies the .changes file which is to be uploaded.  By default
629 dgit push looks for single .changes file in the parent directory whose
630 filename suggests it is for the right package and version.
632 If the specified
633 .I changesfile
634 pathname contains slashes, the directory part is also used as
635 the value for
636 .BR --build-products-dir ;
637 otherwise, the changes file is expected in that directory (by
638 default, in
639 .BR .. ).
640 .TP
641 .B --rm-old-changes
642 When doing a build, delete any changes files matching
643 .IB package _ version _*.changes
644 before starting.  This ensures that
645 dgit push (and dgit sbuild) will be able to unambigously
646 identify the relevant changes files from the most recent build, even
647 if there have been previous builds with different tools or options.
648 The default is not to remove, but
649 .B \-\-no-rm-old-changes
650 can be used to override a previous \-\-rm-old-changes
651 or the .rm-old-changes configuration setting.
652 .TP
653 .BI --build-products-dir= directory
654 Specifies where to find the built files to be uploaded.
655 By default, dgit looks in the parent directory
656 .RB ( .. ).
657 .TP
658 .BI --existing-package= package
659 dgit push needs to canonicalise the suite name.  Sometimes, dgit
660 lacks a way to ask the archive to do this without knowing the
661 name of an existing package.  Without --new we can just use the
662 package we are trying to push.  But with --new that will not work, so
663 we guess
664 .B dpkg
665 or use the value of this option.  This option is not needed with the
666 default mechanisms for accessing the archive.
667 .TP
668 .BR -h | --help
669 Print a usage summary.
670 .TP
671 .BI --initiator-tempdir= directory
672 dgit rpush uses a temporary directory on the invoking (signing) host.
673 This option causes dgit to use
674 .I directory
675 instead.  Furthermore, the specified directory will be emptied,
676 removed and recreated before dgit starts, rather than removed
677 after dgit finishes.  The directory specified must be an absolute
678 pathname.
679 .TP
680 .BI --no-rm-on-error
681 Do not delete the destination directory if clone fails.
683 It is always possible with dgit to clone or fetch a package, make
684 changes in git (using git-commit) on the suite branch
685 .RB ( "git checkout dgit/" \fIsuite\fR)
686 and then dgit push.  You can use whatever gitish techniques you like
687 to construct the commits to push;
688 the only requirement is that what you push is a
689 descendant of the state of the archive, as provided by dgit in the
690 remote tracking branch
691 .BR remotes/dgit/dgit/ \fIsuite\fR.
693 If you are using dgit to do an NMU (in Debian),
694 and don't know about the
695 maintainers' preferred packaging workflows, you should make your
696 changes as a linear series of (logicially separated) commits on top of
697 what's already in the archive.
699 If you are lucky the other uploaders have also used dgit and
700 integrated the other relevant git history; if not you can fetch it
701 into your tree and cherry-pick etc. as you wish.
703 If you are the maintainer of a package dealing with uploads made
704 without dgit, you will probably want to merge the synthetic commits
705 (made by dgit to represent the uploads) into your git history.
706 Normally you can just merge the dgit branch into your own master, or
707 indeed if you do your work on the dgit local suite branch
708 .BI dgit/ suite
709 you can just use dgit pull.
711 However the first time dgit is used it will generate a new origin
712 commit from the archive which won't be linked into the rest of your
713 git history.  You will need to merge this.
715 If last upload was in fact made with git, you should usually proceed
716 as follows: identify the commit which was actually used to build the
717 package.  (Hopefully you have a tag for this.)  Check out the dgit
718 branch
719 .RB ( "git checkout dgit/" \fIsuite\fR)
720 and merge that other commit
721 .RB ( "git merge debian/" \fIversion\fR).
722 Hopefully this merge will be trivial because the two trees should
723 be very similar.  The resulting branch head can be merged into your
724 working branches
725 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
727 If last upload was not made with git, a different approach is required
728 to start using dgit.  First, do
729 .B dgit fetch
730 (or clone) to obtain a git history representation of what's in the
731 archive and record it in the
732 .BI remotes/dgit/dgit/ suite
733 tracking branch.  Then somehow, using your other git history
734 plus appropriate diffs and cherry picks from the dgit remote tracking
735 branch, construct a git commit whose tree corresponds to the tree to use for the
736 next upload. 
738 between what's in the archive and what you intend to upload.
739 Then run
740 .BR "dgit push"
741 to actually upload the result.
743 If the commit-to-be-uploaded is not a descendant of the
744 dgit remote tracking branch, you will need to pass
745 .B --overwrite
746 to dgit.
748 dgit can be configured via the git config system.
749 You may set keys with git-config (either in system-global or per-tree
750 configuration), or provide
751 .BI -c key = value
752 on the dgit command line.
753 .LP
754 Settings likely to be useful for an end user include:
755 .TP
756 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
757 Specifies the distro for a suite.  dgit keys off the suite name (which
758 appears in changelogs etc.), and uses that to determine the distro
759 which is involved.  The config used is thereafter that for the distro.
760 .TP
761 .BI dgit.default.distro " distro"
762 The default distro for an unknown suite.
763 .TP
764 .BR dgit.default. *
765 for each
766 .BR dgit-distro. \fIdistro\fR . *,
767 the default value used if there is no distro-specific setting.
768 .TP
769 .BR dgit-distro. \fIdistro\fR .clean-mode
770 One of the values for the command line --clean= option; used if
771 --clean is not specified.
772 .TP
773 .BR dgit-distro. \fIdistro\fR .quilt-mode
774 One of the values for the command line --quilt= option; used if
775 --quilt is not specified.
776 .TP
777 .BR dgit-distro. \fIdistro\fR .rm-old-changes
778 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
779 is specified.  The default is not to remove.
780 .TP
781 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
782 Whether you have push access to the distro.
783 For Debian, it is OK to use auto, which uses readonly mode if you are
784 not pushing right now;
785 but, setting this to false will avoid relying on the mirror of the dgit
786 git repository server.
787 .TP
788 .BI dgit-distro. distro .keyid
789 See also
790 .BR -k .
791 .TP
792 .BI dgit-distro. distro .mirror " url"
793 .TP
794 .BI dgit-distro. distro .username
795 Not relevant for Debian.
796 .TP
797 .BI dgit-distro. distro .upload-host
798 Might be useful if you have an intermediate queue server.
799 .TP
800 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
801 Values to configure for and in new git trees.  If
802 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
803 used, respectively.  Only used if .setup-usermail is not disabled.
804 .TP
805 .BI dgit-distro. distro .setup-useremail
806 Whether to set and in new git trees.
807 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
808 .TP
809 .BI dgit-distro. distro .setup-mergechangelogs
810 Whether to setup a merge driver which uses dpkg-mergechangelogs for
811 debian/changelog.  True by default.  Ignored for dgit
812 setup-mergechangelogs, which does it anyway.
813 .TP
814 .BI dgit-distro. distro .cmd- cmd
815 Program to use instead of
816 .IR cmd .
817 Works like
818 .BR -- \fIcmd\fR = "... ."
819 .TP
820 .BI dgit-distro. distro .opts- cmd
821 Extra options to pass to
822 .IR cmd .
823 Works like
824 .BR -- \fIcmd\fR : "... ."
825 To pass several options, configure multiple values in git config
826 (with git config --add).  The options for
827 .BI dgit.default.opts- cmd
828 .BI dgit-distro. distro /push.opts- cmd
829 and are all used, followed by options from dgit's command line.
831 There are many other settings which specify how a particular distro's
832 services (archive and git) are provided.  These should not normally be
833 adjusted, but are documented for the benefit of distros who wish to
834 adopt dgit.
835 .TP
836 .BR dgit-distro. \fIdistro\fR /push. *
837 If set, overrides corresponding non \fB/push\fR config when
838 .BR readonly=false ,
839 or when pushing and
840 .BR readonly=auto .
841 .TP
842 .BI dgit-distro. distro .git-url
843 .TP
844 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
845 .TP
846 .BI dgit-distro. distro .git-proto
847 .TP
848 .BI dgit-distro. distro .git-path
849 .TP
850 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
851 .TP
852 .BI dgit-distro. distro .git-check-suffix
853 .TP
854 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
855 .TP
856 .BI dgit-distro. distro .git-create " " ssh-cmd | true
857 .TP
858 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
859 .TP
860 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
861 .TP
862 .BI dgit-distro. distro .madison-distro
863 .TP
864 .BI dgit-distro. distro .archive-query-default-component
865 .TP
866 .BI dgit-distro. distro .dgit-tag-format
867 .TP
868 .BI dgit-distro. distro .ssh
869 .TP
870 .BI dgit-distro. distro .sshpsql-dbname
871 .TP
872 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
873 .TP
874 .BI dgit-distro. distro .backports-quirk
876 .TP
878 specify an alternative default program (and perhaps arguments) to use
879 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
880 if it contains any whitespace will be passed to the shell.  GIT_SSH
881 specifies just the program; no arguments can be specified, so dgit
882 interprets it the same way as git does.
883 See
884 also the --ssh= and --ssh: options.
885 .TP
887 Default git and for new trees.  See
888 .BR "dgit setup-new-tree" .
889 .TP
890 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
891 and other subprograms and modules used by dgit are affected by various
892 environment variables.  Consult the documentaton for those programs
893 for details.
894 .SH BUGS
895 dgit's git representation of format `3.0 (quilt)' source packages does
896 not represent the patch stack as git commits.  Currently the patch
897 series representation cannot round trip between git and the archive.
898 Ideally dgit would represent a quilty package with an origin commit of
899 some kind followed by the patch stack as a series of commits followed
900 by a pseudo-merge (to make the branch fast-forwarding).  This would
901 also mean a new `dgit rebase-prep' command or some such to turn such a
902 fast-forwarding branch back into a rebasing patch stack, and a `force'
903 option to dgit push (perhaps enabled automatically by a note left by
904 rebase-prep) which will make the required pseudo-merge.
906 If the dgit push fails halfway through, it should be restartable and
907 idempotent.  However this is not true for the git tag operation.
908 Also, it would be good to check that the proposed signing key is
909 available before starting work.
911 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
912 the .orig.tar.gz could be transported via the git repo as git tags.
913 Doing this is made more complicated by the possibility of a `3.0
914 (quilt)' package with multiple .orig tarballs.
916 dgit's build functions, and dgit push, should not make any changes to
917 your current HEAD.  Sadly this is necessary for packages in the `3.0
918 (quilt)' source format.  This is ultimately due to what I consider
919 design problems in quilt and dpkg-source.
921 There should be an option which arranges for the `3.0 (quilt)'
922 autocommit(s) to not appear on your HEAD, but instead only in the
923 remote tracking suite branch.
925 --dry-run does not always work properly, as not doing some of the git
926 fetches may result in subsequent actions being different.  Doing a
927 non-dry-run dgit fetch first will help.
929 \fBdgit\fP(7),
930 \fBcurl\fP(1),
931 \fBdput\fP(1),
932 \fBdebsign\fP(1),
933 \fBgit-config\fP(1),
934 \fBgit-buildpackage\fP(1),
935 \fBdpkg-buildpackage\fP(1),
936 .br