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