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