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