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