chiark / gitweb /
[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.
337 .TP
338 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
339 Import a Debian-format source package,
340 specified by its .dsc,
341 into git,
342 the way dgit fetch would do.
344 This does about half the work of dgit fetch:
345 it will convert the .dsc into a new, orphan git branch.
346 Since dgit has no access to a corresponding source package archive
347 or knowledge of the history
348 it does not consider whether this version is newer
349 than any previous import
350 or corresponding git branches;
351 and it therefore does not
352 make a pseudomerge to bind the import
353 into any existing git history.
355 Because a .dsc can contain a Dgit field naming a git commit
356 (which you might not have),
357 and specifying where to find that commit
358 (and any history rewrite table),
359 import-dsc might need online access.
360 If this is a problem
361 (or dgit's efforts to find the commit fail),
362 consider --no-chase-dsc-distro
363 or --force-import-dsc-with-dgit-field.
365 There is only only sub-option:
367 .B --require-valid-signature
368 causes dgit to insist that the signature on the .dsc is valid
369 (using the same criteria as dpkg-source -x).
370 Otherwise, dgit tries to verify the signature but
371 the outcome is reported only as messages to stderr.
373 If
374 .I branch
375 is prefixed with
376 .B +
377 then if it already exists, it will be simply ovewritten,
378 no matter its existing contents.
379 If
380 .I branch
381 is prefixed with
382 .B ..
383 then if it already exists
384 and dgit actually imports the dsc
385 (rather than simply reading the git commit out of the Dgit field),
386 dgit will make a pseudomerge
387 so that the result is necessarily fast forward
388 from the existing branch.
389 Otherwise, if branch already exists,
390 dgit will stop with an error message.
392 If
393 .I branch
394 does not start with refs/, refs/heads/ is prepended.
395 .TP
396 .B dgit version
397 Prints version information and exits.
398 .TP
399 .BI "dgit clone-dgit-repos-server" " destdir"
400 Tries to fetch a copy of the source code for the dgit-repos-server,
401 as actually being used on the dgit git server, as a git tree.
402 .TP
403 .BI "dgit print-dgit-repos-server-source-url"
404 Prints the url used by dgit clone-dgit-repos-server.
405 This is hopefully suitable for use as a git remote url.
406 It may not be useable in a browser.
407 .TP
408 .BI "dgit print-dpkg-source-ignores"
409 Prints the -i and -I arguments which must be passed to dpkg-souce
410 to cause it to exclude exactly the .git diredcory
411 and nothing else.
412 The separate arguments are unquoted, separated by spaces,
413 and do not contain spaces.
415 .TP
416 .BR --dry-run " | " -n
417 Go through the motions, fetching all information needed, but do not
418 actually update the output(s).  For push, dgit does
419 the required checks and leaves the new .dsc in a temporary file,
420 but does not sign, tag, push or upload.
421 .TP
422 .BR --damp-run " | " -L
423 Go through many more of the motions: do everything that doesn't
424 involve either signing things, or making changes on the public
425 servers.
426 .TP
427 .BI -k keyid
428 Use
429 .I keyid
430 for signing the tag and the upload.  The default comes from the
431 distro's
432 .B keyid
433 config setting (see CONFIGURATION, below), or failing that, the
434 uploader trailer line in debian/changelog.
435 .TP
436 .BR --no-sign
437 does not sign tags or uploads (meaningful only with push).
438 .TP
439 .TP
440 .BI -p package
441 Specifies that we should process source package
442 .I package
443 rather than looking in debian/control or debian/changelog.
444 Valid with dgit fetch and dgit pull, only.
445 .TP
446 .BR --clean=git " | " -wg
447 Use
448 .BR "git clean -xdf"
449 to clean the working tree,
450 rather than running the package's rules clean target.
452 This will delete all files which are not tracked by git.
453 (Including any files you forgot to git add.)
455 .BI --clean= ...
456 options other than dpkg-source
457 are useful when the package's clean target is troublesome, or
458 to avoid needing the build-dependencies.
459 .TP
460 .BR --clean=git-ff " | " -wgf
461 Use
462 .BR "git clean -xdff"
463 to clean the working tree.
464 Like
465 git clean -xdf
466 but it also removes any subdirectories containing different git
467 trees (which only unusual packages are likely to create).
468 .TP
469 .BR --clean=check " | " -wc
470 Merely check that the tree is clean (does not contain uncommitted
471 files).
472 Avoids running rules clean,
473 and can avoid needing the build-dependencies.
474 .TP
475 .BR --clean=none " | " -wn
476 Do not clean the tree, nor check that it is clean.
477 Avoids running rules clean,
478 and can avoid needing the build-dependencies.
479 If there are
480 files which are not in git, or if the build creates such files, a
481 subsequent dgit push will fail.
482 .TP
483 .BR --clean=dpkg-source " | " -wd
484 Use dpkg-buildpackage to do the clean, so that the source package
485 is cleaned by dpkg-source running the package's clean target.
486 This is the default.
487 Requires the package's build dependencies.
488 .TP
489 .BR --clean=dpkg-source-d " | " -wdd
490 Use
491 .B dpkg-buildpackage -d
492 to do the clean,
493 so that the source package
494 is cleaned by dpkg-source running the package's clean target.
495 The build-dependencies are not checked (due to
496 .BR -d ),
497 which violates policy, but may work in practice.
498 .TP
499 .BR -N " | " --new
500 The package is or may be new in this suite.  Without this, dgit will
501 refuse to push.  It may (for Debian, will) be unable to access the git
502 history for any packages which have been newly pushed and have not yet
503 been published.
504 .TP
505 .BR --ignore-dirty
506 Do not complain if the working tree does not match your git HEAD.
507 This can be useful with build, if you plan to commit later.  (dgit
508 push will still ensure that the .dsc you upload and the git tree
509 you push are identical, so this option won't make broken pushes.)
510 .TP
511 .BR --overwrite [=\fIprevious-version\fR]
512 Declare that even though your git branch may not be a descendant
513 of the version in the archive
514 according to the revision history,
515 it really does contain
516 all the (wanted) changes from that version.
518 This option is useful if you are the maintainer, and you have
519 incorporated NMU changes into your own git workflow in a way that
520 doesn't make your branch a fast forward from the NMU.
522 .I previous-version
523 ought to be the version currently in the archive.  If
524 .I previous-version
525 is not
526 specified, dgit will check that the version in the archive is
527 mentioned in your debian/changelog.
528 (This will avoid losing
529 changes unless someone committed to git a finalised changelog
530 entry, and then made later changes to that version.)
532 dgit push --overwrite
533 will, if necessary, make a
534 pseudo-merge (that is, something that looks like the result
535 of git merge -s ours) to stitch the archive's version into your own
536 git history, so that your push is a fast forward from the archive.
538 (In quilt mode
539 .BR gbp ", " dpm " or " unpatched ,
540 implying a split between the dgit view and the
541 maintainer view, the pseudo-merge will appear only in the dgit view.)
542 .TP
543 .BR --delayed =\fIdays\fR
544 Upload to a DELAYED queue.
547 If the maintainer responds by cancelling
548 your upload from the queue,
549 and does not make an upload of their own,
550 this will not rewind the git branch on the dgit git server.
551 Other dgit users will then see your push
552 (with a warning message from dgit)
553 even though the maintainer wanted to abolish it.
554 Such users might unwittingly reintroduce your changes.
556 If this situation arises,
557 someone should make a suitable dgit push
558 to update the contents of dgit-repos
559 to a version without the controversial changes.
560 .TP
561 .BR --no-chase-dsc-distro
562 Tells dgit not to look online
563 for additional git repositories
564 containing information about a particular .dsc being imported.
565 Chasing is the default.
567 For most operations
568 (such as fetch and pull),
569 disabling chasing
570 means dgit will access only the git server
571 for the distro you are directly working with,
572 even if the .dsc was copied verbatim from another distro.
573 For import-dsc,
574 disabling chasing
575 means dgit will work completely offline.
577 Disabling chasing can be hazardous:
578 if the .dsc names a git commit which has been rewritten
579 by those in charge of the distro,
580 this option may prevent that rewrite from being effective.
581 Also,
582 it can mean that
583 dgit fails to find necessary git commits.
584 .TP
585 .BR --dgit-view-save= \fIbranch\fR|\fIref\fR
586 Specifies that when a split view quilt mode is in operation,
587 and dgit calculates
588 (or looks up in its cache)
589 a dgit view corresponding to your HEAD,
590 the dgit view will be left in
591 .IR ref .
592 The specified ref is unconditionally overwritten,
593 so don't specify a branch you want to keep.
595 This option is effective only with the following operations:
596 quilt-fixup; push; all builds.
597 And it is only effective with
598 --[quilt=]gbp,
599 --[quilt=]dpm,
600 --quilt=unpatched.
602 If ref does not start with refs/
603 it is taken to to be a branch -
604 i.e. refs/heads/ is prepended.
605 .TP
606 .BI --deliberately- something
607 Declare that you are deliberately doing
608 .IR something .
609 This can be used to override safety catches, including safety catches
610 which relate to distro-specific policies.
611 The use of --deliberately is declared and published in the signed tags
612 generated for you by dgit,
613 so that the archive software can give effect to your intent,
614 and
615 for the benefit humans looking at the history.
616 The meanings of
617 .IR something s
618 understood in the context of Debian are discussed below:
619 .TP
620 .BR --deliberately-not-fast-forward
621 Declare that you are deliberately rewinding history.  When pushing to
622 Debian, use this when you are making a renewed upload of an entirely
623 new source package whose previous version was not accepted for release
624 from NEW because of problems with copyright or redistributibility.
626 In split view quilt modes,
627 this also prevents the construction by dgit of a pseudomerge
628 to make the dgit view fast forwarding.
629 Normally only one of
630 --overwrite (which creates a suitable pseudomerge)
631 and
632 --deliberately-not-fast-forward
633 (which suppresses the pseudomerge and the fast forward checks)
634 should be needed;
635 --overwrite is usually better.
636 .TP
637 .BR --deliberately-include-questionable-history
638 Declare that you are deliberately including, in the git history of
639 your current push, history which contains a previously-submitted
640 version of this package which was not approved (or has not yet been
641 approved) by the ftpmasters.  When pushing to Debian, only use this
642 option after verifying that: none of the rejected-from-NEW (or
643 never-accepted) versions in the git history of your current push, were
644 rejected by ftpmaster for copyright or redistributability reasons.
645 .TP
646 .BR --deliberately-fresh-repo
647 Declare that you are deliberately rewinding history and want to
648 throw away the existing repo.  Not relevant when pushing to Debian,
649 as the Debian server will do this automatically when necessary.
650 .TP
651 .BR --quilt=linear
652 When fixing up source format `3.0 (quilt)' metadata, insist on
653 generating a linear patch stack: one new patch for each relevant
654 commit.
655 If such a stack cannot be generated, fail.
656 This is the default for Debian.
658 HEAD should be a series of plain commits
659 (not touching debian/patches/),
660 and pseudomerges,
661 with as ancestor a patches-applied branch.
662 .TP
663 .BR --quilt=auto
664 When fixing up source format `3.0 (quilt)' metadata, prefer to
665 generate a linear patch stack
666 (as with --quilt=auto)
667 but if that doesn't seem possible,
668 try to generate a single squashed patch for all the changes made in git
669 (as with --quilt=smash).
670 This is not a good idea for an NMU in Debian.
671 .TP
672 .BR --quilt=smash
673 When fixing up source format `3.0 (quilt)' metadata,
674 generate a single additional patch for all the changes made in git.
675 This is not a good idea for an NMU in Debian.
677 (If HEAD has any in-tree patches already, they must apply cleanly.
678 This will be the case for any trees produced by dgit fetch or clone;
679 if you do not change the upstream version
680 nor make changes in debian/patches,
681 it will remain true.)
682 .TP
683 .BR --quilt=nofix
684 Check whether source format `3.0 (quilt)' metadata would need fixing
685 up, but, if it does, fail.  You must then fix the metadata yourself
686 somehow before pushing.  (NB that dpkg-source --commit will not work
687 because the dgit git tree does not have a
688 .B .pc
689 directory.)
690 .TP
691 .BR --quilt=nocheck " | " --no-quilt-fixup
692 Do not check whether up source format `3.0 (quilt)' metadata needs
693 fixing up.  If you use this option and the metadata did in fact need
694 fixing up, dgit push will fail.
695 .TP
696 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
697 Tell dgit that you are using a nearly-dgit-compatible git branch,
698 aka a
699 .BR "maintainer view" ,
700 and
701 do not want your branch changed by dgit.
703 .B --gbp
704 (short for
705 .BR --quilt=gbp )
706 is for use with git-buildpackage.
707 Your HEAD is expected to be
708 a patches-unapplied git branch, except that it might contain changes
709 to upstream .gitignore files.  This is the default for dgit gbp-build.
711 .B --dpm
712 (short for
713 .BR --quilt=dpm )
714 is for use with git-dpm.
715 Your HEAD is expected to be
716 a patches-applied git branch,
717 except that it might contain changes to upstream .gitignore files.
719 .B --quilt=unapplied
720 specifies that your HEAD is a patches-unapplied git branch (and
721 that any changes to upstream .gitignore files are represented as
722 patches in debian/patches).
724 With --quilt=gbp|dpm|unapplied,
725 dgit push (or precursors like quilt-fixup and build) will automatically
726 generate a conversion of your git branch into the right form.
727 dgit push will push the
728 dgit-compatible form (the
729 .BR "dgit view" )
730 to the dgit git server.
731 The dgit view will be visible to you
732 in the dgit remote tracking branches, but your own branch will
733 not be modified.
734 dgit push will create a tag
735 .BI debian/ version
736 for the maintainer view, and the dgit tag
737 .BI archive/debian/ version
738 for the dgit view.
739 dgit quilt-fixup will merely do some checks,
740 and cache the maintainer view.
742 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
743 This is because it is not always possible to tell: a patches-unapplied
744 git branch of a package with one patch, for example, looks very like
745 a patches-applied branch where the user has used git revert to
746 undo the patch, expecting to actually revert it.
747 However, if you fail to specify the right \-\-quilt option,
748 and you aren't too lucky, dgit will notice the problem and stop,
749 with a useful hint. 
750 .TP
751 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
752 Specifies that the suite to be operated on is part of distro
753 .IR distro .
754 This overrides the default value found from the git config option
755 .BR dgit-suite. \fIsuite\fR .distro .
756 The only effect is that other configuration variables (used
757 for accessing the archive and dgit-repos) used are
758 .BR dgit-distro. \fIdistro\fR .* .
760 If your suite is part of a distro that dgit already knows about, you
761 can use this option to make dgit work even if your dgit doesn't know
762 about the suite.  For example, specifying
763 .B -ddebian
764 will work when the suite is an unknown suite in the Debian archive.
766 To define a new distro it is necessary to define methods and URLs
767 for fetching (and, for dgit push, altering) a variety of information both
768 in the archive and in dgit-repos.
769 How to set this up is not yet documented.
770 .TP
771 .BI -C changesfile
772 Specifies the .changes file which is to be uploaded.  By default
773 dgit push looks for single .changes file in the parent directory whose
774 filename suggests it is for the right package and version.
776 If the specified
777 .I changesfile
778 pathname contains slashes, the directory part is also used as
779 the value for
780 .BR --build-products-dir ;
781 otherwise, the changes file is expected in that directory (by
782 default, in
783 .BR .. ).
784 .TP
785 .B --rm-old-changes
786 When doing a build, delete any changes files matching
787 .IB package _ version _*.changes
788 before starting.  This ensures that
789 dgit push (and dgit sbuild) will be able to unambigously
790 identify the relevant changes files from the most recent build, even
791 if there have been previous builds with different tools or options.
792 The default is not to remove, but
793 .B \-\-no-rm-old-changes
794 can be used to override a previous \-\-rm-old-changes
795 or the .rm-old-changes configuration setting.
797 Note that \fBdgit push-source\fR will always find the right .changes,
798 regardless of this option.
799 .TP
800 .BI --build-products-dir= directory
801 Specifies where to find the built files to be uploaded.
802 By default, dgit looks in the parent directory
803 .RB ( .. ).
804 .TP
805 .BI --no-rm-on-error
806 Do not delete the destination directory if clone fails.
807 .TP
808 .BI --dep14tag
809 Generates a DEP-14 tag (eg
810 .BR debian/ \fIversion\fR)
811 as well as a dgit tag (eg
812 .BR archive/debian/ \fIversion\fR)
813 where possible.  This is the default.
814 .TP
815 .BI --no-dep14tag
816 Do not generate a DEP-14 tag, except in split quilt view mode.
817 (On servers where only the old tag format is supported,
818 the dgit tag will have the DEP-14 name.
819 This option does not prevent that.)
820 .TP
821 .BI --dep14tag-always
822 Insist on generating a DEP-14 tag
823 as well as a dgit tag.
824 If the server does not support that, dgit push will fail.
825 .TP
826 .BI -D
827 Prints debugging information to stderr.  Repeating the option produces
828 more output (currently, up to -DDDD is meaningfully different).
829 .TP
830 .BI -c name = value
831 Specifies a git configuration option, to be used for this run.
832 dgit itself is also controlled by git configuration options.
833 .TP
834 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
835 Specifies the
836 .BI -v version
837 option to pass to dpkg-genchanges, during builds.  Changes (from
838 debian/changelog) since this version will be included in the built
839 changes file, and hence in the upload.  If this option is not
840 specified, dgit will query the archive and use the latest version
841 uploaded to the intended suite.
843 Specifying
844 .B _
845 inhibits this, so that no -v option will be passed to dpkg-genchanges
846 (and as a result, only the last stanza from debian/changelog will
847 be used for the build and upload).
848 .TP
849 .RI \fB-m\fR maintaineraddress
850 Passed to dpkg-genchanges (eventually).
851 .TP
852 .RI \fB--ch:\fR option
853 Specifies a single additional option to pass, eventually, to
854 dpkg-genchanges.
856 Options which are safe to pass include
857 .BR -C
858 (and also
859 .BR "-si -sa -sd"
860 although these should never be necessary with Debian since dgit
861 automatically calculates whether .origs need to be uploaded.)
863 For other options the caveat below applies.
864 .TP
865 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
866 Specifies a single additional option to pass to
867 .BR curl ,
868 .BR dput ,
869 .BR debsign ,
870 .BR dpkg-source ,
871 .BR dpkg-buildpackage ,
872 .BR dpkg-genchanges ,
873 .BR sbuild ,
874 .BR ssh ,
875 .BR dgit ,
876 .BR git-debrebase ,
877 .BR apt-get ,
878 .BR apt-cache ,
879 .BR gbp-pq ,
880 .BR gbp-build ,
881 or
882 .BR mergechanges .
883 Can be repeated as necessary.
885 Use of this ability should not normally be necessary.
886 It is provided for working around bugs,
887 or other unusual situations.
888 If you use these options,
889 you may violate dgit's assumptions
890 about the behaviour of its subprograms
891 and cause lossage.
893 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
894 the option applies only when the program is invoked directly by dgit.
895 Usually, for passing options to dpkg-genchanges, you should use
896 .BR --ch: \fIoption\fR.
898 Specifying --git is not effective for some lower-level read-only git
899 operations performed by dgit, and also not when git is invoked by
900 another program run by dgit.
902 See notes below regarding ssh and dgit.
904 NB that --gpg:option is not supported (because debsign does not
905 have that facility).
906 But see
907 .B -k
908 and the
909 .B keyid
910 distro config setting.
911 .TP
912 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
913 Specifies alternative programs to use instead of
914 .BR curl ,
915 .BR dput ,
916 .BR debsign ,
917 .BR dpkg-source ,
918 .BR dpkg-buildpackage ,
919 .BR dpkg-genchanges ,
920 .BR sbuild ,
921 .BR gpg ,
922 .BR ssh ,
923 .BR dgit ,
924 .BR git-debrebase ,
925 .BR apt-get ,
926 .BR apt-cache ,
927 .BR git ,
928 .BR gbp-pq ,
929 .BR gbp-build ,
930 or
931 .BR mergechanges .
933 For
934 .BR dpkg-buildpackage ,
935 .BR dpkg-genchanges ,
936 .B mergechanges
937 and
938 .BR sbuild ,
939 this applies only when the program is invoked directly by dgit.
941 For
942 .BR dgit ,
943 specifies the command to run on the remote host when dgit
944 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
945 itself as the EDITOR for dpkg-source --commit; this is done using
946 argv[0], and is not affected by --dgit=).
948 .BR gbp-build 's
949 value
950 is used instead of gbp build or git-buildpackage.  (The default is
951 the latter unless the former exists on PATH.)
952 .BR gbp-pq 's
953 value
954 is used instead of gbp pq.
955 In both cases,
956 unusually, the specified value is split on whitespace
957 to produce a command and possibly some options and/or arguments.
959 For
960 .BR ssh ,
961 the default value is taken from the
963 or
964 .B GIT_SSH
965 environment variables, if set (see below).  And, for ssh, when accessing the
966 archive and dgit-repos, this command line setting is overridden by the
967 git config variables
968 .BI dgit-distro. distro .ssh
969 and
970 .B .dgit.default.ssh
971 (which can in turn be overridden with -c).  Also, when dgit is using
972 git to access dgit-repos, only git's idea of what ssh to use (eg,
973 .BR GIT_SSH )
974 is relevant.
975 .TP
976 .BI --existing-package= package
977 dgit push needs to canonicalise the suite name.  Sometimes, dgit
978 lacks a way to ask the archive to do this without knowing the
979 name of an existing package.  Without --new we can just use the
980 package we are trying to push.  But with --new that will not work, so
981 we guess
982 .B dpkg
983 or use the value of this option.  This option is not needed with the
984 default mechanisms for accessing the archive.
985 .TP
986 .BR -h | --help
987 Print a usage summary.
988 .TP
989 .BI --initiator-tempdir= directory
990 dgit rpush uses a temporary directory on the invoking (signing) host.
991 This option causes dgit to use
992 .I directory
993 instead.  Furthermore, the specified directory will be emptied,
994 removed and recreated before dgit starts, rather than removed
995 after dgit finishes.  The directory specified must be an absolute
996 pathname.
997 .TP
998 .BI --force- something
999 Instructs dgit to try to proceed despite detecting
1000 what it thinks is going to be a fatal problem.
1001 .B This is probably not going to work.
1002 These options are provided as an escape hatch,
1003 in case dgit is confused.
1004 (They might also be useful for testing error cases.)
1005 .TP
1006 .B --force-import-dsc-with-dgit-field
1007 Tell dgit import-dsc to treat a .dsc with a Dgit field
1008 like one without it.
1009 The result is a fresh import,
1010 discarding the git history
1011 that the person who pushed that .dsc was working with.
1012 .TP
1013 .B --force-unrepresentable
1014 Carry on even if
1015 dgit thinks that your git tree contains changes
1016 (relative to your .orig tarballs)
1017 which dpkg-source is not able to represent.
1018 Your build or push will probably fail later.
1019 .TP
1020 .B --force-changes-origs-exactly
1021 Use the set of .origs specified in your .changes, exactly,
1022 without regard to what is in the archive already.
1023 The archive may well reject your upload.
1024 .TP
1025 .B --force-unsupported-source-format
1026 Carry on despite dgit not understanding your source package format.
1027 dgit will probably mishandle it.
1028 .TP
1029 .B --force-dsc-changes-mismatch
1030 Do not check whether .dsc and .changes match.
1031 The archive will probably reject your upload.
1032 .TP
1033 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
1034 Force on or off the use of the absurd git-apply emulation
1035 when running gbp pq import
1036 when importing a package from a .dsc.
1037 See Debian bug #841867.
1039 dgit can be configured via the git config system.
1040 You may set keys with git-config (either in system-global or per-tree
1041 configuration), or provide
1042 .BI -c key = value
1043 on the dgit command line.
1044 .LP
1045 Settings likely to be useful for an end user include:
1046 .TP
1047 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
1048 Specifies the distro for a suite.  dgit keys off the suite name (which
1049 appears in changelogs etc.), and uses that to determine the distro
1050 which is involved.  The config used is thereafter that for the distro.
1052 .I suite
1053 may be a glob pattern.
1054 .TP
1055 .BI dgit.default.distro " distro"
1056 The default distro for an unknown suite.
1057 .TP
1058 .BI dgit.default.default-suite " suite"
1059 The default suite (eg for clone).
1060 .TP
1061 .BR dgit.default. *
1062 for each
1063 .BR dgit-distro. \fIdistro\fR . *,
1064 the default value used if there is no distro-specific setting.
1065 .TP
1066 .BR dgit-distro. \fIdistro\fR .clean-mode
1067 One of the values for the command line --clean= option; used if
1068 --clean is not specified.
1069 .TP
1070 .BR dgit-distro. \fIdistro\fR .quilt-mode
1071 One of the values for the command line --quilt= option; used if
1072 --quilt is not specified.
1073 .TP
1074 .BR dgit-distro. \fIdistro\fR .rm-old-changes
1075 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
1076 is specified.  The default is not to remove.
1077 .TP
1078 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
1079 Whether you have push access to the distro.
1080 For Debian, it is OK to use auto, which uses readonly mode if you are
1081 not pushing right now;
1082 but, setting this to false will avoid relying on the mirror of the dgit
1083 git repository server.
1084 .TP
1085 .BI dgit-distro. distro .keyid
1086 See also
1087 .BR -k .
1088 .TP
1089 .BI dgit-distro. distro .mirror " url"
1090 .TP
1091 .BI dgit-distro. distro .username
1092 Not relevant for Debian.
1093 .TP
1094 .BI dgit-distro. distro .upload-host
1095 Might be useful if you have an intermediate queue server.
1096 .TP
1097 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
1098 Values to configure for and in new git trees.  If
1099 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
1100 used, respectively.  Only used if .setup-usermail is not disabled.
1101 .TP
1102 .BI dgit-distro. distro .setup-useremail
1103 Whether to set and in new git trees.
1104 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
1105 .TP
1106 .BI dgit-distro. distro .setup-mergechangelogs
1107 Whether to setup a merge driver which uses dpkg-mergechangelogs for
1108 debian/changelog.  True by default.  Ignored for dgit
1109 setup-mergechangelogs, which does it anyway.
1110 .TP
1111 .BI dgit-distro. distro .setup-gitattributes
1112 Whether to configure .git/info/attributes
1113 to suppress checkin/checkout file content transformations
1114 in new git trees.
1115 True by default.  Ignored for dgit setup-gitattributes, which does it anyway.
1116 .TP
1117 .BI dgit-distro. distro .cmd- cmd
1118 Program to use instead of
1119 .IR cmd .
1120 Works like
1121 .BR -- \fIcmd\fR = "... ."
1122 .TP
1123 .BI dgit-distro. distro .opts- cmd
1124 Extra options to pass to
1125 .IR cmd .
1126 Works like
1127 .BR -- \fIcmd\fR : "... ."
1128 To pass several options, configure multiple values in git config
1129 (with git config --add).  The options for
1130 .BI dgit.default.opts- cmd
1131 .BI dgit-distro. distro /push.opts- cmd
1132 and are all used, followed by options from dgit's command line.
1134 There are many other settings which specify how a particular distro's
1135 services (archive and git) are provided.  These should not normally be
1136 adjusted, but are documented for the benefit of distros who wish to
1137 adopt dgit.
1138 .TP
1139 .BI dgit-distro. distro .nominal-distro
1140 Shown in git tags, Dgit fields, and so on.
1141 .TP
1142 .BI dgit-distro. distro .alias-canon
1143 Used for all access configuration lookup.
1144 .TP
1145 .BR dgit-distro. \fIdistro\fR /push. *
1146 If set, overrides corresponding non \fB/push\fR config when
1147 .BR readonly=false ,
1148 or when pushing and
1149 .BR readonly=auto .
1150 .TP
1151 .BI dgit-distro. distro .git-url
1152 .TP
1153 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1154 .TP
1155 .BI dgit-distro. distro .git-proto
1156 .TP
1157 .BI dgit-distro. distro .git-path
1158 .TP
1159 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1160 .TP
1161 .BI dgit-distro. distro .git-check-suffix
1162 .TP
1163 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1164 .TP
1165 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1166 .TP
1167 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
1168 .TP
1169 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1170 .TP
1171 .BI dgit-distro. distro .madison-distro
1172 .TP
1173 .BI dgit-distro. distro .archive-query-default-component
1174 .TP
1175 .BI dgit-distro. distro .dgit-tag-format
1176 .TP
1177 .BR dgit-distro. \fIdistro\fR .dep14tag " " want | no | always
1178 .TP
1179 .BI dgit-distro. distro .ssh
1180 .TP
1181 .BI dgit-distro. distro .sshpsql-dbname
1182 .TP
1183 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1184 .TP
1185 .BI dgit-distro. distro .backports-quirk
1186 .TP
1187 .BI dgit-distro. distro .rewrite-map-enable
1188 .TP
1189 .BI dgit.default.old-dsc-distro
1190 .TP
1191 .BI dgit.dsc-url-proto-ok. protocol
1192 .TP
1193 .BI dgit.dsc-url-proto-ok.bad-syntax
1194 .TP
1195 .BI dgit.default.dsc-url-proto-ok
1196 .TP
1197 .BR dgit.vcs-git.suites " \fIsuite\fR[" ; ...]
1199 .TP
1200 .BR DGIT_SSH ", " GIT_SSH
1201 specify an alternative default program (and perhaps arguments) to use
1202 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
1203 if it contains any whitespace will be passed to the shell.  GIT_SSH
1204 specifies just the program; no arguments can be specified, so dgit
1205 interprets it the same way as git does.
1206 See
1207 also the --ssh= and --ssh: options.
1208 .TP
1210 Default git and for new trees.  See
1211 .BR "dgit setup-new-tree" .
1212 .TP
1213 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1214 and other subprograms and modules used by dgit are affected by various
1215 environment variables.  Consult the documentaton for those programs
1216 for details.
1217 .SH BUGS
1218 There should be
1219 a `dgit rebase-prep' command or some such to turn a
1220 fast-forwarding branch containing pseudo-merges
1221 back into a rebasing patch stack.
1222 It might have to leave a note
1223 for a future dgit push.
1225 If the dgit push fails halfway through,
1226 it is not necessarily restartable and
1227 idempotent.
1228 It would be good to check that the proposed signing key is
1229 available before starting work.
1231 dgit's build functions, and dgit push, may make changes to
1232 your current HEAD.  Sadly this is necessary for packages in the `3.0
1233 (quilt)' source format.  This is ultimately due to what I consider
1234 design problems in quilt and dpkg-source.
1236 --dry-run does not always work properly, as not doing some of the git
1237 fetches may result in subsequent actions being different.  Doing a
1238 non-dry-run dgit fetch first will help.
1239 --damp-run is likely to work much better.
1241 \fBdgit\fP(7),
1242 \fBdgit-*\fP(7),
1243 \fBcurl\fP(1),
1244 \fBdput\fP(1),
1245 \fBdebsign\fP(1),
1246 \fBgit-config\fP(1),
1247 \fBgit-buildpackage\fP(1),
1248 \fBdpkg-buildpackage\fP(1),
1249 .br