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