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