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