chiark / gitweb /
dgit(1): Refer to dgit-maint-debrebase
[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 already a macro attribute line
272 .B [attr]dgit-defuse-attrs
273 in .git/info/attributes
274 (whatever its effects),
275 this operation does nothing further.
276 This fact can be used to defeat or partially defeat
277 dgit setup-gitattributes
278 and hence
279 dgit setup-new-tree.)
280 .TP
281 .B dgit quilt-fixup
282 `3.0 (quilt)' format source packages need changes representing not
283 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
284 checks whether this has been done; if not, dgit will make appropriate
285 patches in debian/patches and also commit the resulting changes to
286 git.
288 This is normally done automatically by dgit build and dgit push.
290 dgit will try to turn each relevant commit in your git history into a
291 new quilt patch.  dgit cannot convert nontrivial merges, or certain
292 other kinds of more exotic history.  If dgit can't find a suitable
293 linearisation of your history, by default it will fail, but you can
294 ask it to generate a single squashed patch instead.
296 When used with a git-debrebase branch,
297 dgit will ask git-debrebase to prepare patches.
298 However,
299 dgit can make patches in some situations where git-debrebase fails,
300 so dgit quilt-fixup can be useful in its own right.
301 To always use dgit's own patch generator
302 instead of git-debrebase make-patches,
303 pass --git-debrebase=true to dgit.
304 .TP
305 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
306 Import a Debian-format source package,
307 specified by its .dsc,
308 into git,
309 the way dgit fetch would do.
311 This does about half the work of dgit fetch:
312 it will convert the .dsc into a new, orphan git branch.
313 Since dgit has no access to a corresponding source package archive
314 or knowledge of the history
315 it does not consider whether this version is newer
316 than any previous import
317 or corresponding git branches;
318 and it therefore does not
319 make a pseudomerge to bind the import
320 into any existing git history.
322 Because a .dsc can contain a Dgit field naming a git commit
323 (which you might not have),
324 and specifying where to find that commit
325 (and any history rewrite table),
326 import-dsc might need online access.
327 If this is a problem
328 (or dgit's efforts to find the commit fail),
329 consider --no-chase-dsc-distro
330 or --force-import-dsc-with-dgit-field.
332 There is only only sub-option:
334 .B --require-valid-signature
335 causes dgit to insist that the signature on the .dsc is valid
336 (using the same criteria as dpkg-source -x).
337 Otherwise, dgit tries to verify the signature but
338 the outcome is reported only as messages to stderr.
340 If
341 .I branch
342 is prefixed with
343 .B +
344 then if it already exists, it will be simply ovewritten,
345 no matter its existing contents.
346 If
347 .I branch
348 is prefixed with
349 .B ..
350 then if it already exists
351 and dgit actually imports the dsc
352 (rather than simply reading the git commit out of the Dgit field),
353 dgit will make a pseudomerge
354 so that the result is necessarily fast forward
355 from the existing branch.
356 Otherwise, if branch already exists,
357 dgit will stop with an error message.
359 If
360 .I branch
361 does not start with refs/, refs/heads/ is prepended.
362 .TP
363 .B dgit version
364 Prints version information and exits.
365 .TP
366 .BI "dgit clone-dgit-repos-server" " destdir"
367 Tries to fetch a copy of the source code for the dgit-repos-server,
368 as actually being used on the dgit git server, as a git tree.
369 .TP
370 .BI "dgit print-dgit-repos-server-source-url"
371 Prints the url used by dgit clone-dgit-repos-server.
372 This is hopefully suitable for use as a git remote url.
373 It may not be useable in a browser.
374 .TP
375 .BI "dgit print-dpkg-source-ignores"
376 Prints the -i and -I arguments which must be passed to dpkg-souce
377 to cause it to exclude exactly the .git diredcory
378 and nothing else.
379 The separate arguments are unquoted, separated by spaces,
380 and do not contain spaces.
382 .TP
383 .BR --dry-run " | " -n
384 Go through the motions, fetching all information needed, but do not
385 actually update the output(s).  For push, dgit does
386 the required checks and leaves the new .dsc in a temporary file,
387 but does not sign, tag, push or upload.
388 .TP
389 .BR --damp-run " | " -L
390 Go through many more of the motions: do everything that doesn't
391 involve either signing things, or making changes on the public
392 servers.
393 .TP
394 .BI -k keyid
395 Use
396 .I keyid
397 for signing the tag and the upload.  The default comes from the
398 distro's
399 .B keyid
400 config setting (see CONFIGURATION, below), or failing that, the
401 uploader trailer line in debian/changelog.
402 .TP
403 .BR --no-sign
404 does not sign tags or uploads (meaningful only with push).
405 .TP
406 .TP
407 .BI -p package
408 Specifies that we should process source package
409 .I package
410 rather than looking in debian/control or debian/changelog.
411 Valid with dgit fetch and dgit pull, only.
412 .TP
413 .BR --clean=git " | " -wg
414 Use
415 .BR "git clean -xdf"
416 to clean the working tree,
417 rather than running the package's rules clean target.
419 This will delete all files which are not tracked by git.
420 (Including any files you forgot to git add.)
422 .BI --clean= ...
423 options other than dpkg-source
424 are useful when the package's clean target is troublesome, or
425 to avoid needing the build-dependencies.
426 .TP
427 .BR --clean=git-ff " | " -wgf
428 Use
429 .BR "git clean -xdff"
430 to clean the working tree.
431 Like
432 git clean -xdf
433 but it also removes any subdirectories containing different git
434 trees (which only unusual packages are likely to create).
435 .TP
436 .BR --clean=check " | " -wc
437 Merely check that the tree is clean (does not contain uncommitted
438 files).
439 Avoids running rules clean,
440 and can avoid needing the build-dependencies.
441 .TP
442 .BR --clean=none " | " -wn
443 Do not clean the tree, nor check that it is clean.
444 Avoids running rules clean,
445 and can avoid needing the build-dependencies.
446 If there are
447 files which are not in git, or if the build creates such files, a
448 subsequent dgit push will fail.
449 .TP
450 .BR --clean=dpkg-source " | " -wd
451 Use dpkg-buildpackage to do the clean, so that the source package
452 is cleaned by dpkg-source running the package's clean target.
453 This is the default.
454 Requires the package's build dependencies.
455 .TP
456 .BR --clean=dpkg-source-d " | " -wdd
457 Use
458 .B dpkg-buildpackage -d
459 to do the clean,
460 so that the source package
461 is cleaned by dpkg-source running the package's clean target.
462 The build-dependencies are not checked (due to
463 .BR -d ),
464 which violates policy, but may work in practice.
465 .TP
466 .BR -N " | " --new
467 The package is or may be new in this suite.  Without this, dgit will
468 refuse to push.  It may (for Debian, will) be unable to access the git
469 history for any packages which have been newly pushed and have not yet
470 been published.
471 .TP
472 .BR --ignore-dirty
473 Do not complain if the working tree does not match your git HEAD.
474 This can be useful with build, if you plan to commit later.  (dgit
475 push will still ensure that the .dsc you upload and the git tree
476 you push are identical, so this option won't make broken pushes.)
477 .TP
478 .BR --overwrite [=\fIprevious-version\fR]
479 Declare that even though your git branch is not a descendant
480 of the version in the archive
481 according to the revision history,
482 it really does contain
483 all the (wanted) changes from that version.
485 This option is useful if you are the maintainer, and you have
486 incorporated NMU changes into your own git workflow in a way that
487 doesn't make your branch a fast forward from the NMU.
489 .I previous-version
490 ought to be the version currently in the archive.  If
491 .I previous-version
492 is not
493 specified, dgit will check that the version in the archive is
494 mentioned in your debian/changelog.
495 (This will avoid losing
496 changes unless someone committed to git a finalised changelog
497 entry, and then made later changes to that version.)
499 dgit push --overwrite
500 will make a
501 pseudo-merge (that is, something that looks like the result
502 of git merge -s ours) to stitch the archive's version into your own
503 git history, so that your push is a fast forward from the archive.
505 (In quilt mode
506 .BR gbp ", " dpm " or " unpatched ,
507 implying a split between the dgit view and the
508 maintainer view, the pseudo-merge will appear only in the dgit view.)
509 .TP
510 .BR --delayed =\fIdays\fR
511 Upload to a DELAYED queue.
514 If the maintainer responds by cancelling
515 your upload from the queue,
516 and does not make an upload of their own,
517 this will not rewind the git branch on the dgit git server.
518 Other dgit users will then see your push
519 (with a warning message from dgit)
520 even though the maintainer wanted to abolish it.
521 Such users might unwittingly reintroduce your changes.
523 If this situation arises,
524 someone should make a suitable dgit push
525 to update the contents of dgit-repos
526 to a version without the controversial changes.
527 .TP
528 .BR --no-chase-dsc-distro
529 Tells dgit not to look online
530 for additional git repositories
531 containing information about a particular .dsc being imported.
532 Chasing is the default.
534 For most operations
535 (such as fetch and pull),
536 disabling chasing
537 means dgit will access only the git server
538 for the distro you are directly working with,
539 even if the .dsc was copied verbatim from another distro.
540 For import-dsc,
541 disabling chasing
542 means dgit will work completely offline.
544 Disabling chasing can be hazardous:
545 if the .dsc names a git commit which has been rewritten
546 by those in charge of the distro,
547 this option may prevent that rewrite from being effective.
548 Also,
549 it can mean that
550 dgit fails to find necessary git commits.
551 .TP
552 .BR --dgit-view-save= \fIbranch\fR|\fIref\fR
553 Specifies that when a split view quilt mode is in operation,
554 and dgit calculates
555 (or looks up in its cache)
556 a dgit view corresponding to your HEAD,
557 the dgit view will be left in
558 .IR ref .
559 The specified ref is unconditionally overwritten,
560 so don't specify a branch you want to keep.
562 This option is effective only with the following operations:
563 quilt-fixup; push; all builds.
564 And it is only effective with
565 --[quilt=]gbp,
566 --[quilt=]dpm,
567 --quilt=unpatched.
569 If ref does not start with refs/
570 it is taken to to be a branch -
571 i.e. refs/heads/ is prepended.
572 .TP
573 .BI --deliberately- something
574 Declare that you are deliberately doing
575 .IR something .
576 This can be used to override safety catches, including safety catches
577 which relate to distro-specific policies.
578 The use of --deliberately is declared and published in the signed tags
579 generated for you by dgit,
580 so that the archive software can give effect to your intent,
581 and
582 for the benefit humans looking at the history.
583 The meanings of
584 .IR something s
585 understood in the context of Debian are discussed below:
586 .TP
587 .BR --deliberately-not-fast-forward
588 Declare that you are deliberately rewinding history.  When pushing to
589 Debian, use this when you are making a renewed upload of an entirely
590 new source package whose previous version was not accepted for release
591 from NEW because of problems with copyright or redistributibility.
593 In split view quilt modes,
594 this also prevents the construction by dgit of a pseudomerge
595 to make the dgit view fast forwarding.
596 Normally only one of
597 --overwrite (which creates a suitable pseudomerge)
598 and
599 --deliberately-not-fast-forward
600 (which suppresses the pseudomerge and the fast forward checks)
601 should be needed;
602 --overwrite is usually better.
603 .TP
604 .BR --deliberately-include-questionable-history
605 Declare that you are deliberately including, in the git history of
606 your current push, history which contains a previously-submitted
607 version of this package which was not approved (or has not yet been
608 approved) by the ftpmasters.  When pushing to Debian, only use this
609 option after verifying that: none of the rejected-from-NEW (or
610 never-accepted) versions in the git history of your current push, were
611 rejected by ftpmaster for copyright or redistributability reasons.
612 .TP
613 .BR --deliberately-fresh-repo
614 Declare that you are deliberately rewinding history and want to
615 throw away the existing repo.  Not relevant when pushing to Debian,
616 as the Debian server will do this automatically when necessary.
617 .TP
618 .BR --quilt=linear
619 When fixing up source format `3.0 (quilt)' metadata, insist on
620 generating a linear patch stack: one new patch for each relevant
621 commit.
622 If such a stack cannot be generated, fail.
623 This is the default for Debian.
625 HEAD should be a series of plain commits
626 (not touching debian/patches/),
627 and pseudomerges,
628 with as ancestor a patches-applied branch.
629 .TP
630 .BR --quilt=auto
631 When fixing up source format `3.0 (quilt)' metadata, prefer to
632 generate a linear patch stack
633 (as with --quilt=auto)
634 but if that doesn't seem possible,
635 try to generate a single squashed patch for all the changes made in git
636 (as with --quilt=smash).
637 This is not a good idea for an NMU in Debian.
638 .TP
639 .BR --quilt=smash
640 When fixing up source format `3.0 (quilt)' metadata,
641 generate a single additional patch for all the changes made in git.
642 This is not a good idea for an NMU in Debian.
644 (If HEAD has any in-tree patches already, they must apply cleanly.
645 This will be the case for any trees produced by dgit fetch or clone;
646 if you do not change the upstream version
647 nor make changes in debian/patches,
648 it will remain true.)
649 .TP
650 .BR --quilt=nofix
651 Check whether source format `3.0 (quilt)' metadata would need fixing
652 up, but, if it does, fail.  You must then fix the metadata yourself
653 somehow before pushing.  (NB that dpkg-source --commit will not work
654 because the dgit git tree does not have a
655 .B .pc
656 directory.)
657 .TP
658 .BR --quilt=nocheck " | " --no-quilt-fixup
659 Do not check whether up source format `3.0 (quilt)' metadata needs
660 fixing up.  If you use this option and the metadata did in fact need
661 fixing up, dgit push will fail.
662 .TP
663 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
664 Tell dgit that you are using a nearly-dgit-compatible git branch,
665 aka a
666 .BR "maintainer view" ,
667 and
668 do not want your branch changed by dgit.
670 .B --gbp
671 (short for
672 .BR --quilt=gbp )
673 is for use with git-buildpackage.
674 Your HEAD is expected to be
675 a patches-unapplied git branch, except that it might contain changes
676 to upstream .gitignore files.  This is the default for dgit gbp-build.
678 .B --dpm
679 (short for
680 .BR --quilt=dpm )
681 is for use with git-dpm.
682 Your HEAD is expected to be
683 a patches-applied git branch,
684 except that it might contain changes to upstream .gitignore files.
686 .B --quilt=unapplied
687 specifies that your HEAD is a patches-unapplied git branch (and
688 that any changes to upstream .gitignore files are represented as
689 patches in debian/patches).
691 With --quilt=gbp|dpm|unapplied,
692 dgit push (or precursors like quilt-fixup and build) will automatically
693 generate a conversion of your git branch into the right form.
694 dgit push will push the
695 dgit-compatible form (the
696 .BR "dgit view" )
697 to the dgit git server.
698 The dgit view will be visible to you
699 in the dgit remote tracking branches, but your own branch will
700 not be modified.
701 dgit push will create a tag
702 .BI debian/ version
703 for the maintainer view, and the dgit tag
704 .BI archive/debian/ version
705 for the dgit view.
706 dgit quilt-fixup will merely do some checks,
707 and cache the maintainer view.
709 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
710 This is because it is not always possible to tell: a patches-unapplied
711 git branch of a package with one patch, for example, looks very like
712 a patches-applied branch where the user has used git revert to
713 undo the patch, expecting to actually revert it.
714 However, if you fail to specify the right \-\-quilt option,
715 and you aren't too lucky, dgit will notice the problem and stop,
716 with a useful hint. 
717 .TP
718 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
719 Specifies that the suite to be operated on is part of distro
720 .IR distro .
721 This overrides the default value found from the git config option
722 .BR dgit-suite. \fIsuite\fR .distro .
723 The only effect is that other configuration variables (used
724 for accessing the archive and dgit-repos) used are
725 .BR dgit-distro. \fIdistro\fR .* .
727 If your suite is part of a distro that dgit already knows about, you
728 can use this option to make dgit work even if your dgit doesn't know
729 about the suite.  For example, specifying
730 .B -ddebian
731 will work when the suite is an unknown suite in the Debian archive.
733 To define a new distro it is necessary to define methods and URLs
734 for fetching (and, for dgit push, altering) a variety of information both
735 in the archive and in dgit-repos.
736 How to set this up is not yet documented.
737 .TP
738 .BI -C changesfile
739 Specifies the .changes file which is to be uploaded.  By default
740 dgit push looks for single .changes file in the parent directory whose
741 filename suggests it is for the right package and version.
743 If the specified
744 .I changesfile
745 pathname contains slashes, the directory part is also used as
746 the value for
747 .BR --build-products-dir ;
748 otherwise, the changes file is expected in that directory (by
749 default, in
750 .BR .. ).
751 .TP
752 .B --rm-old-changes
753 When doing a build, delete any changes files matching
754 .IB package _ version _*.changes
755 before starting.  This ensures that
756 dgit push (and dgit sbuild) will be able to unambigously
757 identify the relevant changes files from the most recent build, even
758 if there have been previous builds with different tools or options.
759 The default is not to remove, but
760 .B \-\-no-rm-old-changes
761 can be used to override a previous \-\-rm-old-changes
762 or the .rm-old-changes configuration setting.
764 Note that \fBdgit push-source\fR will always find the right .changes,
765 regardless of this option.
766 .TP
767 .BI --build-products-dir= directory
768 Specifies where to find the built files to be uploaded.
769 By default, dgit looks in the parent directory
770 .RB ( .. ).
771 .TP
772 .BI --no-rm-on-error
773 Do not delete the destination directory if clone fails.
774 .TP
775 .BI --dep14tag
776 Generates a DEP-14 tag (eg
777 .BR debian/ \fIversion\fR)
778 as well as a dgit tag (eg
779 .BR archive/debian/ \fIversion\fR)
780 where possible.  This is the default.
781 .TP
782 .BI --no-dep14tag
783 Do not generate a DEP-14 tag, except in split quilt view mode.
784 (On servers where only the old tag format is supported,
785 the dgit tag will have the DEP-14 name.
786 This option does not prevent that.)
787 .TP
788 .BI --dep14tag-always
789 Insist on generating a DEP-14 tag
790 as well as a dgit tag.
791 If the server does not support that, dgit push will fail.
792 .TP
793 .BI -D
794 Prints debugging information to stderr.  Repeating the option produces
795 more output (currently, up to -DDDD is meaningfully different).
796 .TP
797 .BI -c name = value
798 Specifies a git configuration option, to be used for this run.
799 dgit itself is also controlled by git configuration options.
800 .TP
801 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
802 Specifies the
803 .BI -v version
804 option to pass to dpkg-genchanges, during builds.  Changes (from
805 debian/changelog) since this version will be included in the built
806 changes file, and hence in the upload.  If this option is not
807 specified, dgit will query the archive and use the latest version
808 uploaded to the intended suite.
810 Specifying
811 .B _
812 inhibits this, so that no -v option will be passed to dpkg-genchanges
813 (and as a result, only the last stanza from debian/changelog will
814 be used for the build and upload).
815 .TP
816 .RI \fB-m\fR maintaineraddress
817 Passed to dpkg-genchanges (eventually).
818 .TP
819 .RI \fB--ch:\fR option
820 Specifies a single additional option to pass, eventually, to
821 dpkg-genchanges.
823 Options which are safe to pass include
824 .BR -C
825 (and also
826 .BR "-si -sa -sd"
827 although these should never be necessary with Debian since dgit
828 automatically calculates whether .origs need to be uploaded.)
830 For other options the caveat below applies.
831 .TP
832 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
833 Specifies a single additional option to pass to
834 .BR curl ,
835 .BR dput ,
836 .BR debsign ,
837 .BR dpkg-source ,
838 .BR dpkg-buildpackage ,
839 .BR dpkg-genchanges ,
840 .BR sbuild ,
841 .BR ssh ,
842 .BR dgit ,
843 .BR git-debrebase ,
844 .BR apt-get ,
845 .BR apt-cache ,
846 .BR gbp-pq ,
847 .BR gbp-build ,
848 or
849 .BR mergechanges .
850 Can be repeated as necessary.
852 Use of this ability should not normally be necessary.
853 It is provided for working around bugs,
854 or other unusual situations.
855 If you use these options,
856 you may violate dgit's assumptions
857 about the behaviour of its subprograms
858 and cause lossage.
860 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
861 the option applies only when the program is invoked directly by dgit.
862 Usually, for passing options to dpkg-genchanges, you should use
863 .BR --ch: \fIoption\fR.
865 Specifying --git is not effective for some lower-level read-only git
866 operations performed by dgit, and also not when git is invoked by
867 another program run by dgit.
869 See notes below regarding ssh and dgit.
871 NB that --gpg:option is not supported (because debsign does not
872 have that facility).
873 But see
874 .B -k
875 and the
876 .B keyid
877 distro config setting.
878 .TP
879 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
880 Specifies alternative programs to use instead of
881 .BR curl ,
882 .BR dput ,
883 .BR debsign ,
884 .BR dpkg-source ,
885 .BR dpkg-buildpackage ,
886 .BR dpkg-genchanges ,
887 .BR sbuild ,
888 .BR gpg ,
889 .BR ssh ,
890 .BR dgit ,
891 .BR git-debrebase ,
892 .BR apt-get ,
893 .BR apt-cache ,
894 .BR git ,
895 .BR gbp-pq ,
896 .BR gbp-build ,
897 or
898 .BR mergechanges .
900 For
901 .BR dpkg-buildpackage ,
902 .BR dpkg-genchanges ,
903 .B mergechanges
904 and
905 .BR sbuild ,
906 this applies only when the program is invoked directly by dgit.
908 For
909 .BR dgit ,
910 specifies the command to run on the remote host when dgit
911 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
912 itself as the EDITOR for dpkg-source --commit; this is done using
913 argv[0], and is not affected by --dgit=).
915 .BR gbp-build 's
916 value
917 is used instead of gbp build or git-buildpackage.  (The default is
918 the latter unless the former exists on PATH.)
919 .BR gbp-pq 's
920 value
921 is used instead of gbp pq.
922 In both cases,
923 unusually, the specified value is split on whitespace
924 to produce a command and possibly some options and/or arguments.
926 For
927 .BR ssh ,
928 the default value is taken from the
930 or
931 .B GIT_SSH
932 environment variables, if set (see below).  And, for ssh, when accessing the
933 archive and dgit-repos, this command line setting is overridden by the
934 git config variables
935 .BI dgit-distro. distro .ssh
936 and
937 .B .dgit.default.ssh
938 (which can in turn be overridden with -c).  Also, when dgit is using
939 git to access dgit-repos, only git's idea of what ssh to use (eg,
940 .BR GIT_SSH )
941 is relevant.
942 .TP
943 .BI --existing-package= package
944 dgit push needs to canonicalise the suite name.  Sometimes, dgit
945 lacks a way to ask the archive to do this without knowing the
946 name of an existing package.  Without --new we can just use the
947 package we are trying to push.  But with --new that will not work, so
948 we guess
949 .B dpkg
950 or use the value of this option.  This option is not needed with the
951 default mechanisms for accessing the archive.
952 .TP
953 .BR -h | --help
954 Print a usage summary.
955 .TP
956 .BI --initiator-tempdir= directory
957 dgit rpush uses a temporary directory on the invoking (signing) host.
958 This option causes dgit to use
959 .I directory
960 instead.  Furthermore, the specified directory will be emptied,
961 removed and recreated before dgit starts, rather than removed
962 after dgit finishes.  The directory specified must be an absolute
963 pathname.
964 .TP
965 .BI --force- something
966 Instructs dgit to try to proceed despite detecting
967 what it thinks is going to be a fatal problem.
968 .B This is probably not going to work.
969 These options are provided as an escape hatch,
970 in case dgit is confused.
971 (They might also be useful for testing error cases.)
972 .TP
973 .B --force-import-dsc-with-dgit-field
974 Tell dgit import-dsc to treat a .dsc with a Dgit field
975 like one without it.
976 The result is a fresh import,
977 discarding the git history
978 that the person who pushed that .dsc was working with.
979 .TP
980 .B --force-unrepresentable
981 Carry on even if
982 dgit thinks that your git tree contains changes
983 (relative to your .orig tarballs)
984 which dpkg-source is not able to represent.
985 Your build or push will probably fail later.
986 .TP
987 .B --force-changes-origs-exactly
988 Use the set of .origs specified in your .changes, exactly,
989 without regard to what is in the archive already.
990 The archive may well reject your upload.
991 .TP
992 .B --force-unsupported-source-format
993 Carry on despite dgit not understanding your source package format.
994 dgit will probably mishandle it.
995 .TP
996 .B --force-dsc-changes-mismatch
997 Do not check whether .dsc and .changes match.
998 The archive will probably reject your upload.
999 .TP
1000 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
1001 Force on or off the use of the absurd git-apply emulation
1002 when running gbp pq import
1003 when importing a package from a .dsc.
1004 See Debian bug #841867.
1006 dgit can be configured via the git config system.
1007 You may set keys with git-config (either in system-global or per-tree
1008 configuration), or provide
1009 .BI -c key = value
1010 on the dgit command line.
1011 .LP
1012 Settings likely to be useful for an end user include:
1013 .TP
1014 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
1015 Specifies the distro for a suite.  dgit keys off the suite name (which
1016 appears in changelogs etc.), and uses that to determine the distro
1017 which is involved.  The config used is thereafter that for the distro.
1019 .I suite
1020 may be a glob pattern.
1021 .TP
1022 .BI dgit.default.distro " distro"
1023 The default distro for an unknown suite.
1024 .TP
1025 .BI dgit.default.default-suite " suite"
1026 The default suite (eg for clone).
1027 .TP
1028 .BR dgit.default. *
1029 for each
1030 .BR dgit-distro. \fIdistro\fR . *,
1031 the default value used if there is no distro-specific setting.
1032 .TP
1033 .BR dgit-distro. \fIdistro\fR .clean-mode
1034 One of the values for the command line --clean= option; used if
1035 --clean is not specified.
1036 .TP
1037 .BR dgit-distro. \fIdistro\fR .quilt-mode
1038 One of the values for the command line --quilt= option; used if
1039 --quilt is not specified.
1040 .TP
1041 .BR dgit-distro. \fIdistro\fR .rm-old-changes
1042 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
1043 is specified.  The default is not to remove.
1044 .TP
1045 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
1046 Whether you have push access to the distro.
1047 For Debian, it is OK to use auto, which uses readonly mode if you are
1048 not pushing right now;
1049 but, setting this to false will avoid relying on the mirror of the dgit
1050 git repository server.
1051 .TP
1052 .BI dgit-distro. distro .keyid
1053 See also
1054 .BR -k .
1055 .TP
1056 .BI dgit-distro. distro .mirror " url"
1057 .TP
1058 .BI dgit-distro. distro .username
1059 Not relevant for Debian.
1060 .TP
1061 .BI dgit-distro. distro .upload-host
1062 Might be useful if you have an intermediate queue server.
1063 .TP
1064 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
1065 Values to configure for and in new git trees.  If
1066 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
1067 used, respectively.  Only used if .setup-usermail is not disabled.
1068 .TP
1069 .BI dgit-distro. distro .setup-useremail
1070 Whether to set and in new git trees.
1071 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
1072 .TP
1073 .BI dgit-distro. distro .setup-mergechangelogs
1074 Whether to setup a merge driver which uses dpkg-mergechangelogs for
1075 debian/changelog.  True by default.  Ignored for dgit
1076 setup-mergechangelogs, which does it anyway.
1077 .TP
1078 .BI dgit-distro. distro .setup-gitattributes
1079 Whether to configure .git/info/attributes
1080 to suppress checkin/checkout file content transformations
1081 in new git trees.
1082 True by default.  Ignored for dgit setup-gitattributes, which does it anyway.
1083 .TP
1084 .BI dgit-distro. distro .cmd- cmd
1085 Program to use instead of
1086 .IR cmd .
1087 Works like
1088 .BR -- \fIcmd\fR = "... ."
1089 .TP
1090 .BI dgit-distro. distro .opts- cmd
1091 Extra options to pass to
1092 .IR cmd .
1093 Works like
1094 .BR -- \fIcmd\fR : "... ."
1095 To pass several options, configure multiple values in git config
1096 (with git config --add).  The options for
1097 .BI dgit.default.opts- cmd
1098 .BI dgit-distro. distro /push.opts- cmd
1099 and are all used, followed by options from dgit's command line.
1101 There are many other settings which specify how a particular distro's
1102 services (archive and git) are provided.  These should not normally be
1103 adjusted, but are documented for the benefit of distros who wish to
1104 adopt dgit.
1105 .TP
1106 .BI dgit-distro. distro .nominal-distro
1107 Shown in git tags, Dgit fields, and so on.
1108 .TP
1109 .BI dgit-distro. distro .alias-canon
1110 Used for all access configuration lookup.
1111 .TP
1112 .BR dgit-distro. \fIdistro\fR /push. *
1113 If set, overrides corresponding non \fB/push\fR config when
1114 .BR readonly=false ,
1115 or when pushing and
1116 .BR readonly=auto .
1117 .TP
1118 .BI dgit-distro. distro .git-url
1119 .TP
1120 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1121 .TP
1122 .BI dgit-distro. distro .git-proto
1123 .TP
1124 .BI dgit-distro. distro .git-path
1125 .TP
1126 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1127 .TP
1128 .BI dgit-distro. distro .git-check-suffix
1129 .TP
1130 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1131 .TP
1132 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1133 .TP
1134 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
1135 .TP
1136 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1137 .TP
1138 .BI dgit-distro. distro .madison-distro
1139 .TP
1140 .BI dgit-distro. distro .archive-query-default-component
1141 .TP
1142 .BI dgit-distro. distro .dgit-tag-format
1143 .TP
1144 .BR dgit-distro. \fIdistro\fR .dep14tag " " want | no | always
1145 .TP
1146 .BI dgit-distro. distro .ssh
1147 .TP
1148 .BI dgit-distro. distro .sshpsql-dbname
1149 .TP
1150 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1151 .TP
1152 .BI dgit-distro. distro .backports-quirk
1153 .TP
1154 .BI dgit-distro. distro .rewrite-map-enable
1155 .TP
1156 .BI dgit.default.old-dsc-distro
1157 .TP
1158 .BI dgit.dsc-url-proto-ok. protocol
1159 .TP
1160 .BI dgit.dsc-url-proto-ok.bad-syntax
1161 .TP
1162 .BI dgit.default.dsc-url-proto-ok
1164 .TP
1165 .BR DGIT_SSH ", " GIT_SSH
1166 specify an alternative default program (and perhaps arguments) to use
1167 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
1168 if it contains any whitespace will be passed to the shell.  GIT_SSH
1169 specifies just the program; no arguments can be specified, so dgit
1170 interprets it the same way as git does.
1171 See
1172 also the --ssh= and --ssh: options.
1173 .TP
1175 Default git and for new trees.  See
1176 .BR "dgit setup-new-tree" .
1177 .TP
1178 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1179 and other subprograms and modules used by dgit are affected by various
1180 environment variables.  Consult the documentaton for those programs
1181 for details.
1182 .SH BUGS
1183 There should be
1184 a `dgit rebase-prep' command or some such to turn a
1185 fast-forwarding branch containing pseudo-merges
1186 back into a rebasing patch stack.
1187 It might have to leave a note
1188 for a future dgit push.
1190 If the dgit push fails halfway through,
1191 it is not necessarily restartable and
1192 idempotent.
1193 It would be good to check that the proposed signing key is
1194 available before starting work.
1196 dgit's build functions, and dgit push, may make changes to
1197 your current HEAD.  Sadly this is necessary for packages in the `3.0
1198 (quilt)' source format.  This is ultimately due to what I consider
1199 design problems in quilt and dpkg-source.
1201 --dry-run does not always work properly, as not doing some of the git
1202 fetches may result in subsequent actions being different.  Doing a
1203 non-dry-run dgit fetch first will help.
1204 --damp-run is likely to work much better.
1206 \fBdgit\fP(7),
1207 \fBdgit-*\fP(7),
1208 \fBcurl\fP(1),
1209 \fBdput\fP(1),
1210 \fBdebsign\fP(1),
1211 \fBgit-config\fP(1),
1212 \fBgit-buildpackage\fP(1),
1213 \fBdpkg-buildpackage\fP(1),
1214 .br