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