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
349 Note that only attributes affecting the working tree are suppressed.
350 git-archive may remain exciting.
352 If there is an existing macro attribute line
353 .B [attr]dgit-defuse-attrs
354 in .git/info/attributes,
355 but it is insufficient,
356 because it was made by an earlier version of dgit
357 and git has since introduced new transforming attributes,
358 modifies the macro to disable the newer transformations.
360 (If there is already a macro attribute line
361 .B [attr]dgit-defuse-attrs
362 in .git/info/attributes
363 which does what dgit requires
364 (whatever files it effects),
365 this operation does nothing further.
366 This fact can be used to defeat or partially defeat
367 dgit setup-gitattributes
369 dgit setup-new-tree.)
372 `3.0 (quilt)' format source packages need changes representing not
373 only in-tree but also as patches in debian/patches. dgit quilt-fixup
374 checks whether this has been done; if not, dgit will make appropriate
375 patches in debian/patches and also commit the resulting changes to
378 This is normally done automatically by dgit build and dgit push.
380 dgit will try to turn each relevant commit in your git history into a
381 new quilt patch. dgit cannot convert nontrivial merges, or certain
382 other kinds of more exotic history. If dgit can't find a suitable
383 linearisation of your history, by default it will fail, but you can
384 ask it to generate a single squashed patch instead.
386 When used with a git-debrebase branch,
387 dgit will ask git-debrebase to prepare patches.
389 dgit can make patches in some situations where git-debrebase fails,
390 so dgit quilt-fixup can be useful in its own right.
391 To always use dgit's own patch generator
392 instead of git-debrebase make-patches,
393 pass --git-debrebase=true to dgit.
396 .B FORMAT 3.0 (QUILT)
400 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
401 Import a Debian-format source package,
402 specified by its .dsc,
404 the way dgit fetch would do.
406 This does about half the work of dgit fetch:
407 it will convert the .dsc into a new, orphan git branch.
408 Since dgit has no access to a corresponding source package archive
409 or knowledge of the history
410 it does not consider whether this version is newer
411 than any previous import
412 or corresponding git branches;
413 and it therefore does not
414 make a pseudomerge to bind the import
415 into any existing git history.
417 Because a .dsc can contain a Dgit field naming a git commit
418 (which you might not have),
419 and specifying where to find that commit
420 (and any history rewrite table),
421 import-dsc might need online access.
423 (or dgit's efforts to find the commit fail),
424 consider --no-chase-dsc-distro
425 or --force-import-dsc-with-dgit-field.
427 There is only only sub-option:
429 .B --require-valid-signature
430 causes dgit to insist that the signature on the .dsc is valid
431 (using the same criteria as dpkg-source -x).
432 Otherwise, dgit tries to verify the signature but
433 the outcome is reported only as messages to stderr.
439 then if it already exists, it will be simply ovewritten,
440 no matter its existing contents.
445 then if it already exists
446 and dgit actually imports the dsc
447 (rather than simply reading the git commit out of the Dgit field),
448 dgit will make a pseudomerge
449 so that the result is necessarily fast forward
450 from the existing branch.
451 Otherwise, if branch already exists,
452 dgit will stop with an error message.
456 does not start with refs/, refs/heads/ is prepended.
459 Prints version information and exits.
461 .BI "dgit clone-dgit-repos-server" " destdir"
462 Tries to fetch a copy of the source code for the dgit-repos-server,
463 as actually being used on the dgit git server, as a git tree.
465 .BI "dgit print-dgit-repos-server-source-url"
466 Prints the url used by dgit clone-dgit-repos-server.
467 This is hopefully suitable for use as a git remote url.
468 It may not be useable in a browser.
470 .BI "dgit print-dpkg-source-ignores"
471 Prints the -i and -I arguments which must be passed to dpkg-souce
472 to cause it to exclude exactly the .git diredcory
474 The separate arguments are unquoted, separated by spaces,
475 and do not contain spaces.
477 .B dgit print-unapplied-treeish
478 Constructs a tree-ish approximating the patches-unapplied state
479 of your 3.0 (quilt) package,
480 and prints the git object name to stdout.
481 This requires appropriate .orig tarballs.
482 This tree object is identical to your .origs
483 as regards upstream files.
484 The contents of the debian subdirectory is not interesting
485 and should not be inspected;
486 except that debian/patches will be identical to your HEAD.
488 To make this operate off-line,
489 the access configuration key
490 which is used to determine the build-products-dir
491 is the uncanonicalised version of the suite name from the changelog,
492 or (of course) dgit.default.build-products-dir.
493 See ACCESS CONFIGURATION, below.
495 This function is primarily provided for the benefit of git-debrebase.
498 .BR --dry-run " | " -n
499 Go through the motions, fetching all information needed, but do not
500 actually update the output(s). For push, dgit does
501 the required checks and leaves the new .dsc in a temporary file,
502 but does not sign, tag, push or upload.
504 .BR --damp-run " | " -L
505 Go through many more of the motions: do everything that doesn't
506 involve either signing things, or making changes on the public
512 for signing the tag and the upload. The default comes from the
515 config setting (see CONFIGURATION, below), or failing that, the
516 uploader trailer line in debian/changelog.
519 does not sign tags or uploads (meaningful only with push).
523 Specifies that we should process source package
525 rather than looking in debian/control or debian/changelog.
526 Valid with dgit fetch and dgit pull, only.
528 .BR --clean=git " | " -wg
531 to clean the working tree,
532 rather than running the package's rules clean target.
534 This will delete all files which are not tracked by git.
535 (Including any files you forgot to git add.)
538 options other than dpkg-source
539 are useful when the package's clean target is troublesome, or
540 to avoid needing the build-dependencies.
542 .BR --clean=git-ff " | " -wgf
544 .BR "git clean -xdff"
545 to clean the working tree.
548 but it also removes any subdirectories containing different git
549 trees (which only unusual packages are likely to create).
551 .BR --clean=check " | " -wc
552 Merely check that the tree is clean (does not contain uncommitted
554 Avoids running rules clean,
555 and can avoid needing the build-dependencies.
557 .BR --clean=none " | " -wn
558 Do not clean the tree, nor check that it is clean.
559 Avoids running rules clean,
560 and can avoid needing the build-dependencies.
562 files which are not in git, or if the build creates such files, a
563 subsequent dgit push will fail.
565 .BR --clean=dpkg-source " | " -wd
566 Use dpkg-buildpackage to do the clean, so that the source package
567 is cleaned by dpkg-source running the package's clean target.
569 Requires the package's build dependencies.
571 .BR --clean=dpkg-source-d " | " -wdd
573 .B dpkg-buildpackage -d
575 so that the source package
576 is cleaned by dpkg-source running the package's clean target.
577 The build-dependencies are not checked (due to
579 which violates policy, but may work in practice.
582 The package is or may be new in this suite. Without this, dgit will
583 refuse to push. It may (for Debian, will) be unable to access the git
584 history for any packages which have been newly pushed and have not yet
588 Do not complain if the working tree does not match your git HEAD,
590 include the changes from your working tree.
591 This can be useful with build, if you plan to commit later. (dgit
592 push will still ensure that the .dsc you upload and the git tree
593 you push are identical, so this option won't make broken pushes.)
596 Deprecated alias for --include-dirty.
598 .BR --overwrite [=\fIprevious-version\fR]
599 Declare that your HEAD really does contain
600 all the (wanted) changes
601 from all versions listed in its changelog;
602 or, all (wanted) changes from
603 .IR previous-version .
604 This promise is needed when
605 your git branch is not a descendant
606 of the version in the archive
607 according to the git revision history.
609 It is safer not to specify
610 .IR previous-version ,
611 and usually it's not needed.
614 unless you know what you are doing.
616 This option is useful if you are the maintainer, and you have
617 incorporated NMU changes into your own git workflow in a way that
618 doesn't make your branch a fast forward from the NMU.
620 This option is also usually necessary
621 the first time a package is pushed with dgit push
622 to a particular suite.
624 .BR dgit-maint- \fI*\fR (7) .
629 specified, dgit will check that the version in the archive is
630 mentioned in your debian/changelog.
631 (This will avoid losing
634 unless someone committed to git a finalised changelog
635 entry, and then made later changes to that version.)
638 is specified, it ought to be the version currently in the archive.
640 dgit push --overwrite
641 will, if necessary, make a
642 pseudo-merge (that is, something that looks like the result
643 of git merge -s ours) to stitch the archive's version into your own
644 git history, so that your push is a fast forward from the archive.
647 .BR gbp ", " dpm " or " unpatched ,
648 implying a split between the dgit view and the
649 maintainer view, the pseudo-merge will appear only in the dgit view.)
651 .BR --delayed =\fIdays\fR
652 Upload to a DELAYED queue.
655 If the maintainer responds by cancelling
656 your upload from the queue,
657 and does not make an upload of their own,
658 this will not rewind the git branch on the dgit git server.
659 Other dgit users will then see your push
660 (with a warning message from dgit)
661 even though the maintainer wanted to abolish it.
662 Such users might unwittingly reintroduce your changes.
664 If this situation arises,
665 someone should make a suitable dgit push
666 to update the contents of dgit-repos
667 to a version without the controversial changes.
669 .BR --no-chase-dsc-distro
670 Tells dgit not to look online
671 for additional git repositories
672 containing information about a particular .dsc being imported.
673 Chasing is the default.
676 (such as fetch and pull),
678 means dgit will access only the git server
679 for the distro you are directly working with,
680 even if the .dsc was copied verbatim from another distro.
683 means dgit will work completely offline.
685 Disabling chasing can be hazardous:
686 if the .dsc names a git commit which has been rewritten
687 by those in charge of the distro,
688 this option may prevent that rewrite from being effective.
691 dgit fails to find necessary git commits.
693 .BR --save-dgit-view= \fIbranch\fR|\fIref\fR
694 Specifies that when a split view quilt mode is in operation,
696 (or looks up in its cache)
697 a dgit view corresponding to your HEAD,
698 the dgit view will be left in
700 The specified ref is unconditionally overwritten,
701 so don't specify a branch you want to keep.
703 This option is effective only with the following operations:
704 quilt-fixup; push; all builds.
705 And it is only effective with
710 If ref does not start with refs/
711 it is taken to to be a branch -
712 i.e. refs/heads/ is prepended.
715 is a deprecated alias for
718 .BI --deliberately- something
719 Declare that you are deliberately doing
721 This can be used to override safety catches, including safety catches
722 which relate to distro-specific policies.
723 The use of --deliberately is declared and published in the signed tags
724 generated for you by dgit,
725 so that the archive software can give effect to your intent,
727 for the benefit humans looking at the history.
730 understood in the context of Debian are discussed below:
732 .BR --deliberately-not-fast-forward
733 Declare that you are deliberately rewinding history. When pushing to
734 Debian, use this when you are making a renewed upload of an entirely
735 new source package whose previous version was not accepted for release
736 from NEW because of problems with copyright or redistributibility.
738 In split view quilt modes,
739 this also prevents the construction by dgit of a pseudomerge
740 to make the dgit view fast forwarding.
742 --overwrite (which creates a suitable pseudomerge)
744 --deliberately-not-fast-forward
745 (which suppresses the pseudomerge and the fast forward checks)
747 --overwrite is usually better.
749 .BR --deliberately-include-questionable-history
750 Declare that you are deliberately including, in the git history of
751 your current push, history which contains a previously-submitted
752 version of this package which was not approved (or has not yet been
753 approved) by the ftpmasters. When pushing to Debian, only use this
754 option after verifying that: none of the rejected-from-NEW (or
755 never-accepted) versions in the git history of your current push, were
756 rejected by ftpmaster for copyright or redistributability reasons.
758 .BR --deliberately-fresh-repo
759 Declare that you are deliberately rewinding history and want to
760 throw away the existing repo. Not relevant when pushing to Debian,
761 as the Debian server will do this automatically when necessary.
764 When fixing up source format `3.0 (quilt)' metadata, insist on
765 generating a linear patch stack: one new patch for each relevant
767 If such a stack cannot be generated, fail.
768 This is the default for Debian.
770 HEAD should be a series of plain commits
771 (not touching debian/patches/),
773 with as ancestor a patches-applied branch.
776 When fixing up source format `3.0 (quilt)' metadata, prefer to
777 generate a linear patch stack
778 (as with --quilt=auto)
779 but if that doesn't seem possible,
780 try to generate a single squashed patch for all the changes made in git
781 (as with --quilt=smash).
782 This is not a good idea for an NMU in Debian.
785 When fixing up source format `3.0 (quilt)' metadata,
786 generate a single additional patch for all the changes made in git.
787 This is not a good idea for an NMU in Debian.
789 (If HEAD has any in-tree patches already, they must apply cleanly.
790 This will be the case for any trees produced by dgit fetch or clone;
791 if you do not change the upstream version
792 nor make changes in debian/patches,
793 it will remain true.)
796 Check whether source format `3.0 (quilt)' metadata would need fixing
797 up, but, if it does, fail. You must then fix the metadata yourself
798 somehow before pushing. (NB that dpkg-source --commit will not work
799 because the dgit git tree does not have a
803 .BR --quilt=nocheck " | " --no-quilt-fixup
804 Do not check whether up source format `3.0 (quilt)' metadata needs
805 fixing up. If you use this option and the metadata did in fact need
806 fixing up, dgit push will fail.
808 .BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
809 Tell dgit that you are using a nearly-dgit-compatible git branch,
811 .BR "maintainer view" ,
813 do not want your branch changed by dgit.
818 is for use with git-buildpackage.
819 Your HEAD is expected to be
820 a patches-unapplied git branch, except that it might contain changes
821 to upstream .gitignore files. This is the default for dgit gbp-build.
826 is for use with git-dpm.
827 Your HEAD is expected to be
828 a patches-applied git branch,
829 except that it might contain changes to upstream .gitignore files.
832 specifies that your HEAD is a patches-unapplied git branch (and
833 that any changes to upstream .gitignore files are represented as
834 patches in debian/patches).
836 With --quilt=gbp|dpm|unapplied,
837 dgit push (or precursors like quilt-fixup and build) will automatically
838 generate a conversion of your git branch into the right form.
839 dgit push will push the
840 dgit-compatible form (the
842 to the dgit git server.
843 The dgit view will be visible to you
844 in the dgit remote tracking branches, but your own branch will
846 dgit push will create a tag
848 for the maintainer view, and the dgit tag
849 .BI archive/debian/ version
851 dgit quilt-fixup will merely do some checks,
852 and cache the maintainer view.
854 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
855 This is because it is not always possible to tell: a patches-unapplied
856 git branch of a package with one patch, for example, looks very like
857 a patches-applied branch where the user has used git revert to
858 undo the patch, expecting to actually revert it.
859 However, if you fail to specify the right \-\-quilt option,
860 and you aren't too lucky, dgit will notice the problem and stop,
863 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
864 Specifies that the suite to be operated on is part of distro
866 This overrides the default value found from the git config option
867 .BR dgit-suite. \fIsuite\fR .distro .
868 The only effect is that other configuration variables (used
869 for accessing the archive and dgit-repos) used are
870 .BR dgit-distro. \fIdistro\fR .* .
872 If your suite is part of a distro that dgit already knows about, you
873 can use this option to make dgit work even if your dgit doesn't know
874 about the suite. For example, specifying
876 will work when the suite is an unknown suite in the Debian archive.
878 To define a new distro it is necessary to define methods and URLs
879 for fetching (and, for dgit push, altering) a variety of information both
880 in the archive and in dgit-repos.
881 How to set this up is not yet documented.
884 Specifies the .changes file which is to be uploaded. By default
885 dgit push looks for single .changes file in the parent directory whose
886 filename suggests it is for the right package and version.
890 pathname contains slashes, the directory part is also used as
892 .BR --build-products-dir ;
893 otherwise, the changes file is expected in that directory (by
898 When doing a build, delete any changes files matching
899 .IB package _ version _*.changes
900 before starting. This ensures that
901 dgit push (and dgit sbuild) will be able to unambigously
902 identify the relevant changes files from the most recent build, even
903 if there have been previous builds with different tools or options.
904 The default is not to remove, but
905 .B \-\-no-rm-old-changes
906 can be used to override a previous \-\-rm-old-changes
907 or the .rm-old-changes configuration setting.
909 Note that \fBdgit push-source\fR will always find the right .changes,
910 regardless of this option.
912 .BI --build-products-dir= directory
913 Specifies where to find and create tarballs, binry packages,
914 source packages, .changes files, and so on.
916 By default, dgit uses the parent directory
919 Changing this setting may necessitate
920 moving .orig tarballs to the new directory,
921 so it is probably best to
923 .BI dgit.default.build-products-dir
924 configuration setting
925 (see CONFIGURATION, below)
926 which this command line option overrides).
929 Do not delete the destination directory if clone fails.
932 Generates a DEP-14 tag (eg
933 .BR debian/ \fIversion\fR)
934 as well as a dgit tag (eg
935 .BR archive/debian/ \fIversion\fR)
936 where possible. This is the default.
939 Do not generate a DEP-14 tag, except in split quilt view mode.
940 (On servers where only the old tag format is supported,
941 the dgit tag will have the DEP-14 name.
942 This option does not prevent that.)
944 .BI --dep14tag-always
945 Insist on generating a DEP-14 tag
946 as well as a dgit tag.
947 If the server does not support that, dgit push will fail.
950 Prints debugging information to stderr. Repeating the option produces
951 more output (currently, up to -DDDD is meaningfully different).
954 Specifies a git configuration option, to be used for this run.
955 dgit itself is also controlled by git configuration options.
957 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
960 option to pass to dpkg-genchanges, during builds. Changes (from
961 debian/changelog) since this version will be included in the built
962 changes file, and hence in the upload. If this option is not
963 specified, dgit will query the archive and use the latest version
964 uploaded to the intended suite.
968 inhibits this, so that no -v option will be passed to dpkg-genchanges
969 (and as a result, only the last stanza from debian/changelog will
970 be used for the build and upload).
972 .RI \fB-m\fR maintaineraddress
973 Passed to dpkg-genchanges (eventually).
975 .RI \fB--ch:\fR option
976 Specifies a single additional option to pass, eventually, to
979 Options which are safe to pass include
983 although these should never be necessary with Debian since dgit
984 automatically calculates whether .origs need to be uploaded.)
986 For other options the caveat below applies.
988 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
989 Specifies a single additional option to pass to
994 .BR dpkg-buildpackage ,
995 .BR dpkg-genchanges ,
1008 Can be repeated as necessary.
1010 Use of this ability should not normally be necessary.
1011 It is provided for working around bugs,
1012 or other unusual situations.
1013 If you use these options,
1014 you may violate dgit's assumptions
1015 about the behaviour of its subprograms
1018 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
1019 the option applies only when the program is invoked directly by dgit.
1020 Usually, for passing options to dpkg-genchanges, you should use
1021 .BR --ch: \fIoption\fR.
1023 Specifying --git is not effective for some lower-level read-only git
1024 operations performed by dgit, and also not when git is invoked by
1025 another program run by dgit.
1027 See notes below regarding ssh and dgit.
1029 NB that --gpg:option is not supported (because debsign does not
1030 have that facility).
1035 distro config setting.
1037 .RI \fB--curl=\fR program " | \fB--dput=\fR" program " |..."
1038 Specifies alternative programs to use instead of
1043 .BR dpkg-buildpackage ,
1044 .BR dpkg-genchanges ,
1061 .BR dpkg-buildpackage ,
1062 .BR dpkg-genchanges ,
1066 this applies only when the program is invoked directly by dgit.
1070 specifies the command to run on the remote host when dgit
1071 rpush needs to invoke a remote copy of itself. (dgit also reinvokes
1072 itself as the EDITOR for dpkg-source --commit; this is done using
1073 argv[0], and is not affected by --dgit=).
1077 is used instead of gbp build or git-buildpackage. (The default is
1078 the latter unless the former exists on PATH.)
1081 is used instead of gbp pq.
1083 unusually, the specified value is split on whitespace
1084 to produce a command and possibly some options and/or arguments.
1086 For pbuilder and cowbuilder, the defaults are
1087 .BR "sudo -E pbuilder"
1089 .BR "sudo -E cowbuilder"
1091 Like with gbp-build and gbp pq,
1092 the specified value is split on whitespace.
1096 the default value is taken from the
1100 environment variables, if set (see below). And, for ssh, when accessing the
1101 archive and dgit-repos, this command line setting is overridden by the
1102 git config variables
1103 .BI dgit-distro. distro .ssh
1105 .B .dgit.default.ssh
1106 (which can in turn be overridden with -c). Also, when dgit is using
1107 git to access dgit-repos, only git's idea of what ssh to use (eg,
1111 .BI --existing-package= package
1112 dgit push needs to canonicalise the suite name. Sometimes, dgit
1113 lacks a way to ask the archive to do this without knowing the
1114 name of an existing package. Without --new we can just use the
1115 package we are trying to push. But with --new that will not work, so
1118 or use the value of this option. This option is not needed with the
1119 default mechanisms for accessing the archive.
1122 Print a usage summary.
1124 .BI --initiator-tempdir= directory
1125 dgit rpush uses a temporary directory on the invoking (signing) host.
1126 This option causes dgit to use
1128 instead. Furthermore, the specified directory will be emptied,
1129 removed and recreated before dgit starts, rather than removed
1130 after dgit finishes. The directory specified must be an absolute
1133 .BI --force- something
1134 Instructs dgit to try to proceed despite detecting
1135 what it thinks is going to be a fatal problem.
1136 .B This is probably not going to work.
1137 These options are provided as an escape hatch,
1138 in case dgit is confused.
1139 (They might also be useful for testing error cases.)
1141 .B --force-import-dsc-with-dgit-field
1142 Tell dgit import-dsc to treat a .dsc with a Dgit field
1143 like one without it.
1144 The result is a fresh import,
1145 discarding the git history
1146 that the person who pushed that .dsc was working with.
1148 .B --force-uploading-binaries
1151 even though dgit thinks your distro does not permit that.
1153 .B --force-uploading-source-only
1154 Carry on and do a source-only upload,
1155 without any binaries,
1156 even though dgit thinks your distro does not permit that,
1157 or does not permit that in this situation.
1159 .B --force-unrepresentable
1161 dgit thinks that your git tree contains changes
1162 (relative to your .orig tarballs)
1163 which dpkg-source is not able to represent.
1164 Your build or push will probably fail later.
1166 .B --force-changes-origs-exactly
1167 Use the set of .origs specified in your .changes, exactly,
1168 without regard to what is in the archive already.
1169 The archive may well reject your upload.
1171 .B --force-unsupported-source-format
1172 Carry on despite dgit not understanding your source package format.
1173 dgit will probably mishandle it.
1175 .B --force-dsc-changes-mismatch
1176 Do not check whether .dsc and .changes match.
1177 The archive will probably reject your upload.
1179 .BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd
1180 Force on or off the use of the absurd git-apply emulation
1181 when running gbp pq import
1182 when importing a package from a .dsc.
1183 See Debian bug #841867.
1185 dgit can be configured via the git config system.
1186 You may set keys with git-config (either in system-global or per-tree
1187 configuration), or provide
1189 on the dgit command line.
1191 Settings likely to be useful for an end user include:
1193 .BI dgit.default.build-products-dir
1194 Specifies where to find the built files to be uploaded,
1195 when --build-products-dir is not specified. The default is
1196 the parent directory
1199 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
1200 Specifies the distro for a suite. dgit keys off the suite name (which
1201 appears in changelogs etc.), and uses that to determine the distro
1202 which is involved. The config used is thereafter that for the distro.
1205 may be a glob pattern.
1207 .BI dgit.default.distro " distro"
1208 The default distro for an unknown suite.
1210 .BI dgit.default.default-suite " suite"
1211 The default suite (eg for clone).
1215 .BR dgit-distro. \fIdistro\fR . *,
1216 the default value used if there is no distro-specific setting.
1218 .BR dgit-distro. \fIdistro\fR .clean-mode
1219 One of the values for the command line --clean= option; used if
1220 --clean is not specified.
1222 .BR dgit-distro. \fIdistro\fR .quilt-mode
1223 One of the values for the command line --quilt= option; used if
1224 --quilt is not specified.
1226 .BR dgit-distro. \fIdistro\fR .rm-old-changes
1227 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
1228 is specified. The default is not to remove.
1230 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
1231 Whether you have push access to the distro.
1232 For Debian, it is OK to use auto, which uses readonly mode if you are
1233 not pushing right now;
1234 but, setting this to false will avoid relying on the mirror of the dgit
1235 git repository server.
1237 .BI dgit-distro. distro .keyid
1241 .BI dgit-distro. distro .mirror " url"
1243 .BI dgit-distro. distro .username
1244 Not relevant for Debian.
1246 .BI dgit-distro. distro .upload-host
1247 Might be useful if you have an intermediate queue server.
1249 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
1250 Values to configure for user.name and user.email in new git trees. If
1251 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
1252 used, respectively. Only used if .setup-usermail is not disabled.
1254 .BI dgit-distro. distro .setup-useremail
1255 Whether to set user.name and user.email in new git trees.
1256 True by default. Ignored for dgit setup-setup-useremail, which does it anyway.
1258 .BI dgit-distro. distro .setup-mergechangelogs
1259 Whether to setup a merge driver which uses dpkg-mergechangelogs for
1260 debian/changelog. True by default. Ignored for dgit
1261 setup-mergechangelogs, which does it anyway.
1263 .BI dgit-distro. distro .setup-gitattributes
1264 Whether to configure .git/info/attributes
1265 to suppress checkin/checkout file content transformations
1267 True by default. Ignored for dgit setup-gitattributes, which does it anyway.
1269 .BI dgit-distro. distro .cmd- cmd
1270 Program to use instead of
1273 .BR -- \fIcmd\fR = "... ."
1275 .BI dgit-distro. distro .opts- cmd
1276 Extra options to pass to
1279 .BR -- \fIcmd\fR : "... ."
1280 To pass several options, configure multiple values in git config
1281 (with git config --add). The options for
1282 .BI dgit.default.opts- cmd
1283 .BI dgit-distro. distro /push.opts- cmd
1284 and are all used, followed by options from dgit's command line.
1285 .SH ACCESS CONFIGURATION
1286 There are many other settings which specify how a particular distro's
1287 services (archive and git) are provided. These should not normally be
1288 adjusted, but are documented for the benefit of distros who wish to
1291 .BI dgit-distro. distro .nominal-distro
1292 Shown in git tags, Dgit fields, and so on.
1294 .BI dgit-distro. distro .alias-canon
1295 Used for all access configuration lookup.
1297 .BR dgit-distro. \fIdistro\fR /push. *
1298 If set, overrides corresponding non \fB/push\fR config when
1299 .BR readonly=false ,
1303 .BI dgit-distro. distro .git-url
1305 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
1307 .BI dgit-distro. distro .git-proto
1309 .BI dgit-distro. distro .git-path
1311 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
1313 .BI dgit-distro. distro .git-check-suffix
1315 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
1317 .BI dgit-distro. distro .git-create " " ssh-cmd | true
1319 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
1321 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
1323 .BI dgit-distro. distro .madison-distro
1325 .BI dgit-distro. distro .archive-query-default-component
1327 .BI dgit-distro. distro .dgit-tag-format
1329 .BR dgit-distro. \fIdistro\fR .dep14tag " " want | no | always
1331 .BI dgit-distro. distro .ssh
1333 .BI dgit-distro. distro .sshpsql-dbname
1335 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
1337 .BI dgit-distro. distro .backports-quirk
1339 .BI dgit-distro. distro .rewrite-map-enable
1341 .BR dgit-distro. \fIdistro\fR .source-only-uploads " " ok | always | never | not-wholly-new
1343 .BI dgit.default.old-dsc-distro
1345 .BI dgit.dsc-url-proto-ok. protocol
1347 .BI dgit.dsc-url-proto-ok.bad-syntax
1349 .BI dgit.default.dsc-url-proto-ok
1351 .BR dgit.vcs-git.suites " \fIsuite\fR[" ; ...]
1352 .SH ENVIRONMENT VARIABLES
1354 .BR DGIT_SSH ", " GIT_SSH
1355 specify an alternative default program (and perhaps arguments) to use
1356 instead of ssh. DGIT_SSH is consulted first and may contain arguments;
1357 if it contains any whitespace will be passed to the shell. GIT_SSH
1358 specifies just the program; no arguments can be specified, so dgit
1359 interprets it the same way as git does.
1361 also the --ssh= and --ssh: options.
1363 .BR DEBEMAIL ", " DEBFULLNAME
1364 Default git user.email and user.name for new trees. See
1365 .BR "dgit setup-new-tree" .
1367 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
1368 and other subprograms and modules used by dgit are affected by various
1369 environment variables. Consult the documentaton for those programs
1373 a `dgit rebase-prep' command or some such to turn a
1374 fast-forwarding branch containing pseudo-merges
1375 back into a rebasing patch stack.
1376 It might have to leave a note
1377 for a future dgit push.
1379 If the dgit push fails halfway through,
1380 it is not necessarily restartable and
1382 It would be good to check that the proposed signing key is
1383 available before starting work.
1385 dgit's build functions, and dgit push, may make changes to
1386 your current HEAD. Sadly this is necessary for packages in the `3.0
1387 (quilt)' source format. This is ultimately due to what I consider
1388 design problems in quilt and dpkg-source.
1390 --dry-run does not always work properly, as not doing some of the git
1391 fetches may result in subsequent actions being different. Doing a
1392 non-dry-run dgit fetch first will help.
1393 --damp-run is likely to work much better.
1400 \fBgit-config\fP(1),
1401 \fBgit-buildpackage\fP(1),
1402 \fBdpkg-buildpackage\fP(1),
1404 https://browse.dgit.debian.org/