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