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