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