2 .TH dgit 1 "" "Debian Project" "dgit"
4 dgit \- git integration with the Debian archive
8 [\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
9 \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
12 [\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]
16 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP
20 [\fIdgit\-opts\fP] \fBpbuilder\fP|\fBcowbuilder\fP
24 [\fIdgit\-opts\fP] \fBpush\fP|\fBpush-source\fP [\fIdgit\-opts\fP]
28 [\fIdgit\-opts\fP] \fBrpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR
32 [\fIdgit\-opts\fP] \fIaction\fR ...
35 allows you to treat the Debian archive as if it were a git
38 it allows Debian to publish the source of its packages
39 as git branches, in a format which is directly useable
42 This is the command line reference.
43 Please read the tutorial(s):
46 dgit-user(7) for users: edit, build and share packages
47 dgit-nmu-simple(7) for DDs: do a straightforward NMU
48 dgit-maint-native(7) for maintainers of Debian-native packages
49 dgit-maint-debrebase(7) for maintainers: a pure-git rebasish workflow
50 dgit-maint-merge(7) for maintainers: a pure-git merging workflow
51 dgit-maint-gbp(7) for maintainers already using git-buildpackage
52 dgit-sponsorship(7) for sponsors and sponsored contributors
53 dgit-downstream-dsc(7) setting up dgit push for a new distro
56 See \fBdgit(7)\fP for detailed information about the data
58 common problems likely to arise with certain kinds of package,
62 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
63 Consults the archive and dgit-repos to construct the git view of
70 in a new directory (named
73 also, downloads any necessary orig tarballs.
75 The suite's git tip is
76 left on the local branch
78 ready for work, and on the corresponding dgit remote tracking branch.
81 remote will be set up to point to the package's dgit-repos tree
82 for the distro to which
87 may be a combination of several underlying suites in the form
88 .IR mainsuite \fB,\fR subsuite ...;
89 see COMBINED SUITES in dgit(7).
91 For your convenience, the
93 remote will be set up from the package's Vcs-Git field, if there is
94 one - but note that in the general case the history found there may be
95 different to or even disjoint from dgit's view.
96 (See also dgit update-vcs-git.)
98 \fBdgit fetch\fR [\fIsuite\fP]
99 Consults the archive and git-repos to update the git view of
100 history for a specific suite (and downloads any necessary orig
101 tarballs), and updates the remote tracking branch
102 .BR remotes/dgit/dgit/ \fIsuite\fR.
103 If the current branch is
105 then dgit fetch defaults to
107 otherwise it parses debian/changelog and uses the suite specified
109 suite may be a combined suite, as for clone.
111 \fBdgit pull\fR [\fIsuite\fP]
112 Does dgit fetch, and then merges the new head of the remote tracking
114 .BI remotes/dgit/dgit/ suite
115 into the current branch.
117 \fBdgit checkout\fR \fIsuite\fR
118 Checks out the local branch
119 .BR dgit/ \fIsuite\fR.
121 If the branch does not exist,
122 dgit checkout creates it,
123 and sets it up the same way as dgit clone would.
125 the archive remote tracking branch does not exist,
126 dgit checkout will do a dgit fetch first.
128 NB: dgit checkout will only do a fetch if it has to.
129 If you already have the suite branch,
130 and want to merge your branch with updates from the archive,
133 dgit checkout will normally need to aceess the archive server,
134 to canonicalise the provided suite name.
135 The exception is if you specify the canonical name,
136 and the branch (or tracking branch) already exists.
141 with some suitable options. Options and arguments after build
142 will be passed on to dpkg-buildpackage. It is not necessary to use
143 dgit build when using dgit; it is OK to use any approach which ensures
144 that the generated source package corresponds to the relevant git
147 Tagging, signing and actually uploading should be left to dgit push.
149 dgit's build operations access the the network,
150 to get the -v option right.
153 \fBdgit build-source\fR ...
154 Builds the source package, and a changes file for a prospective
155 source-only upload, using
157 The output is left in
158 .IR package \fB_\fR version \fB.dsc\fR
160 .IR package \fB_\fR version \fB_source.changes\fR.
162 Tagging, signing and actually uploading should be left to dgit
163 push-source, or dgit push.
166 Cleans the current working tree (according to the --clean= option in
169 \fBdgit update-vcs-git\fR [\fIsuite\fP|\fB.\fR] [\fB--\fR] [\fIgit fetch options\fR]
171 \fBdgit update-vcs-git\fR [\fIsuite|\fP\fB.\fR] \fB-\fR
172 Sets up, or updates the url of, the vcs-git remote, and
173 (unless \fB-\fR was specified)
174 runs git fetch on it.
176 By default, the Vcs-Git field of the .dsc from Debian sid is used,
177 as that is probably most up to date.
178 Another suite may be specified, or
180 to indicate that the Vcs-Git of the cwd's debian/control should
184 Print a usage summary.
186 \fBdgit sbuild\fR ...
187 Constructs the source package, uses
189 to do a binary build, and uses mergechanges to merge the source and
190 binary changes files. Options and arguments after sbuild will be
192 The output is left in
193 .IR package \fB_\fR version \fB_multi.changes\fR.
196 sbuild does not build arch-independent packages.
197 You probably want to pass -A, to request those.
199 Tagging, signing and actually uploading should be left to dgit push.
201 \fBdgit pbuilder\fR [\fIdebbuildopts\fP]
202 Constructs the source package, uses
204 to do a binary build, and uses mergechanges to merge the source and
205 binary changes files.
206 The output is left in
207 .IR package \fB_\fR version \fB_multi.changes\fR.
209 You should ensure that your dgit --build-products-dir setting matches
210 your pbuilder --buildresult.
212 The \fIdebbuildopts\fP are passed to pbuilder using its --debbuildopts
213 option. If you want to pass other options to pbuilder, use the
214 \fB--pbuilder:\fR dgit option as described below
215 (remember that dgit options should appear between \fBdgit\fR and
218 You should ensure that in your pbuilderrc you do
221 .B SOURCE_ONLY_CHANGES=yes
222 as this may cause trouble.
224 \fBdgit cowbuilder\fR [\fIdebbuildopts\fP]
225 Like \fBdgit pbuilder\fR, but uses
230 \fBdgit gbp-build\fR ...
233 with some suitable options. Options and arguments after gbp-build
234 will be passed on to git-buildpackage.
236 By default this uses \-\-quilt=gbp, so HEAD should be a
237 git-buildpackage style branch, not a patches-applied branch.
239 Tagging, signing and actually uploading should be left to dgit push.
241 \fBdgit push\fR [\fIsuite\fP]
242 Does an `upload', pushing the current HEAD to the archive (as a source
243 package) and to dgit-repos (as git commits). The package must already
244 have been built ready for upload, with the .dsc and .changes
245 left in the parent directory. It is normally best to do the build
246 with dgit too (eg with dgit sbuild): some existing build tools pass
247 unhelpful options to dpkg-source et al by default, which can result in
248 the built source package not being identical to the git tree.
250 In more detail: dgit push checks that the current HEAD corresponds to
251 the .dsc. It then pushes the HEAD to the suite's dgit-repos branch,
252 adjusts the .changes to include any .origs which the archive lacks
253 and exclude .origs which the archive has
254 (so -sa and -sd are not needed when building for dgit push),
255 makes a signed git tag, edits the .dsc to contain the dgit metadata
256 field, runs debsign to sign the upload (.dsc and .changes), pushes the
257 signed tag, and finally uses dput to upload the .changes to the
260 dgit push always uses the package, suite and version specified in the
261 debian/changelog and the .dsc, which must agree. If the command line
262 specifies a suite then that must match too.
264 When used on a git-debrebase branch,
265 dgit calls git-debrebase
266 to prepare the branch
267 for source package upload and push.
269 \fBdgit push-source\fR [\fIsuite\fP]
270 Without \fB-C\fR, builds a source package and dgit pushes it. Saying
271 \fBdgit push-source\fR is like saying "update the source code in the
272 archive to match my git HEAD, and let the autobuilders do the rest."
274 With \fB-C\fR, performs a dgit push, additionally ensuring that no
275 binary packages are uploaded.
277 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
278 Pushes the contents of the specified directory on a remote machine.
279 This is like running dgit push on build-host with build-dir as the
280 current directory; however, signing operations are done on the
281 invoking host. This allows you to do a push when the system which has
282 the source code and the build outputs has no access to the key:
286 1. Clone on build host (dgit clone)
287 2. Edit code on build host (edit, git commit)
288 3. Build package on build host (dgit build)
289 4. Test package on build host or elsewhere (dpkg -i, test)
290 5. Upload by invoking dgit rpush on host with your GPG key.
293 However, the build-host must be able to ssh to the dgit repos. If
294 this is not already the case, you must organise it separately, for
295 example by the use of ssh agent forwarding.
297 The remaining arguments are treated just as dgit push would handle
300 build-host and build\-dir can be passed as separate
301 arguments; this is assumed to be the case if the first argument
302 contains no : (except perhaps one in [ ], to support IPv6 address
305 You will need similar enough versions of dgit on the build-host and
306 the invocation host. The build-host needs gnupg installed, with your
307 public key in its keyring (but not your private key, obviously).
309 .B dgit setup-new-tree
310 Configure the current working tree the way that dgit clone would have
311 set it up. Like running
312 .BR "dgit setup-useremail" ,
313 .B setup-mergechangelogs
315 .B setup-gitattributes
316 (but only does each thing if dgit is configured to do it automatically).
317 You can use these in any git repository, not just ones used with
318 the other dgit operations.
323 (as that requires Debian packaging information).
325 .B dgit setup-useremail
326 Set the working tree's user.name and user.email from the
327 distro-specific dgit configuration
328 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
329 or DEBFULLNAME or DEBEMAIL.
331 .B dgit setup-mergechangelogs
332 Configures a git merge helper for the file
335 .BR dpkg-mergechangelogs .
337 .B dgit setup-gitattributes
338 Set up the working tree's
339 .B .git/info/attributes
340 to disable all transforming attributes for all files.
341 This is done by defining a macro attribute
350 If there is an existing macro attribute line
351 .B [attr]dgit-defuse-attrs
352 in .git/info/attributes,
353 but it is insufficient,
354 because it was made by an earlier version of dgit
355 and git has since introduced new transforming attributes,
356 modifies the macro to disable the newer transformations.
358 (If there is already a macro attribute line
359 .B [attr]dgit-defuse-attrs
360 in .git/info/attributes
361 which does what dgit requires
362 (whatever files it effects),
363 this operation does nothing further.
364 This fact can be used to defeat or partially defeat
365 dgit setup-gitattributes
367 dgit setup-new-tree.)
370 `3.0 (quilt)' format source packages need changes representing not
371 only in-tree but also as patches in debian/patches. dgit quilt-fixup
372 checks whether this has been done; if not, dgit will make appropriate
373 patches in debian/patches and also commit the resulting changes to
376 This is normally done automatically by dgit build and dgit push.
378 dgit will try to turn each relevant commit in your git history into a
379 new quilt patch. dgit cannot convert nontrivial merges, or certain
380 other kinds of more exotic history. If dgit can't find a suitable
381 linearisation of your history, by default it will fail, but you can
382 ask it to generate a single squashed patch instead.
384 When used with a git-debrebase branch,
385 dgit will ask git-debrebase to prepare patches.
387 dgit can make patches in some situations where git-debrebase fails,
388 so dgit quilt-fixup can be useful in its own right.
389 To always use dgit's own patch generator
390 instead of git-debrebase make-patches,
391 pass --git-debrebase=true to dgit.
394 .B FORMAT 3.0 (QUILT)
398 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
399 Import a Debian-format source package,
400 specified by its .dsc,
402 the way dgit fetch would do.
404 This does about half the work of dgit fetch:
405 it will convert the .dsc into a new, orphan git branch.
406 Since dgit has no access to a corresponding source package archive
407 or knowledge of the history
408 it does not consider whether this version is newer
409 than any previous import
410 or corresponding git branches;
411 and it therefore does not
412 make a pseudomerge to bind the import
413 into any existing git history.
415 Because a .dsc can contain a Dgit field naming a git commit
416 (which you might not have),
417 and specifying where to find that commit
418 (and any history rewrite table),
419 import-dsc might need online access.
421 (or dgit's efforts to find the commit fail),
422 consider --no-chase-dsc-distro
423 or --force-import-dsc-with-dgit-field.
425 There is only only sub-option:
427 .B --require-valid-signature
428 causes dgit to insist that the signature on the .dsc is valid
429 (using the same criteria as dpkg-source -x).
430 Otherwise, dgit tries to verify the signature but
431 the outcome is reported only as messages to stderr.
437 then if it already exists, it will be simply ovewritten,
438 no matter its existing contents.
443 then if it already exists
444 and dgit actually imports the dsc
445 (rather than simply reading the git commit out of the Dgit field),
446 dgit will make a pseudomerge
447 so that the result is necessarily fast forward
448 from the existing branch.
449 Otherwise, if branch already exists,
450 dgit will stop with an error message.
454 does not start with refs/, refs/heads/ is prepended.
457 Prints version information and exits.
459 .BI "dgit clone-dgit-repos-server" " destdir"
460 Tries to fetch a copy of the source code for the dgit-repos-server,
461 as actually being used on the dgit git server, as a git tree.
463 .BI "dgit print-dgit-repos-server-source-url"
464 Prints the url used by dgit clone-dgit-repos-server.
465 This is hopefully suitable for use as a git remote url.
466 It may not be useable in a browser.
468 .BI "dgit print-dpkg-source-ignores"
469 Prints the -i and -I arguments which must be passed to dpkg-souce
470 to cause it to exclude exactly the .git diredcory
472 The separate arguments are unquoted, separated by spaces,
473 and do not contain spaces.
475 .B dgit print-unapplied-treeish
476 Constructs a tree-ish approximating the patches-unapplied state
477 of your 3.0 (quilt) package,
478 and prints the git object name to stdout.
479 This requires appropriate .orig tarballs.
480 This tree object is identical to your .origs
481 as regards upstream files.
482 The contents of the debian subdirectory is not interesting
483 and should not be inspected;
484 except that debian/patches will be identical to your HEAD.
486 To make this operate off-line,
487 the access configuration key
488 which is used to determine the build-products-dir
489 is the uncanonicalised version of the suite name from the changelog,
490 or (of course) dgit.default.build-products-dir.
491 See ACCESS CONFIGURATION, below.
493 This function is primarily provided for the benefit of git-debrebase.
496 .BR --dry-run " | " -n
497 Go through the motions, fetching all information needed, but do not
498 actually update the output(s). For push, dgit does
499 the required checks and leaves the new .dsc in a temporary file,
500 but does not sign, tag, push or upload.
502 .BR --damp-run " | " -L
503 Go through many more of the motions: do everything that doesn't
504 involve either signing things, or making changes on the public
510 for signing the tag and the upload. The default comes from the
513 config setting (see CONFIGURATION, below), or failing that, the
514 uploader trailer line in debian/changelog.
517 does not sign tags or uploads (meaningful only with push).
521 Specifies that we should process source package
523 rather than looking in debian/control or debian/changelog.
524 Valid with dgit fetch and dgit pull, only.
526 .BR --clean=git " | " -wg
529 to clean the working tree,
530 rather than running the package's rules clean target.
532 This will delete all files which are not tracked by git.
533 (Including any files you forgot to git add.)
536 options other than dpkg-source
537 are useful when the package's clean target is troublesome, or
538 to avoid needing the build-dependencies.
540 .BR --clean=git-ff " | " -wgf
542 .BR "git clean -xdff"
543 to clean the working tree.
546 but it also removes any subdirectories containing different git
547 trees (which only unusual packages are likely to create).
549 .BR --clean=check " | " -wc
550 Merely check that the tree is clean (does not contain uncommitted
552 Avoids running rules clean,
553 and can avoid needing the build-dependencies.
555 .BR --clean=none " | " -wn
556 Do not clean the tree, nor check that it is clean.
557 Avoids running rules clean,
558 and can avoid needing the build-dependencies.
560 files which are not in git, or if the build creates such files, a
561 subsequent dgit push will fail.
563 .BR --clean=dpkg-source " | " -wd
564 Use dpkg-buildpackage to do the clean, so that the source package
565 is cleaned by dpkg-source running the package's clean target.
567 Requires the package's build dependencies.
569 .BR --clean=dpkg-source-d " | " -wdd
571 .B dpkg-buildpackage -d
573 so that the source package
574 is cleaned by dpkg-source running the package's clean target.
575 The build-dependencies are not checked (due to
577 which violates policy, but may work in practice.
580 The package is or may be new in this suite. Without this, dgit will
581 refuse to push. It may (for Debian, will) be unable to access the git
582 history for any packages which have been newly pushed and have not yet
586 Do not complain if the working tree does not match your git HEAD,
588 include the changes from your working tree.
589 This can be useful with build, if you plan to commit later. (dgit
590 push will still ensure that the .dsc you upload and the git tree
591 you push are identical, so this option won't make broken pushes.)
594 Deprecated alias for --include-dirty.
596 .BR --overwrite [=\fIprevious-version\fR]
597 Declare that your HEAD really does contain
598 all the (wanted) changes
599 from all versions listed in its changelog;
600 or, all (wanted) changes from
601 .IR previous-version .
602 This promise is needed when
603 your git branch is not a descendant
604 of the version in the archive
605 according to the git revision history.
607 This option is useful if you are the maintainer, and you have
608 incorporated NMU changes into your own git workflow in a way that
609 doesn't make your branch a fast forward from the NMU.
611 This option is also usually necessary
612 the first time a package is pushed with dgit push
613 to a particular suite.
615 .BR dgit-maint- \fI*\fR (7) .
620 specified, dgit will check that the version in the archive is
621 mentioned in your debian/changelog.
622 (This will avoid losing
625 unless someone committed to git a finalised changelog
626 entry, and then made later changes to that version.)
629 is specified, it ought to be the version currently in the archive.
631 dgit push --overwrite
632 will, if necessary, make a
633 pseudo-merge (that is, something that looks like the result
634 of git merge -s ours) to stitch the archive's version into your own
635 git history, so that your push is a fast forward from the archive.
638 .BR gbp ", " dpm " or " unpatched ,
639 implying a split between the dgit view and the
640 maintainer view, the pseudo-merge will appear only in the dgit view.)
642 .BR --delayed =\fIdays\fR
643 Upload to a DELAYED queue.
646 If the maintainer responds by cancelling
647 your upload from the queue,
648 and does not make an upload of their own,
649 this will not rewind the git branch on the dgit git server.
650 Other dgit users will then see your push
651 (with a warning message from dgit)
652 even though the maintainer wanted to abolish it.
653 Such users might unwittingly reintroduce your changes.
655 If this situation arises,
656 someone should make a suitable dgit push
657 to update the contents of dgit-repos
658 to a version without the controversial changes.
660 .BR --no-chase-dsc-distro
661 Tells dgit not to look online
662 for additional git repositories
663 containing information about a particular .dsc being imported.
664 Chasing is the default.
667 (such as fetch and pull),
669 means dgit will access only the git server
670 for the distro you are directly working with,
671 even if the .dsc was copied verbatim from another distro.
674 means dgit will work completely offline.
676 Disabling chasing can be hazardous:
677 if the .dsc names a git commit which has been rewritten
678 by those in charge of the distro,
679 this option may prevent that rewrite from being effective.
682 dgit fails to find necessary git commits.
684 .BR --save-dgit-view= \fIbranch\fR|\fIref\fR
685 Specifies that when a split view quilt mode is in operation,
687 (or looks up in its cache)
688 a dgit view corresponding to your HEAD,
689 the dgit view will be left in
691 The specified ref is unconditionally overwritten,
692 so don't specify a branch you want to keep.
694 This option is effective only with the following operations:
695 quilt-fixup; push; all builds.
696 And it is only effective with
701 If ref does not start with refs/
702 it is taken to to be a branch -
703 i.e. refs/heads/ is prepended.
706 is a deprecated alias for
709 .BI --deliberately- something
710 Declare that you are deliberately doing
712 This can be used to override safety catches, including safety catches
713 which relate to distro-specific policies.
714 The use of --deliberately is declared and published in the signed tags
715 generated for you by dgit,
716 so that the archive software can give effect to your intent,
718 for the benefit humans looking at the history.
721 understood in the context of Debian are discussed below:
723 .BR --deliberately-not-fast-forward
724 Declare that you are deliberately rewinding history. When pushing to
725 Debian, use this when you are making a renewed upload of an entirely
726 new source package whose previous version was not accepted for release
727 from NEW because of problems with copyright or redistributibility.
729 In split view quilt modes,
730 this also prevents the construction by dgit of a pseudomerge
731 to make the dgit view fast forwarding.
733 --overwrite (which creates a suitable pseudomerge)
735 --deliberately-not-fast-forward
736 (which suppresses the pseudomerge and the fast forward checks)
738 --overwrite is usually better.
740 .BR --deliberately-include-questionable-history
741 Declare that you are deliberately including, in the git history of
742 your current push, history which contains a previously-submitted
743 version of this package which was not approved (or has not yet been
744 approved) by the ftpmasters. When pushing to Debian, only use this
745 option after verifying that: none of the rejected-from-NEW (or
746 never-accepted) versions in the git history of your current push, were
747 rejected by ftpmaster for copyright or redistributability reasons.
749 .BR --deliberately-fresh-repo
750 Declare that you are deliberately rewinding history and want to
751 throw away the existing repo. Not relevant when pushing to Debian,
752 as the Debian server will do this automatically when necessary.
755 When fixing up source format `3.0 (quilt)' metadata, insist on
756 generating a linear patch stack: one new patch for each relevant
758 If such a stack cannot be generated, fail.
759 This is the default for Debian.
761 HEAD should be a series of plain commits
762 (not touching debian/patches/),
764 with as ancestor a patches-applied branch.
767 When fixing up source format `3.0 (quilt)' metadata, prefer to
768 generate a linear patch stack
769 (as with --quilt=auto)
770 but if that doesn't seem possible,
771 try to generate a single squashed patch for all the changes made in git
772 (as with --quilt=smash).
773 This is not a good idea for an NMU in Debian.
776 When fixing up source format `3.0 (quilt)' metadata,
777 generate a single additional patch for all the changes made in git.
778 This is not a good idea for an NMU in Debian.
780 (If HEAD has any in-tree patches already, they must apply cleanly.
781 This will be the case for any trees produced by dgit fetch or clone;
782 if you do not change the upstream version
783 nor make changes in debian/patches,
784 it will remain true.)
787 Check whether source format `3.0 (quilt)' metadata would need fixing
788 up, but, if it does, fail. You must then fix the metadata yourself
789 somehow before pushing. (NB that dpkg-source --commit will not work
790 because the dgit git tree does not have a
794 .BR --quilt=nocheck " | " --no-quilt-fixup
795 Do not check whether up source format `3.0 (quilt)' metadata needs
796 fixing up. If you use this option and the metadata did in fact need
797 fixing up, dgit push will fail.
799 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
800 Tell dgit that you are using a nearly-dgit-compatible git branch,
802 .BR "maintainer view" ,
804 do not want your branch changed by dgit.
809 is for use with git-buildpackage.
810 Your HEAD is expected to be
811 a patches-unapplied git branch, except that it might contain changes
812 to upstream .gitignore files. This is the default for dgit gbp-build.
817 is for use with git-dpm.
818 Your HEAD is expected to be
819 a patches-applied git branch,
820 except that it might contain changes to upstream .gitignore files.
823 specifies that your HEAD is a patches-unapplied git branch (and
824 that any changes to upstream .gitignore files are represented as
825 patches in debian/patches).
827 With --quilt=gbp|dpm|unapplied,
828 dgit push (or precursors like quilt-fixup and build) will automatically
829 generate a conversion of your git branch into the right form.
830 dgit push will push the
831 dgit-compatible form (the
833 to the dgit git server.
834 The dgit view will be visible to you
835 in the dgit remote tracking branches, but your own branch will
837 dgit push will create a tag
839 for the maintainer view, and the dgit tag
840 .BI archive/debian/ version
842 dgit quilt-fixup will merely do some checks,
843 and cache the maintainer view.
845 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
846 This is because it is not always possible to tell: a patches-unapplied
847 git branch of a package with one patch, for example, looks very like
848 a patches-applied branch where the user has used git revert to
849 undo the patch, expecting to actually revert it.
850 However, if you fail to specify the right \-\-quilt option,
851 and you aren't too lucky, dgit will notice the problem and stop,
854 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
855 Specifies that the suite to be operated on is part of distro
857 This overrides the default value found from the git config option
858 .BR dgit-suite. \fIsuite\fR .distro .
859 The only effect is that other configuration variables (used
860 for accessing the archive and dgit-repos) used are
861 .BR dgit-distro. \fIdistro\fR .* .
863 If your suite is part of a distro that dgit already knows about, you
864 can use this option to make dgit work even if your dgit doesn't know
865 about the suite. For example, specifying
867 will work when the suite is an unknown suite in the Debian archive.
869 To define a new distro it is necessary to define methods and URLs
870 for fetching (and, for dgit push, altering) a variety of information both
871 in the archive and in dgit-repos.
872 How to set this up is not yet documented.
875 Specifies the .changes file which is to be uploaded. By default
876 dgit push looks for single .changes file in the parent directory whose
877 filename suggests it is for the right package and version.
881 pathname contains slashes, the directory part is also used as
883 .BR --build-products-dir ;
884 otherwise, the changes file is expected in that directory (by
889 When doing a build, delete any changes files matching
890 .IB package _ version _*.changes
891 before starting. This ensures that
892 dgit push (and dgit sbuild) will be able to unambigously
893 identify the relevant changes files from the most recent build, even
894 if there have been previous builds with different tools or options.
895 The default is not to remove, but
896 .B \-\-no-rm-old-changes
897 can be used to override a previous \-\-rm-old-changes
898 or the .rm-old-changes configuration setting.
900 Note that \fBdgit push-source\fR will always find the right .changes,
901 regardless of this option.
903 .BI --build-products-dir= directory
904 Specifies where to find and create tarballs, binry packages,
905 source packages, .changes files, and so on.
907 By default, dgit uses the parent directory
910 Changing this setting may necessitate
911 moving .orig tarballs to the new directory,
912 so it is probably best to
914 .BI dgit.default.build-products-dir
915 configuration setting
916 (see CONFIGURATION, below)
917 which this command line option overrides).
920 Do not delete the destination directory if clone fails.
923 Generates a DEP-14 tag (eg
924 .BR debian/ \fIversion\fR)
925 as well as a dgit tag (eg
926 .BR archive/debian/ \fIversion\fR)
927 where possible. This is the default.
930 Do not generate a DEP-14 tag, except in split quilt view mode.
931 (On servers where only the old tag format is supported,
932 the dgit tag will have the DEP-14 name.
933 This option does not prevent that.)
935 .BI --dep14tag-always
936 Insist on generating a DEP-14 tag
937 as well as a dgit tag.
938 If the server does not support that, dgit push will fail.
941 Prints debugging information to stderr. Repeating the option produces
942 more output (currently, up to -DDDD is meaningfully different).
945 Specifies a git configuration option, to be used for this run.
946 dgit itself is also controlled by git configuration options.
948 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
951 option to pass to dpkg-genchanges, during builds. Changes (from
952 debian/changelog) since this version will be included in the built
953 changes file, and hence in the upload. If this option is not
954 specified, dgit will query the archive and use the latest version
955 uploaded to the intended suite.
959 inhibits this, so that no -v option will be passed to dpkg-genchanges
960 (and as a result, only the last stanza from debian/changelog will
961 be used for the build and upload).
963 .RI \fB-m\fR maintaineraddress
964 Passed to dpkg-genchanges (eventually).
966 .RI \fB--ch:\fR option
967 Specifies a single additional option to pass, eventually, to
970 Options which are safe to pass include
974 although these should never be necessary with Debian since dgit
975 automatically calculates whether .origs need to be uploaded.)
977 For other options the caveat below applies.
979 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
980 Specifies a single additional option to pass to
985 .BR dpkg-buildpackage ,
986 .BR dpkg-genchanges ,
999 Can be repeated as necessary.
1001 Use of this ability should not normally be necessary.
1002 It is provided for working around bugs,
1003 or other unusual situations.
1004 If you use these options,
1005 you may violate dgit's assumptions
1006 about the behaviour of its subprograms
1009 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
1010 the option applies only when the program is invoked directly by dgit.
1011 Usually, for passing options to dpkg-genchanges, you should use
1012 .BR --ch: \fIoption\fR.
1014 Specifying --git is not effective for some lower-level read-only git
1015 operations performed by dgit, and also not when git is invoked by
1016 another program run by dgit.
1018 See notes below regarding ssh and dgit.
1020 NB that --gpg:option is not supported (because debsign does not
1021 have that facility).
1026 distro config setting.
1028 .RI \fB--curl=\fR program " | \fB--dput=\fR" program " |..."
1029 Specifies alternative programs to use instead of
1034 .BR dpkg-buildpackage ,
1035 .BR dpkg-genchanges ,
1052 .BR dpkg-buildpackage ,
1053 .BR dpkg-genchanges ,
1057 this applies only when the program is invoked directly by dgit.
1061 specifies the command to run on the remote host when dgit
1062 rpush needs to invoke a remote copy of itself. (dgit also reinvokes
1063 itself as the EDITOR for dpkg-source --commit; this is done using
1064 argv[0], and is not affected by --dgit=).
1068 is used instead of gbp build or git-buildpackage. (The default is
1069 the latter unless the former exists on PATH.)
1072 is used instead of gbp pq.
1074 unusually, the specified value is split on whitespace
1075 to produce a command and possibly some options and/or arguments.
1077 For pbuilder and cowbuilder, the defaults are
1078 .BR "sudo -E pbuilder"
1080 .BR "sudo -E cowbuilder"
1082 Like with gbp-build and gbp pq,
1083 the specified value is split on whitespace.
1087 the default value is taken from the
1091 environment variables, if set (see below). And, for ssh, when accessing the
1092 archive and dgit-repos, this command line setting is overridden by the
1093 git config variables
1094 .BI dgit-distro. distro .ssh
1096 .B .dgit.default.ssh
1097 (which can in turn be overridden with -c). Also, when dgit is using
1098 git to access dgit-repos, only git's idea of what ssh to use (eg,
1102 .BI --existing-package= package
1103 dgit push needs to canonicalise the suite name. Sometimes, dgit
1104 lacks a way to ask the archive to do this without knowing the
1105 name of an existing package. Without --new we can just use the
1106 package we are trying to push. But with --new that will not work, so
1109 or use the value of this option. This option is not needed with the
1110 default mechanisms for accessing the archive.
1113 Print a usage summary.
1115 .BI --initiator-tempdir= directory
1116 dgit rpush uses a temporary directory on the invoking (signing) host.
1117 This option causes dgit to use
1119 instead. Furthermore, the specified directory will be emptied,
1120 removed and recreated before dgit starts, rather than removed
1121 after dgit finishes. The directory specified must be an absolute
1124 .BI --force- something
1125 Instructs dgit to try to proceed despite detecting
1126 what it thinks is going to be a fatal problem.
1127 .B This is probably not going to work.
1128 These options are provided as an escape hatch,
1129 in case dgit is confused.
1130 (They might also be useful for testing error cases.)
1132 .B --force-import-dsc-with-dgit-field
1133 Tell dgit import-dsc to treat a .dsc with a Dgit field
1134 like one without it.
1135 The result is a fresh import,
1136 discarding the git history
1137 that the person who pushed that .dsc was working with.
1139 .B --force-uploading-binaries
1142 even though dgit thinks your distro does not permit that.
1144 .B --force-uploading-source-only
1145 Carry on and do a source-only upload,
1146 without any binaries,
1147 even though dgit thinks your distro does not permit that,
1148 or does not permit that in this situation.
1150 .B --force-unrepresentable
1152 dgit thinks that your git tree contains changes
1153 (relative to your .orig tarballs)
1154 which dpkg-source is not able to represent.
1155 Your build or push will probably fail later.
1157 .B --force-changes-origs-exactly
1158 Use the set of .origs specified in your .changes, exactly,
1159 without regard to what is in the archive already.
1160 The archive may well reject your upload.
1162 .B --force-unsupported-source-format
1163 Carry on despite dgit not understanding your source package format.
1164 dgit will probably mishandle it.
1166 .B --force-dsc-changes-mismatch
1167 Do not check whether .dsc and .changes match.
1168 The archive will probably reject your upload.
1170 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
1171 Force on or off the use of the absurd git-apply emulation
1172 when running gbp pq import
1173 when importing a package from a .dsc.
1174 See Debian bug #841867.
1176 dgit can be configured via the git config system.
1177 You may set keys with git-config (either in system-global or per-tree
1178 configuration), or provide
1180 on the dgit command line.
1182 Settings likely to be useful for an end user include:
1184 .BI dgit.default.build-products-dir
1185 Specifies where to find the built files to be uploaded,
1186 when --build-products-dir is not specified. The default is
1187 the parent directory
1190 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
1191 Specifies the distro for a suite. dgit keys off the suite name (which
1192 appears in changelogs etc.), and uses that to determine the distro
1193 which is involved. The config used is thereafter that for the distro.
1196 may be a glob pattern.
1198 .BI dgit.default.distro " distro"
1199 The default distro for an unknown suite.
1201 .BI dgit.default.default-suite " suite"
1202 The default suite (eg for clone).
1206 .BR dgit-distro. \fIdistro\fR . *,
1207 the default value used if there is no distro-specific setting.
1209 .BR dgit-distro. \fIdistro\fR .clean-mode
1210 One of the values for the command line --clean= option; used if
1211 --clean is not specified.
1213 .BR dgit-distro. \fIdistro\fR .quilt-mode
1214 One of the values for the command line --quilt= option; used if
1215 --quilt is not specified.
1217 .BR dgit-distro. \fIdistro\fR .rm-old-changes
1218 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
1219 is specified. The default is not to remove.
1221 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
1222 Whether you have push access to the distro.
1223 For Debian, it is OK to use auto, which uses readonly mode if you are
1224 not pushing right now;
1225 but, setting this to false will avoid relying on the mirror of the dgit
1226 git repository server.
1228 .BI dgit-distro. distro .keyid
1232 .BI dgit-distro. distro .mirror " url"
1234 .BI dgit-distro. distro .username
1235 Not relevant for Debian.
1237 .BI dgit-distro. distro .upload-host
1238 Might be useful if you have an intermediate queue server.
1240 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
1241 Values to configure for user.name and user.email in new git trees. If
1242 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
1243 used, respectively. Only used if .setup-usermail is not disabled.
1245 .BI dgit-distro. distro .setup-useremail
1246 Whether to set user.name and user.email in new git trees.
1247 True by default. Ignored for dgit setup-setup-useremail, which does it anyway.
1249 .BI dgit-distro. distro .setup-mergechangelogs
1250 Whether to setup a merge driver which uses dpkg-mergechangelogs for
1251 debian/changelog. True by default. Ignored for dgit
1252 setup-mergechangelogs, which does it anyway.
1254 .BI dgit-distro. distro .setup-gitattributes
1255 Whether to configure .git/info/attributes
1256 to suppress checkin/checkout file content transformations
1258 True by default. Ignored for dgit setup-gitattributes, which does it anyway.
1260 .BI dgit-distro. distro .cmd- cmd
1261 Program to use instead of
1264 .BR -- \fIcmd\fR = "... ."
1266 .BI dgit-distro. distro .opts- cmd
1267 Extra options to pass to
1270 .BR -- \fIcmd\fR : "... ."
1271 To pass several options, configure multiple values in git config
1272 (with git config --add). The options for
1273 .BI dgit.default.opts- cmd
1274 .BI dgit-distro. distro /push.opts- cmd
1275 and are all used, followed by options from dgit's command line.
1276 .SH ACCESS CONFIGURATION
1277 There are many other settings which specify how a particular distro's
1278 services (archive and git) are provided. These should not normally be
1279 adjusted, but are documented for the benefit of distros who wish to
1282 .BI dgit-distro. distro .nominal-distro
1283 Shown in git tags, Dgit fields, and so on.
1285 .BI dgit-distro. distro .alias-canon
1286 Used for all access configuration lookup.
1288 .BR dgit-distro. \fIdistro\fR /push. *
1289 If set, overrides corresponding non \fB/push\fR config when
1290 .BR readonly=false ,
1294 .BI dgit-distro. distro .git-url
1296 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1298 .BI dgit-distro. distro .git-proto
1300 .BI dgit-distro. distro .git-path
1302 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1304 .BI dgit-distro. distro .git-check-suffix
1306 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1308 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1310 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
1312 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1314 .BI dgit-distro. distro .madison-distro
1316 .BI dgit-distro. distro .archive-query-default-component
1318 .BI dgit-distro. distro .dgit-tag-format
1320 .BR dgit-distro. \fIdistro\fR .dep14tag " " want | no | always
1322 .BI dgit-distro. distro .ssh
1324 .BI dgit-distro. distro .sshpsql-dbname
1326 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1328 .BI dgit-distro. distro .backports-quirk
1330 .BI dgit-distro. distro .rewrite-map-enable
1332 .BR dgit-distro. \fIdistro\fR .source-only-uploads " " ok | always | never | not-wholly-new
1334 .BI dgit.default.old-dsc-distro
1336 .BI dgit.dsc-url-proto-ok. protocol
1338 .BI dgit.dsc-url-proto-ok.bad-syntax
1340 .BI dgit.default.dsc-url-proto-ok
1342 .BR dgit.vcs-git.suites " \fIsuite\fR[" ; ...]
1343 .SH ENVIRONMENT VARIABLES
1345 .BR DGIT_SSH ", " GIT_SSH
1346 specify an alternative default program (and perhaps arguments) to use
1347 instead of ssh. DGIT_SSH is consulted first and may contain arguments;
1348 if it contains any whitespace will be passed to the shell. GIT_SSH
1349 specifies just the program; no arguments can be specified, so dgit
1350 interprets it the same way as git does.
1352 also the --ssh= and --ssh: options.
1354 .BR DEBEMAIL ", " DEBFULLNAME
1355 Default git user.email and user.name for new trees. See
1356 .BR "dgit setup-new-tree" .
1358 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1359 and other subprograms and modules used by dgit are affected by various
1360 environment variables. Consult the documentaton for those programs
1364 a `dgit rebase-prep' command or some such to turn a
1365 fast-forwarding branch containing pseudo-merges
1366 back into a rebasing patch stack.
1367 It might have to leave a note
1368 for a future dgit push.
1370 If the dgit push fails halfway through,
1371 it is not necessarily restartable and
1373 It would be good to check that the proposed signing key is
1374 available before starting work.
1376 dgit's build functions, and dgit push, may make changes to
1377 your current HEAD. Sadly this is necessary for packages in the `3.0
1378 (quilt)' source format. This is ultimately due to what I consider
1379 design problems in quilt and dpkg-source.
1381 --dry-run does not always work properly, as not doing some of the git
1382 fetches may result in subsequent actions being different. Doing a
1383 non-dry-run dgit fetch first will help.
1384 --damp-run is likely to work much better.
1391 \fBgit-config\fP(1),
1392 \fBgit-buildpackage\fP(1),
1393 \fBdpkg-buildpackage\fP(1),
1395 https://browse.dgit.debian.org/