chiark / gitweb /
import dsc: Documentation
[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 .BI "dgit import-dsc " ../path/to/.dsc 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 If
261 .I branch
262 does not start with refs/, refs/heads/ is prepended.
263 The specified branch is unconditionally updated.
265 If the specified .dsc contains a Dgit field,
266 dgit will simply make a branch of that commit.
267 If you cannot manage to find that commit anywhere,
268 consider --force-import-dsc-with-dgit-field.
269 .TP
270 .B dgit version
271 Prints version information and exits.
272 .TP
273 .BI "dgit clone-dgit-repos-server" " destdir"
274 Tries to fetch a copy of the source code for the dgit-repos-server,
275 as actually being used on the dgit git server, as a git tree.
277 .TP
278 .BR --dry-run " | " -n
279 Go through the motions, fetching all information needed, but do not
280 actually update the output(s).  For push, dgit does
281 the required checks and leaves the new .dsc in a temporary file,
282 but does not sign, tag, push or upload.
283 .TP
284 .BR --damp-run " | " -L
285 Go through many more of the motions: do everything that doesn't
286 involve either signing things, or making changes on the public
287 servers.
288 .TP
289 .BI -k keyid
290 Use
291 .I keyid
292 for signing the tag and the upload.  The default comes from the
293 distro's
294 .B keyid
295 config setting (see CONFIGURATION, below), or failing that, the
296 uploader trailer line in debian/changelog.
297 .TP
298 .BR --no-sign
299 does not sign tags or uploads (meaningful only with push).
300 .TP
301 .TP
302 .BI -p package
303 Specifies that we should process source package
304 .I package
305 rather than looking in debian/control or debian/changelog.
306 Valid with dgit fetch and dgit pull, only.
307 .TP
308 .BR --clean=git " | " -wg
309 Use
310 .BR "git clean -xdf"
311 to clean the working tree,
312 rather than running the package's rules clean target.
314 This will delete all files which are not tracked by git.
315 (Including any files you forgot to git add.)
317 .BI --clean= ...
318 options other than dpkg-source
319 are useful when the package's clean target is troublesome, or
320 to avoid needing the build-dependencies.
321 .TP
322 .BR --clean=git-ff " | " -wgf
323 Use
324 .BR "git clean -xdff"
325 to clean the working tree.
326 Like
327 git clean -xdf
328 but it also removes any subdirectories containing different git
329 trees (which only unusual packages are likely to create).
330 .TP
331 .BR --clean=check " | " -wc
332 Merely check that the tree is clean (does not contain uncommitted
333 files).
334 Avoids running rules clean,
335 and can avoid needing the build-dependencies.
336 .TP
337 .BR --clean=none " | " -wn
338 Do not clean the tree, nor check that it is clean.
339 Avoids running rules clean,
340 and can avoid needing the build-dependencies.
341 If there are
342 files which are not in git, or if the build creates such files, a
343 subsequent dgit push will fail.
344 .TP
345 .BR --clean=dpkg-source " | " -wd
346 Use dpkg-buildpackage to do the clean, so that the source package
347 is cleaned by dpkg-source running the package's clean target.
348 This is the default.
349 Requires the package's build dependencies.
350 .TP
351 .BR --clean=dpkg-source-d " | " -wdd
352 Use
353 .B dpkg-buildpackage -d
354 to do the clean,
355 so that the source package
356 is cleaned by dpkg-source running the package's clean target.
357 The build-dependencies are not checked (due to
358 .BR -d ),
359 which violates policy, but may work in practice.
360 .TP
361 .BR -N " | " --new
362 The package is or may be new in this suite.  Without this, dgit will
363 refuse to push.  It may (for Debian, will) be unable to access the git
364 history for any packages which have been newly pushed and have not yet
365 been published.
366 .TP
367 .BR --ignore-dirty
368 Do not complain if the working tree does not match your git HEAD.
369 This can be useful with build, if you plan to commit later.  (dgit
370 push will still ensure that the .dsc you upload and the git tree
371 you push are identical, so this option won't make broken pushes.)
372 .TP
373 .BR --overwrite =\fIprevious-version\fR
374 Declare that even though your git branch is not a descendant
375 of the version in the archive
376 according to the revision history,
377 it really does contain
378 all the (wanted) changes from that version.
380 This option is useful if you are the maintainer, and you have
381 incorporated NMU changes into your own git workflow in a way that
382 doesn't make your branch a fast forward from the NMU.
384 .I previous-version
385 ought to be the version currently in the archive.  If
386 .I previous-version
387 is not
388 specified, dgit will check that the version in the archive is
389 mentioned in your debian/changelog.
390 (This will avoid losing
391 changes unless someone committed to git a finalised changelog
392 entry, and then made later changes to that version.)
394 dgit push --overwrite
395 will make a
396 pseudo-merge (that is, something that looks like the result
397 of git merge -s ours) to stitch the archive's version into your own
398 git history, so that your push is a fast forward from the archive.
400 (In quilt mode
401 .BR gbp ", " dpm " or " unpatched ,
402 implying a split between the dgit view and the
403 maintainer view, the pseudo-merge will appear only in the dgit view.)
404 .TP
405 .BI --deliberately- something
406 Declare that you are deliberately doing
407 .IR something .
408 This can be used to override safety catches, including safety catches
409 which relate to distro-specific policies.
410 The use of --deliberately is declared and published in the signed tags
411 generated for you by dgit,
412 so that the archive software can give effect to your intent,
413 and
414 for the benefit humans looking at the history.
415 The meanings of
416 .IR something s
417 understood in the context of Debian are discussed below:
418 .TP
419 .BR --deliberately-not-fast-forward
420 Declare that you are deliberately rewinding history.  When pushing to
421 Debian, use this when you are making a renewed upload of an entirely
422 new source package whose previous version was not accepted for release
423 from NEW because of problems with copyright or redistributibility.
424 .TP
425 .BR --deliberately-include-questionable-history
426 Declare that you are deliberately including, in the git history of
427 your current push, history which contains a previously-submitted
428 version of this package which was not approved (or has not yet been
429 approved) by the ftpmasters.  When pushing to Debian, only use this
430 option after verifying that: none of the rejected-from-NEW (or
431 never-accepted) versions in the git history of your current push, were
432 rejected by ftpmaster for copyright or redistributability reasons.
433 .TP
434 .BR --deliberately-fresh-repo
435 Declare that you are deliberately rewinding history and want to
436 throw away the existing repo.  Not relevant when pushing to Debian,
437 as the Debian server will do this automatically when necessary.
438 .TP
439 .BR --quilt=linear
440 When fixing up source format `3.0 (quilt)' metadata, insist on
441 generating a linear patch stack: one new patch for each relevant
442 commit.
443 If such a stack cannot be generated, fail.
444 This is the default for Debian.
446 HEAD should be a series of plain commits
447 (not touching debian/patches/),
448 and pseudomerges,
449 with as ancestor a patches-applied branch.
450 .TP
451 .BR --quilt=auto
452 When fixing up source format `3.0 (quilt)' metadata, prefer to
453 generate a linear patch stack
454 (as with --quilt=auto)
455 but if that doesn't seem possible,
456 try to generate a single squashed patch for all the changes made in git
457 (as with --quilt=smash).
458 This is not a good idea for an NMU in Debian.
459 .TP
460 .BR --quilt=smash
461 When fixing up source format `3.0 (quilt)' metadata,
462 generate a single additional patch for all the changes made in git.
463 This is not a good idea for an NMU in Debian.
465 (If HEAD has any in-tree patches already, they must apply cleanly.
466 This will be the case for any trees produced by dgit fetch or clone;
467 if you do not change the upstream version
468 nor make changes in debian/patches,
469 it will remain true.)
470 .TP
471 .BR --quilt=nofix
472 Check whether source format `3.0 (quilt)' metadata would need fixing
473 up, but, if it does, fail.  You must then fix the metadata yourself
474 somehow before pushing.  (NB that dpkg-source --commit will not work
475 because the dgit git tree does not have a
476 .B .pc
477 directory.)
478 .TP
479 .BR --quilt=nocheck " | " --no-quilt-fixup
480 Do not check whether up source format `3.0 (quilt)' metadata needs
481 fixing up.  If you use this option and the metadata did in fact need
482 fixing up, dgit push will fail.
483 .TP
484 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
485 Tell dgit that you are using a nearly-dgit-compatible git branch,
486 aka a
487 .BR "maintainer view" ,
488 and
489 do not want your branch changed by dgit.
491 .B --gbp
492 (short for
493 .BR --quilt=gbp )
494 is for use with git-buildpackage.
495 Your HEAD is expected to be
496 a patches-unapplied git branch, except that it might contain changes
497 to upstream .gitignore files.  This is the default for dgit gbp-build.
499 .B --dpm
500 (short for
501 .BR --quilt=dpm )
502 is for use with git-dpm.
503 Your HEAD is expected to be
504 a patches-applied git branch,
505 except that it might contain changes to upstream .gitignore files.
507 .B --quilt=unapplied
508 specifies that your HEAD is a patches-unapplied git branch (and
509 that any changes to upstream .gitignore files are represented as
510 patches in debian/patches).
512 With --quilt=gbp|dpm|unapplied,
513 dgit push (or precursors like quilt-fixup and build) will automatically
514 generate a conversion of your git branch into the right form.
515 dgit push will push the
516 dgit-compatible form (the
517 .BR "dgit view" )
518 to the dgit git server.
519 The dgit view will be visible to you
520 in the dgit remote tracking branches, but your own branch will
521 not be modified.
522 dgit push will create a tag
523 .BI debian/ version
524 for the maintainer view, and the dgit tag
525 .BI archive/debian/ version
526 for the dgit view.
527 dgit quilt-fixup will merely do some checks,
528 and cache the maintainer view.
530 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
531 This is because it is not always possible to tell: a patches-unapplied
532 git branch of a package with one patch, for example, looks very like
533 a patches-applied branch where the user has used git revert to
534 undo the patch, expecting to actually revert it.
535 However, if you fail to specify the right \-\-quilt option,
536 and you aren't too lucky, dgit will notice the problem and stop,
537 with a useful hint. 
538 .TP
539 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
540 Specifies that the suite to be operated on is part of distro
541 .IR distro .
542 This overrides the default value found from the git config option
543 .BR dgit-suite. \fIsuite\fR .distro .
544 The only effect is that other configuration variables (used
545 for accessing the archive and dgit-repos) used are
546 .BR dgit-distro. \fIdistro\fR .* .
548 If your suite is part of a distro that dgit already knows about, you
549 can use this option to make dgit work even if your dgit doesn't know
550 about the suite.  For example, specifying
551 .B -ddebian
552 will work when the suite is an unknown suite in the Debian archive.
554 To define a new distro it is necessary to define methods and URLs
555 for fetching (and, for dgit push, altering) a variety of information both
556 in the archive and in dgit-repos.
557 How to set this up is not yet documented.
558 .TP
559 .BI -C changesfile
560 Specifies the .changes file which is to be uploaded.  By default
561 dgit push looks for single .changes file in the parent directory whose
562 filename suggests it is for the right package and version.
564 If the specified
565 .I changesfile
566 pathname contains slashes, the directory part is also used as
567 the value for
568 .BR --build-products-dir ;
569 otherwise, the changes file is expected in that directory (by
570 default, in
571 .BR .. ).
572 .TP
573 .B --rm-old-changes
574 When doing a build, delete any changes files matching
575 .IB package _ version _*.changes
576 before starting.  This ensures that
577 dgit push (and dgit sbuild) will be able to unambigously
578 identify the relevant changes files from the most recent build, even
579 if there have been previous builds with different tools or options.
580 The default is not to remove, but
581 .B \-\-no-rm-old-changes
582 can be used to override a previous \-\-rm-old-changes
583 or the .rm-old-changes configuration setting.
584 .TP
585 .BI --build-products-dir= directory
586 Specifies where to find the built files to be uploaded.
587 By default, dgit looks in the parent directory
588 .RB ( .. ).
589 .TP
590 .BI --no-rm-on-error
591 Do not delete the destination directory if clone fails.
592 .TP
593 .BI -D
594 Prints debugging information to stderr.  Repeating the option produces
595 more output (currently, up to -DDDD is meaningfully different).
596 .TP
597 .BI -c name = value
598 Specifies a git configuration option, to be used for this run.
599 dgit itself is also controlled by git configuration options.
600 .TP
601 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
602 Specifies the
603 .BI -v version
604 option to pass to dpkg-genchanges, during builds.  Changes (from
605 debian/changelog) since this version will be included in the built
606 changes file, and hence in the upload.  If this option is not
607 specified, dgit will query the archive and use the latest version
608 uploaded to the intended suite.
610 Specifying
611 .B _
612 inhibits this, so that no -v option will be passed to dpkg-genchanges
613 (and as a result, only the last stanza from debian/changelog will
614 be used for the build and upload).
615 .TP
616 .RI \fB-m\fR maintaineraddress
617 Passed to dpkg-genchanges (eventually).
618 .TP
619 .RI \fB--ch:\fR option
620 Specifies a single additional option to pass, eventually, to
621 dpkg-genchanges.
623 Options which are safe to pass include
624 .BR -C
625 (and also
626 .BR "-si -sa -sd"
627 although these should never be necessary with Debian since dgit
628 automatically calculates whether .origs need to be uploaded.)
630 For other options the caveat below applies.
631 .TP
632 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
633 Specifies a single additional option to pass to
634 .BR curl ,
635 .BR dput ,
636 .BR debsign ,
637 .BR dpkg-source ,
638 .BR dpkg-buildpackage ,
639 .BR dpkg-genchanges ,
640 .BR sbuild ,
641 .BR ssh ,
642 .BR dgit ,
643 .BR gbp-pq ,
644 .BR gbp-build ,
645 or
646 .BR mergechanges .
647 Can be repeated as necessary.
649 Use of this ability should not normally be necessary.
650 It is provided for working around bugs,
651 or other unusual situations.
652 If you use these options,
653 you may violate dgit's assumptions
654 about the behaviour of its subprograms
655 and cause lossage.
657 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
658 the option applies only when the program is invoked directly by dgit.
659 Usually, for passing options to dpkg-genchanges, you should use
660 .BR --ch: \fIoption\fR.
662 Specifying --git is not effective for some lower-level read-only git
663 operations performed by dgit, and also not when git is invoked by
664 another program run by dgit.
666 See notes below regarding ssh and dgit.
668 NB that --gpg:option is not supported (because debsign does not
669 have that facility).
670 But see
671 .B -k
672 and the
673 .B keyid
674 distro config setting.
675 .TP
676 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
677 Specifies alternative programs to use instead of
678 .BR curl ,
679 .BR dput ,
680 .BR debsign ,
681 .BR dpkg-source ,
682 .BR dpkg-buildpackage ,
683 .BR dpkg-genchanges ,
684 .BR sbuild ,
685 .BR gpg ,
686 .BR ssh ,
687 .BR dgit ,
688 .BR git ,
689 .BR gbp-pq ,
690 .BR gbp-build ,
691 or
692 .BR mergechanges .
694 For
695 .BR dpkg-buildpackage ,
696 .BR dpkg-genchanges ,
697 .B mergechanges
698 and
699 .BR sbuild ,
700 this applies only when the program is invoked directly by dgit.
702 For
703 .BR dgit ,
704 specifies the command to run on the remote host when dgit
705 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
706 itself as the EDITOR for dpkg-source --commit; this is done using
707 argv[0], and is not affected by --dgit=).
709 .BR gbp-build 's
710 value
711 is used instead of gbp build or git-buildpackage.  (The default is
712 the latter unless the former exists on PATH.)
713 .BR gbp-pq 's
714 value
715 is used instead of gbp pq.
716 In both cases,
717 unusually, the specified value is split on whitespace
718 to produce a command and possibly some options and/or arguments.
720 For
721 .BR ssh ,
722 the default value is taken from the
724 or
725 .B GIT_SSH
726 environment variables, if set (see below).  And, for ssh, when accessing the
727 archive and dgit-repos, this command line setting is overridden by the
728 git config variables
729 .BI dgit-distro. distro .ssh
730 and
731 .B .dgit.default.ssh
732 (which can in turn be overridden with -c).  Also, when dgit is using
733 git to access dgit-repos, only git's idea of what ssh to use (eg,
734 .BR GIT_SSH )
735 is relevant.
736 .TP
737 .BI --existing-package= package
738 dgit push needs to canonicalise the suite name.  Sometimes, dgit
739 lacks a way to ask the archive to do this without knowing the
740 name of an existing package.  Without --new we can just use the
741 package we are trying to push.  But with --new that will not work, so
742 we guess
743 .B dpkg
744 or use the value of this option.  This option is not needed with the
745 default mechanisms for accessing the archive.
746 .TP
747 .BR -h | --help
748 Print a usage summary.
749 .TP
750 .BI --initiator-tempdir= directory
751 dgit rpush uses a temporary directory on the invoking (signing) host.
752 This option causes dgit to use
753 .I directory
754 instead.  Furthermore, the specified directory will be emptied,
755 removed and recreated before dgit starts, rather than removed
756 after dgit finishes.  The directory specified must be an absolute
757 pathname.
758 .TP
759 .BI --force- something
760 Instructs dgit to try to proceed despite detecting
761 what it thinks is going to be a fatal problem.
762 .B This is probably not going to work.
763 These options are provided as an escape hatch,
764 in case dgit is confused.
765 (They might also be useful for testing error cases.)
766 .TP
767 .B --import-dsc-with-dgit-field
768 Tell dgit import-dsc to treat a .dsc with a Dgit field
769 like one without it.
770 The result is a fresh import,
771 discarding the git history
772 that the person who pushed that .dsc was working with.
773 .TP
774 .B --force-unrepresentable
775 Carry on even if
776 dgit thinks that your git tree contains changes
777 (relative to your .orig tarballs)
778 which dpkg-source is not able to represent.
779 Your build or push will probably fail later.
780 .TP
781 .B --force-changes-origs-exactly
782 Use the set of .origs specified in your .changes, exactly,
783 without regard to what is in the archive already.
784 The archive may well reject your upload.
785 .TP
786 .B --force-unsupported-source-format
787 Carry on despite dgit not understanding your source package format.
788 dgit will probably mishandle it.
789 .TP
790 .B --force-dsc-changes-mismatch
791 Do not check whether .dsc and .changes match.
792 The archive will probably reject your upload.
793 .TP
794 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
795 Force on or off the use of the absurd git-apply emulation
796 when running gbp pq import
797 when importing a package from a .dsc.
798 See Debian bug #841867.
800 It is always possible with dgit to clone or fetch a package, make
801 changes in git (using git-commit) on the suite branch
802 .RB ( "git checkout dgit/" \fIsuite\fR)
803 and then dgit push.  You can use whatever gitish techniques you like
804 to construct the commits to push;
805 the only requirement is that what you push is a
806 descendant of the state of the archive, as provided by dgit in the
807 remote tracking branch
808 .BR remotes/dgit/dgit/ \fIsuite\fR.
810 If you are using dgit to do an NMU (in Debian),
811 and don't know about the
812 maintainers' preferred packaging workflows, you should make your
813 changes as a linear series of (logicially separated) commits on top of
814 what's already in the archive.
816 If you are lucky the other uploaders have also used dgit and
817 integrated the other relevant git history; if not you can fetch it
818 into your tree and cherry-pick etc. as you wish.
820 If you are the maintainer of a package dealing with uploads made
821 without dgit, you will probably want to merge the synthetic commits
822 (made by dgit to represent the uploads) into your git history.
823 Normally you can just merge the dgit branch into your own master, or
824 indeed if you do your work on the dgit local suite branch
825 .BI dgit/ suite
826 you can just use dgit pull.
828 However the first time dgit is used it will generate a new origin
829 commit from the archive which won't be linked into the rest of your
830 git history.  You will need to merge this.
832 If last upload was in fact made with git, you should usually proceed
833 as follows: identify the commit which was actually used to build the
834 package.  (Hopefully you have a tag for this.)  Check out the dgit
835 branch
836 .RB ( "git checkout dgit/" \fIsuite\fR)
837 and merge that other commit
838 .RB ( "git merge debian/" \fIversion\fR).
839 Hopefully this merge will be trivial because the two trees should
840 be very similar.  The resulting branch head can be merged into your
841 working branches
842 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
844 If last upload was not made with git, a different approach is required
845 to start using dgit.  First, do
846 .B dgit fetch
847 (or clone) to obtain a git history representation of what's in the
848 archive and record it in the
849 .BI remotes/dgit/dgit/ suite
850 tracking branch.  Then somehow, using your other git history
851 plus appropriate diffs and cherry picks from the dgit remote tracking
852 branch, construct a git commit whose tree corresponds to the tree to use for the
853 next upload. 
855 between what's in the archive and what you intend to upload.
856 Then run
857 .BR "dgit push"
858 to actually upload the result.
860 If the commit-to-be-uploaded is not a descendant of the
861 dgit remote tracking branch, you will need to pass
862 .B --overwrite
863 to dgit.
865 dgit can be configured via the git config system.
866 You may set keys with git-config (either in system-global or per-tree
867 configuration), or provide
868 .BI -c key = value
869 on the dgit command line.
870 .LP
871 Settings likely to be useful for an end user include:
872 .TP
873 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
874 Specifies the distro for a suite.  dgit keys off the suite name (which
875 appears in changelogs etc.), and uses that to determine the distro
876 which is involved.  The config used is thereafter that for the distro.
877 .TP
878 .BI dgit.default.distro " distro"
879 The default distro for an unknown suite.
880 .TP
881 .BR dgit.default. *
882 for each
883 .BR dgit-distro. \fIdistro\fR . *,
884 the default value used if there is no distro-specific setting.
885 .TP
886 .BR dgit-distro. \fIdistro\fR .clean-mode
887 One of the values for the command line --clean= option; used if
888 --clean is not specified.
889 .TP
890 .BR dgit-distro. \fIdistro\fR .quilt-mode
891 One of the values for the command line --quilt= option; used if
892 --quilt is not specified.
893 .TP
894 .BR dgit-distro. \fIdistro\fR .rm-old-changes
895 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
896 is specified.  The default is not to remove.
897 .TP
898 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
899 Whether you have push access to the distro.
900 For Debian, it is OK to use auto, which uses readonly mode if you are
901 not pushing right now;
902 but, setting this to false will avoid relying on the mirror of the dgit
903 git repository server.
904 .TP
905 .BI dgit-distro. distro .keyid
906 See also
907 .BR -k .
908 .TP
909 .BI dgit-distro. distro .mirror " url"
910 .TP
911 .BI dgit-distro. distro .username
912 Not relevant for Debian.
913 .TP
914 .BI dgit-distro. distro .upload-host
915 Might be useful if you have an intermediate queue server.
916 .TP
917 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
918 Values to configure for and in new git trees.  If
919 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
920 used, respectively.  Only used if .setup-usermail is not disabled.
921 .TP
922 .BI dgit-distro. distro .setup-useremail
923 Whether to set and in new git trees.
924 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
925 .TP
926 .BI dgit-distro. distro .setup-mergechangelogs
927 Whether to setup a merge driver which uses dpkg-mergechangelogs for
928 debian/changelog.  True by default.  Ignored for dgit
929 setup-mergechangelogs, which does it anyway.
930 .TP
931 .BI dgit-distro. distro .cmd- cmd
932 Program to use instead of
933 .IR cmd .
934 Works like
935 .BR -- \fIcmd\fR = "... ."
936 .TP
937 .BI dgit-distro. distro .opts- cmd
938 Extra options to pass to
939 .IR cmd .
940 Works like
941 .BR -- \fIcmd\fR : "... ."
942 To pass several options, configure multiple values in git config
943 (with git config --add).  The options for
944 .BI dgit.default.opts- cmd
945 .BI dgit-distro. distro /push.opts- cmd
946 and are all used, followed by options from dgit's command line.
948 There are many other settings which specify how a particular distro's
949 services (archive and git) are provided.  These should not normally be
950 adjusted, but are documented for the benefit of distros who wish to
951 adopt dgit.
952 .TP
953 .BR dgit-distro. \fIdistro\fR /push. *
954 If set, overrides corresponding non \fB/push\fR config when
955 .BR readonly=false ,
956 or when pushing and
957 .BR readonly=auto .
958 .TP
959 .BI dgit-distro. distro .git-url
960 .TP
961 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
962 .TP
963 .BI dgit-distro. distro .git-proto
964 .TP
965 .BI dgit-distro. distro .git-path
966 .TP
967 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
968 .TP
969 .BI dgit-distro. distro .git-check-suffix
970 .TP
971 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
972 .TP
973 .BI dgit-distro. distro .git-create " " ssh-cmd | true
974 .TP
975 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
976 .TP
977 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
978 .TP
979 .BI dgit-distro. distro .madison-distro
980 .TP
981 .BI dgit-distro. distro .archive-query-default-component
982 .TP
983 .BI dgit-distro. distro .dgit-tag-format
984 .TP
985 .BI dgit-distro. distro .ssh
986 .TP
987 .BI dgit-distro. distro .sshpsql-dbname
988 .TP
989 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
990 .TP
991 .BI dgit-distro. distro .backports-quirk
993 .TP
995 specify an alternative default program (and perhaps arguments) to use
996 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
997 if it contains any whitespace will be passed to the shell.  GIT_SSH
998 specifies just the program; no arguments can be specified, so dgit
999 interprets it the same way as git does.
1000 See
1001 also the --ssh= and --ssh: options.
1002 .TP
1004 Default git and for new trees.  See
1005 .BR "dgit setup-new-tree" .
1006 .TP
1007 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1008 and other subprograms and modules used by dgit are affected by various
1009 environment variables.  Consult the documentaton for those programs
1010 for details.
1011 .SH BUGS
1012 dgit's git representation of format `3.0 (quilt)' source packages does
1013 not represent the patch stack as git commits.  Currently the patch
1014 series representation cannot round trip between git and the archive.
1015 Ideally dgit would represent a quilty package with an origin commit of
1016 some kind followed by the patch stack as a series of commits followed
1017 by a pseudo-merge (to make the branch fast-forwarding).  This would
1018 also mean a new `dgit rebase-prep' command or some such to turn such a
1019 fast-forwarding branch back into a rebasing patch stack, and a `force'
1020 option to dgit push (perhaps enabled automatically by a note left by
1021 rebase-prep) which will make the required pseudo-merge.
1023 If the dgit push fails halfway through, it should be restartable and
1024 idempotent.  However this is not true for the git tag operation.
1025 Also, it would be good to check that the proposed signing key is
1026 available before starting work.
1028 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
1029 the .orig.tar.gz could be transported via the git repo as git tags.
1030 Doing this is made more complicated by the possibility of a `3.0
1031 (quilt)' package with multiple .orig tarballs.
1033 dgit's build functions, and dgit push, should not make any changes to
1034 your current HEAD.  Sadly this is necessary for packages in the `3.0
1035 (quilt)' source format.  This is ultimately due to what I consider
1036 design problems in quilt and dpkg-source.
1038 There should be an option which arranges for the `3.0 (quilt)'
1039 autocommit(s) to not appear on your HEAD, but instead only in the
1040 remote tracking suite branch.
1042 --dry-run does not always work properly, as not doing some of the git
1043 fetches may result in subsequent actions being different.  Doing a
1044 non-dry-run dgit fetch first will help.
1046 \fBdgit\fP(7),
1047 \fBdgit-maint-merge\fP(7),
1048 \fBcurl\fP(1),
1049 \fBdput\fP(1),
1050 \fBdebsign\fP(1),
1051 \fBgit-config\fP(1),
1052 \fBgit-buildpackage\fP(1),
1053 \fBdpkg-buildpackage\fP(1),
1054 .br