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