chiark / gitweb /
New option --dgit-view-save= for split view quilt modes.
[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 --dgit-view-save= \fIbranch\fR|\fIref\fR
433 Specifies that when a split view quilt mode is in operation,
434 and dgit calculates
435 (or looks up in its cache)
436 a dgit view corresponding to your HEAD,
437 the dgit view will be left in
438 .IR ref .
439 The specified ref is unconditionally overwritten,
440 so don't specify a branch you want to keep.
442 This option is effective only with the following operations:
443 quilt-fixup; push; all builds.
444 And it is only effective with
445 --[quilt=]gbp,
446 --[quilt=]dpm,
447 --quilt=unpatched.
449 If ref does not start with refs/
450 it is taken to to be a branch -
451 i.e. refs/heads/ is prepended.
452 .TP
453 .BI --deliberately- something
454 Declare that you are deliberately doing
455 .IR something .
456 This can be used to override safety catches, including safety catches
457 which relate to distro-specific policies.
458 The use of --deliberately is declared and published in the signed tags
459 generated for you by dgit,
460 so that the archive software can give effect to your intent,
461 and
462 for the benefit humans looking at the history.
463 The meanings of
464 .IR something s
465 understood in the context of Debian are discussed below:
466 .TP
467 .BR --deliberately-not-fast-forward
468 Declare that you are deliberately rewinding history.  When pushing to
469 Debian, use this when you are making a renewed upload of an entirely
470 new source package whose previous version was not accepted for release
471 from NEW because of problems with copyright or redistributibility.
472 .TP
473 .BR --deliberately-include-questionable-history
474 Declare that you are deliberately including, in the git history of
475 your current push, history which contains a previously-submitted
476 version of this package which was not approved (or has not yet been
477 approved) by the ftpmasters.  When pushing to Debian, only use this
478 option after verifying that: none of the rejected-from-NEW (or
479 never-accepted) versions in the git history of your current push, were
480 rejected by ftpmaster for copyright or redistributability reasons.
481 .TP
482 .BR --deliberately-fresh-repo
483 Declare that you are deliberately rewinding history and want to
484 throw away the existing repo.  Not relevant when pushing to Debian,
485 as the Debian server will do this automatically when necessary.
486 .TP
487 .BR --quilt=linear
488 When fixing up source format `3.0 (quilt)' metadata, insist on
489 generating a linear patch stack: one new patch for each relevant
490 commit.
491 If such a stack cannot be generated, fail.
492 This is the default for Debian.
494 HEAD should be a series of plain commits
495 (not touching debian/patches/),
496 and pseudomerges,
497 with as ancestor a patches-applied branch.
498 .TP
499 .BR --quilt=auto
500 When fixing up source format `3.0 (quilt)' metadata, prefer to
501 generate a linear patch stack
502 (as with --quilt=auto)
503 but if that doesn't seem possible,
504 try to generate a single squashed patch for all the changes made in git
505 (as with --quilt=smash).
506 This is not a good idea for an NMU in Debian.
507 .TP
508 .BR --quilt=smash
509 When fixing up source format `3.0 (quilt)' metadata,
510 generate a single additional patch for all the changes made in git.
511 This is not a good idea for an NMU in Debian.
513 (If HEAD has any in-tree patches already, they must apply cleanly.
514 This will be the case for any trees produced by dgit fetch or clone;
515 if you do not change the upstream version
516 nor make changes in debian/patches,
517 it will remain true.)
518 .TP
519 .BR --quilt=nofix
520 Check whether source format `3.0 (quilt)' metadata would need fixing
521 up, but, if it does, fail.  You must then fix the metadata yourself
522 somehow before pushing.  (NB that dpkg-source --commit will not work
523 because the dgit git tree does not have a
524 .B .pc
525 directory.)
526 .TP
527 .BR --quilt=nocheck " | " --no-quilt-fixup
528 Do not check whether up source format `3.0 (quilt)' metadata needs
529 fixing up.  If you use this option and the metadata did in fact need
530 fixing up, dgit push will fail.
531 .TP
532 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
533 Tell dgit that you are using a nearly-dgit-compatible git branch,
534 aka a
535 .BR "maintainer view" ,
536 and
537 do not want your branch changed by dgit.
539 .B --gbp
540 (short for
541 .BR --quilt=gbp )
542 is for use with git-buildpackage.
543 Your HEAD is expected to be
544 a patches-unapplied git branch, except that it might contain changes
545 to upstream .gitignore files.  This is the default for dgit gbp-build.
547 .B --dpm
548 (short for
549 .BR --quilt=dpm )
550 is for use with git-dpm.
551 Your HEAD is expected to be
552 a patches-applied git branch,
553 except that it might contain changes to upstream .gitignore files.
555 .B --quilt=unapplied
556 specifies that your HEAD is a patches-unapplied git branch (and
557 that any changes to upstream .gitignore files are represented as
558 patches in debian/patches).
560 With --quilt=gbp|dpm|unapplied,
561 dgit push (or precursors like quilt-fixup and build) will automatically
562 generate a conversion of your git branch into the right form.
563 dgit push will push the
564 dgit-compatible form (the
565 .BR "dgit view" )
566 to the dgit git server.
567 The dgit view will be visible to you
568 in the dgit remote tracking branches, but your own branch will
569 not be modified.
570 dgit push will create a tag
571 .BI debian/ version
572 for the maintainer view, and the dgit tag
573 .BI archive/debian/ version
574 for the dgit view.
575 dgit quilt-fixup will merely do some checks,
576 and cache the maintainer view.
578 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
579 This is because it is not always possible to tell: a patches-unapplied
580 git branch of a package with one patch, for example, looks very like
581 a patches-applied branch where the user has used git revert to
582 undo the patch, expecting to actually revert it.
583 However, if you fail to specify the right \-\-quilt option,
584 and you aren't too lucky, dgit will notice the problem and stop,
585 with a useful hint. 
586 .TP
587 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
588 Specifies that the suite to be operated on is part of distro
589 .IR distro .
590 This overrides the default value found from the git config option
591 .BR dgit-suite. \fIsuite\fR .distro .
592 The only effect is that other configuration variables (used
593 for accessing the archive and dgit-repos) used are
594 .BR dgit-distro. \fIdistro\fR .* .
596 If your suite is part of a distro that dgit already knows about, you
597 can use this option to make dgit work even if your dgit doesn't know
598 about the suite.  For example, specifying
599 .B -ddebian
600 will work when the suite is an unknown suite in the Debian archive.
602 To define a new distro it is necessary to define methods and URLs
603 for fetching (and, for dgit push, altering) a variety of information both
604 in the archive and in dgit-repos.
605 How to set this up is not yet documented.
606 .TP
607 .BI -C changesfile
608 Specifies the .changes file which is to be uploaded.  By default
609 dgit push looks for single .changes file in the parent directory whose
610 filename suggests it is for the right package and version.
612 If the specified
613 .I changesfile
614 pathname contains slashes, the directory part is also used as
615 the value for
616 .BR --build-products-dir ;
617 otherwise, the changes file is expected in that directory (by
618 default, in
619 .BR .. ).
620 .TP
621 .B --rm-old-changes
622 When doing a build, delete any changes files matching
623 .IB package _ version _*.changes
624 before starting.  This ensures that
625 dgit push (and dgit sbuild) will be able to unambigously
626 identify the relevant changes files from the most recent build, even
627 if there have been previous builds with different tools or options.
628 The default is not to remove, but
629 .B \-\-no-rm-old-changes
630 can be used to override a previous \-\-rm-old-changes
631 or the .rm-old-changes configuration setting.
632 .TP
633 .BI --build-products-dir= directory
634 Specifies where to find the built files to be uploaded.
635 By default, dgit looks in the parent directory
636 .RB ( .. ).
637 .TP
638 .BI --no-rm-on-error
639 Do not delete the destination directory if clone fails.
640 .TP
641 .BI -D
642 Prints debugging information to stderr.  Repeating the option produces
643 more output (currently, up to -DDDD is meaningfully different).
644 .TP
645 .BI -c name = value
646 Specifies a git configuration option, to be used for this run.
647 dgit itself is also controlled by git configuration options.
648 .TP
649 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
650 Specifies the
651 .BI -v version
652 option to pass to dpkg-genchanges, during builds.  Changes (from
653 debian/changelog) since this version will be included in the built
654 changes file, and hence in the upload.  If this option is not
655 specified, dgit will query the archive and use the latest version
656 uploaded to the intended suite.
658 Specifying
659 .B _
660 inhibits this, so that no -v option will be passed to dpkg-genchanges
661 (and as a result, only the last stanza from debian/changelog will
662 be used for the build and upload).
663 .TP
664 .RI \fB-m\fR maintaineraddress
665 Passed to dpkg-genchanges (eventually).
666 .TP
667 .RI \fB--ch:\fR option
668 Specifies a single additional option to pass, eventually, to
669 dpkg-genchanges.
671 Options which are safe to pass include
672 .BR -C
673 (and also
674 .BR "-si -sa -sd"
675 although these should never be necessary with Debian since dgit
676 automatically calculates whether .origs need to be uploaded.)
678 For other options the caveat below applies.
679 .TP
680 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
681 Specifies a single additional option to pass to
682 .BR curl ,
683 .BR dput ,
684 .BR debsign ,
685 .BR dpkg-source ,
686 .BR dpkg-buildpackage ,
687 .BR dpkg-genchanges ,
688 .BR sbuild ,
689 .BR ssh ,
690 .BR dgit ,
691 .BR gbp-pq ,
692 .BR gbp-build ,
693 or
694 .BR mergechanges .
695 Can be repeated as necessary.
697 Use of this ability should not normally be necessary.
698 It is provided for working around bugs,
699 or other unusual situations.
700 If you use these options,
701 you may violate dgit's assumptions
702 about the behaviour of its subprograms
703 and cause lossage.
705 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
706 the option applies only when the program is invoked directly by dgit.
707 Usually, for passing options to dpkg-genchanges, you should use
708 .BR --ch: \fIoption\fR.
710 Specifying --git is not effective for some lower-level read-only git
711 operations performed by dgit, and also not when git is invoked by
712 another program run by dgit.
714 See notes below regarding ssh and dgit.
716 NB that --gpg:option is not supported (because debsign does not
717 have that facility).
718 But see
719 .B -k
720 and the
721 .B keyid
722 distro config setting.
723 .TP
724 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
725 Specifies alternative programs to use instead of
726 .BR curl ,
727 .BR dput ,
728 .BR debsign ,
729 .BR dpkg-source ,
730 .BR dpkg-buildpackage ,
731 .BR dpkg-genchanges ,
732 .BR sbuild ,
733 .BR gpg ,
734 .BR ssh ,
735 .BR dgit ,
736 .BR git ,
737 .BR gbp-pq ,
738 .BR gbp-build ,
739 or
740 .BR mergechanges .
742 For
743 .BR dpkg-buildpackage ,
744 .BR dpkg-genchanges ,
745 .B mergechanges
746 and
747 .BR sbuild ,
748 this applies only when the program is invoked directly by dgit.
750 For
751 .BR dgit ,
752 specifies the command to run on the remote host when dgit
753 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
754 itself as the EDITOR for dpkg-source --commit; this is done using
755 argv[0], and is not affected by --dgit=).
757 .BR gbp-build 's
758 value
759 is used instead of gbp build or git-buildpackage.  (The default is
760 the latter unless the former exists on PATH.)
761 .BR gbp-pq 's
762 value
763 is used instead of gbp pq.
764 In both cases,
765 unusually, the specified value is split on whitespace
766 to produce a command and possibly some options and/or arguments.
768 For
769 .BR ssh ,
770 the default value is taken from the
772 or
773 .B GIT_SSH
774 environment variables, if set (see below).  And, for ssh, when accessing the
775 archive and dgit-repos, this command line setting is overridden by the
776 git config variables
777 .BI dgit-distro. distro .ssh
778 and
779 .B .dgit.default.ssh
780 (which can in turn be overridden with -c).  Also, when dgit is using
781 git to access dgit-repos, only git's idea of what ssh to use (eg,
782 .BR GIT_SSH )
783 is relevant.
784 .TP
785 .BI --existing-package= package
786 dgit push needs to canonicalise the suite name.  Sometimes, dgit
787 lacks a way to ask the archive to do this without knowing the
788 name of an existing package.  Without --new we can just use the
789 package we are trying to push.  But with --new that will not work, so
790 we guess
791 .B dpkg
792 or use the value of this option.  This option is not needed with the
793 default mechanisms for accessing the archive.
794 .TP
795 .BR -h | --help
796 Print a usage summary.
797 .TP
798 .BI --initiator-tempdir= directory
799 dgit rpush uses a temporary directory on the invoking (signing) host.
800 This option causes dgit to use
801 .I directory
802 instead.  Furthermore, the specified directory will be emptied,
803 removed and recreated before dgit starts, rather than removed
804 after dgit finishes.  The directory specified must be an absolute
805 pathname.
806 .TP
807 .BI --force- something
808 Instructs dgit to try to proceed despite detecting
809 what it thinks is going to be a fatal problem.
810 .B This is probably not going to work.
811 These options are provided as an escape hatch,
812 in case dgit is confused.
813 (They might also be useful for testing error cases.)
814 .TP
815 .B --import-dsc-with-dgit-field
816 Tell dgit import-dsc to treat a .dsc with a Dgit field
817 like one without it.
818 The result is a fresh import,
819 discarding the git history
820 that the person who pushed that .dsc was working with.
821 .TP
822 .B --force-unrepresentable
823 Carry on even if
824 dgit thinks that your git tree contains changes
825 (relative to your .orig tarballs)
826 which dpkg-source is not able to represent.
827 Your build or push will probably fail later.
828 .TP
829 .B --force-changes-origs-exactly
830 Use the set of .origs specified in your .changes, exactly,
831 without regard to what is in the archive already.
832 The archive may well reject your upload.
833 .TP
834 .B --force-unsupported-source-format
835 Carry on despite dgit not understanding your source package format.
836 dgit will probably mishandle it.
837 .TP
838 .B --force-dsc-changes-mismatch
839 Do not check whether .dsc and .changes match.
840 The archive will probably reject your upload.
841 .TP
842 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
843 Force on or off the use of the absurd git-apply emulation
844 when running gbp pq import
845 when importing a package from a .dsc.
846 See Debian bug #841867.
848 It is always possible with dgit to clone or fetch a package, make
849 changes in git (using git-commit) on the suite branch
850 .RB ( "git checkout dgit/" \fIsuite\fR)
851 and then dgit push.  You can use whatever gitish techniques you like
852 to construct the commits to push;
853 the only requirement is that what you push is a
854 descendant of the state of the archive, as provided by dgit in the
855 remote tracking branch
856 .BR remotes/dgit/dgit/ \fIsuite\fR.
858 If you are using dgit to do an NMU (in Debian),
859 and don't know about the
860 maintainers' preferred packaging workflows, you should make your
861 changes as a linear series of (logicially separated) commits on top of
862 what's already in the archive.
864 If you are lucky the other uploaders have also used dgit and
865 integrated the other relevant git history; if not you can fetch it
866 into your tree and cherry-pick etc. as you wish.
868 If you are the maintainer of a package dealing with uploads made
869 without dgit, you will probably want to merge the synthetic commits
870 (made by dgit to represent the uploads) into your git history.
871 Normally you can just merge the dgit branch into your own master, or
872 indeed if you do your work on the dgit local suite branch
873 .BI dgit/ suite
874 you can just use dgit pull.
876 However the first time dgit is used it will generate a new origin
877 commit from the archive which won't be linked into the rest of your
878 git history.  You will need to merge this.
880 If last upload was in fact made with git, you should usually proceed
881 as follows: identify the commit which was actually used to build the
882 package.  (Hopefully you have a tag for this.)  Check out the dgit
883 branch
884 .RB ( "git checkout dgit/" \fIsuite\fR)
885 and merge that other commit
886 .RB ( "git merge debian/" \fIversion\fR).
887 Hopefully this merge will be trivial because the two trees should
888 be very similar.  The resulting branch head can be merged into your
889 working branches
890 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
892 If last upload was not made with git, a different approach is required
893 to start using dgit.  First, do
894 .B dgit fetch
895 (or clone) to obtain a git history representation of what's in the
896 archive and record it in the
897 .BI remotes/dgit/dgit/ suite
898 tracking branch.  Then somehow, using your other git history
899 plus appropriate diffs and cherry picks from the dgit remote tracking
900 branch, construct a git commit whose tree corresponds to the tree to use for the
901 next upload. 
903 between what's in the archive and what you intend to upload.
904 Then run
905 .BR "dgit push"
906 to actually upload the result.
908 If the commit-to-be-uploaded is not a descendant of the
909 dgit remote tracking branch, you will need to pass
910 .B --overwrite
911 to dgit.
913 dgit can be configured via the git config system.
914 You may set keys with git-config (either in system-global or per-tree
915 configuration), or provide
916 .BI -c key = value
917 on the dgit command line.
918 .LP
919 Settings likely to be useful for an end user include:
920 .TP
921 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
922 Specifies the distro for a suite.  dgit keys off the suite name (which
923 appears in changelogs etc.), and uses that to determine the distro
924 which is involved.  The config used is thereafter that for the distro.
925 .TP
926 .BI dgit.default.distro " distro"
927 The default distro for an unknown suite.
928 .TP
929 .BR dgit.default. *
930 for each
931 .BR dgit-distro. \fIdistro\fR . *,
932 the default value used if there is no distro-specific setting.
933 .TP
934 .BR dgit-distro. \fIdistro\fR .clean-mode
935 One of the values for the command line --clean= option; used if
936 --clean is not specified.
937 .TP
938 .BR dgit-distro. \fIdistro\fR .quilt-mode
939 One of the values for the command line --quilt= option; used if
940 --quilt is not specified.
941 .TP
942 .BR dgit-distro. \fIdistro\fR .rm-old-changes
943 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
944 is specified.  The default is not to remove.
945 .TP
946 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
947 Whether you have push access to the distro.
948 For Debian, it is OK to use auto, which uses readonly mode if you are
949 not pushing right now;
950 but, setting this to false will avoid relying on the mirror of the dgit
951 git repository server.
952 .TP
953 .BI dgit-distro. distro .keyid
954 See also
955 .BR -k .
956 .TP
957 .BI dgit-distro. distro .mirror " url"
958 .TP
959 .BI dgit-distro. distro .username
960 Not relevant for Debian.
961 .TP
962 .BI dgit-distro. distro .upload-host
963 Might be useful if you have an intermediate queue server.
964 .TP
965 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
966 Values to configure for and in new git trees.  If
967 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
968 used, respectively.  Only used if .setup-usermail is not disabled.
969 .TP
970 .BI dgit-distro. distro .setup-useremail
971 Whether to set and in new git trees.
972 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
973 .TP
974 .BI dgit-distro. distro .setup-mergechangelogs
975 Whether to setup a merge driver which uses dpkg-mergechangelogs for
976 debian/changelog.  True by default.  Ignored for dgit
977 setup-mergechangelogs, which does it anyway.
978 .TP
979 .BI dgit-distro. distro .cmd- cmd
980 Program to use instead of
981 .IR cmd .
982 Works like
983 .BR -- \fIcmd\fR = "... ."
984 .TP
985 .BI dgit-distro. distro .opts- cmd
986 Extra options to pass to
987 .IR cmd .
988 Works like
989 .BR -- \fIcmd\fR : "... ."
990 To pass several options, configure multiple values in git config
991 (with git config --add).  The options for
992 .BI dgit.default.opts- cmd
993 .BI dgit-distro. distro /push.opts- cmd
994 and are all used, followed by options from dgit's command line.
996 There are many other settings which specify how a particular distro's
997 services (archive and git) are provided.  These should not normally be
998 adjusted, but are documented for the benefit of distros who wish to
999 adopt dgit.
1000 .TP
1001 .BR dgit-distro. \fIdistro\fR /push. *
1002 If set, overrides corresponding non \fB/push\fR config when
1003 .BR readonly=false ,
1004 or when pushing and
1005 .BR readonly=auto .
1006 .TP
1007 .BI dgit-distro. distro .git-url
1008 .TP
1009 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1010 .TP
1011 .BI dgit-distro. distro .git-proto
1012 .TP
1013 .BI dgit-distro. distro .git-path
1014 .TP
1015 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1016 .TP
1017 .BI dgit-distro. distro .git-check-suffix
1018 .TP
1019 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1020 .TP
1021 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1022 .TP
1023 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
1024 .TP
1025 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1026 .TP
1027 .BI dgit-distro. distro .madison-distro
1028 .TP
1029 .BI dgit-distro. distro .archive-query-default-component
1030 .TP
1031 .BI dgit-distro. distro .dgit-tag-format
1032 .TP
1033 .BI dgit-distro. distro .ssh
1034 .TP
1035 .BI dgit-distro. distro .sshpsql-dbname
1036 .TP
1037 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1038 .TP
1039 .BI dgit-distro. distro .backports-quirk
1041 .TP
1042 .BR DGIT_SSH ", " GIT_SSH
1043 specify an alternative default program (and perhaps arguments) to use
1044 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
1045 if it contains any whitespace will be passed to the shell.  GIT_SSH
1046 specifies just the program; no arguments can be specified, so dgit
1047 interprets it the same way as git does.
1048 See
1049 also the --ssh= and --ssh: options.
1050 .TP
1052 Default git and for new trees.  See
1053 .BR "dgit setup-new-tree" .
1054 .TP
1055 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1056 and other subprograms and modules used by dgit are affected by various
1057 environment variables.  Consult the documentaton for those programs
1058 for details.
1059 .SH BUGS
1060 dgit's git representation of format `3.0 (quilt)' source packages does
1061 not represent the patch stack as git commits.  Currently the patch
1062 series representation cannot round trip between git and the archive.
1063 Ideally dgit would represent a quilty package with an origin commit of
1064 some kind followed by the patch stack as a series of commits followed
1065 by a pseudo-merge (to make the branch fast-forwarding).  This would
1066 also mean a new `dgit rebase-prep' command or some such to turn such a
1067 fast-forwarding branch back into a rebasing patch stack, and a `force'
1068 option to dgit push (perhaps enabled automatically by a note left by
1069 rebase-prep) which will make the required pseudo-merge.
1071 If the dgit push fails halfway through, it should be restartable and
1072 idempotent.  However this is not true for the git tag operation.
1073 Also, it would be good to check that the proposed signing key is
1074 available before starting work.
1076 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
1077 the .orig.tar.gz could be transported via the git repo as git tags.
1078 Doing this is made more complicated by the possibility of a `3.0
1079 (quilt)' package with multiple .orig tarballs.
1081 dgit's build functions, and dgit push, should not make any changes to
1082 your current HEAD.  Sadly this is necessary for packages in the `3.0
1083 (quilt)' source format.  This is ultimately due to what I consider
1084 design problems in quilt and dpkg-source.
1086 There should be an option which arranges for the `3.0 (quilt)'
1087 autocommit(s) to not appear on your HEAD, but instead only in the
1088 remote tracking suite branch.
1090 --dry-run does not always work properly, as not doing some of the git
1091 fetches may result in subsequent actions being different.  Doing a
1092 non-dry-run dgit fetch first will help.
1094 \fBdgit\fP(7),
1095 \fBdgit-maint-merge\fP(7),
1096 \fBcurl\fP(1),
1097 \fBdput\fP(1),
1098 \fBdebsign\fP(1),
1099 \fBgit-config\fP(1),
1100 \fBgit-buildpackage\fP(1),
1101 \fBdpkg-buildpackage\fP(1),
1102 .br