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