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